FHIR InsurancePlan

Name:

address

optional

Type:

query

Data Type:

array

Description:

Filters the InsurancePlan resources to those with an associated contact address matching the specified value(s), as identified by InsurancePlan.contact.address.

Note: Supports passing in a comma-separated list of values.

Sample Value: Grafton Road, Lincoln Road

Name:

address-city

optional

Type:

query

Data Type:

array

Description:

Filters the InsurancePlan resources to those with an associated contact address in the specified city, as identified by InsurancePlan.contact.address.city.

Note: Supports passing in a comma-separated list of values.

Sample Value: Sydney

Name:

address-country

optional

Type:

query

Data Type:

array

Description:

Filters the InsurancePlan resources to those with an associated contact address in the specified country, as identified by InsurancePlan.contact.address.country.

Note: Supports passing in a comma-separated list of values.

Sample Value: United States, Canada, New Zealand

Name:

address-postalcode

optional

Type:

query

Data Type:

array

Description:

Filters the InsurancePlan resources to those with an associated contact address in the specified postcode, as identified by InsurancePlan.contact.address.postalcode.

Note: Supports passing in a comma-separated list of values.

Sample Value: 10004, 10020

Name:

address-state

optional

Type:

query

Data Type:

array

Description:

Filters the InsurancePlan resources to those with an associated contact address in the specified state, as identified by InsurancePlan.contact.address.state.

Note: Supports passing in a comma-separated list of values.

Sample Value: California,Ohio,Georgia

Name:

address-use

optional

Type:

query

Data Type:

array

Description:

Filters the InsurancePlans to those that match the specified address-use, identified by InsurancePlan.contact.address.use. Possible values are:

• home
• work
• temp
• old

• billing

  Note:

  • if an address use system is specified, only http://hl7.org/fhir/address-use can be used.
  • Supports passing in a comma-separated list of values.

Sample Value: home,work

Name:

administered-by

optional

Type:

query

Data Type:

array

Description:

Filters InsurancePlans based on the organization that administers services on behalf of the health insurance product owner, identified by the InsurancePlan.administeredBy reference.

Note: administered-by can be chained to define filters on the reference. Each chained parameter can specify multiple comma-separated values.

Sample Value: - "administered-by=Organization/managing-org/1" - "administered-by.type=http://terminology.hl7.org/CodeSystem/organization-type|prov"

Name:

coverage-area

optional

Type:

query

Data Type:

array

Description:

Filters InsurancePlans based on the location where a health insurance product's benefits apply, identified by the InsurancePlan.coverageArea reference. Note: coverage-area can be chained to define filters on the reference. Each chained parameter can specify multiple comma-separated values.

Sample Value: - "coverage-area.identifier=SYS_A|L1"

Name:

plan-type

optional

Type:

query

Data Type:

array

Description:

Filters InsurancePlans based on the plan type of the insurance plan, identified by InsurancePlan.plan.type. For each specified plan-type, the system and code are separated using a URL-encoded | character i.e. %7c.

Note: Supports passing a comma-separated list of values.

Sample Value: sysA-plan-type|platinum, sysA-plan-type|deductible

Name:

endpoint

optional

Type:

query

Data Type:

array

Description:

Filters InsurancePlans based on the endpoints providng access to services operated for the health insurance product, identified by InsurancePlan.endpoint reference.

Note: endpoint can be chained to define filters on the reference. Each chained parameter can specify multiple comma-separated values.

Sample Value: endpoint.status=active & endpoint.connection-type=http://terminology.hl7.org/CodeSystem/endpoint-connection-type|ihe-xcpd

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters InsurancePlans based on the unique identifier, identified by InsurancePlan.identifier. For each specified identifier, the system and code are separated using a URL-encoded | character i.e. %7c.

Note: Supports passing a comma-separated list of values.

Sample Value: identifier=SYS_A|L1,SYS_B|LB12

Name:

name

optional

Type:

query

Data Type:

array

Description:

Filters InsurancePlans based on the name or alias of the health insurance product, identified by InsurancePlan.name or InsurancePlan.alias.

Note: Supports passing a comma-separated list of values.

Sample Value: Health Wellbeing I, Health Wellbeing II

Name:

owned-by

optional

Type:

query

Data Type:

array

Description:

Filters InsurancePlans based on the organization that provies the health insurance product and underwriting the risk, identified by the InsurancePlan.ownedBy reference.

Note: owned-by can be chained to define filters on the reference. Each chained parameter can specify multiple comma-separated values.

Sample Value: owned-by.type=http://terminology.hl7.org/CodeSystem/organization-type|prov,http://terminology.hl7.org/CodeSystem/organization-type|dept

Name:

phonetic

optional

Type:

query

Data Type:

array

Description:

Filters InsurancePlans based on a portion of the InsurancePlan name using some phonetic matching algorithm, identified by InsurancePlan.name.

Note: Supports passing a comma-separated list of values.

Sample Value: phonetic=iso21090-EN-phonetic

Name:

status

optional

Type:

query

Data Type:

array

Description:

Filters InsurancePlans based on the current state of the health insurance product, identified by the InsurancePlan.status.

Possible values are:

• draft
• active
• retired

• unknown

  Note:

  • If a status system is specified, only http://hl7.org/fhir/publication-status can be used.
  • Supports passing a comma-separated list of values.

Sample Value: draft,unknown

Name:

type

optional

Type:

query

Data Type:

array

Description:

Filters InsurancePlans based on the code that classifies the type of health insurance product, identified by InsurancePlan.type. For each specified facility type, the system and code are separated using a URL-encoded | character i.e. %7c.

Note: Supports passing a comma-separated list of values.

Sample Value: http://terminology.hl7.org/CodeSystem/insurance-plan-type|medical, http://terminology.hl7.org/CodeSystem/insurance-plan-type|mental

Name:

period

optional

Type:

query

Data Type:

array

Description:

Filters the InsurancePlans by the period of time the health insurance product is available on, before, or after a specific date, date-time, or date range.

The supported prefixes are gt (greater than), ge (greater than or equal to), lt (less than), le (less than or equal to), and eq (equal to). If no prefix is used, exact date or date-time matching is implied.

Dates must be formatted according to ISO 8601, either as a date only (e.g., 1997-07-16) or as a date-time including the timezone (e.g., 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL-encoded (i.e., %2B).

The format of the query is

• period=gt{dateTimeValue}
• period=ge{dateTimeValue}&period=le{dateTimeValue}

Sample Value: period=gt2012-01-01&period=lt2022-01-01

Name:

_lastUpdated

optional

Type:

query

Data Type:

array

Description:

Allows the user to filter InsurancePlans by the lastUpdated date. The date value can be a single date, as well as lower and/or upper bound.

The supported operations are: =gt, =ge, =lt, =ne, =le, =eq. For more information about using these search operators, refer to the date section on the FHIR Search page.

The {dateTimeValue} value should be in the following format: 2013-01-01T23:00:00-05:00. However, the time portion can be excluded. If a time portion is provided, the time zone must be provided as well.

It is highly recommended to provide the time zone portion in any query. Ensure that special characters such as '+' are encoded so that it can be interpreted correctly. For example: "2014-01-01T00:00:00+13:00" should be encoded like this: "2014-01-01T00:00:00%2B13:00".

If a date query comes in without a time zone, the date will be interpreted according to the server's time zone.

Including this query parameter includes all InsurancePlans that match the specified InsurancePlan.Meta.lastUpdated.

Sample Value: _lastUpdated=gt2012-01-01&_lastUpdated=lt2022-01-01

Name:

_summary

optional

Type:

query

Data Type:

string

Description:

Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are

• true: return summaries only
• false: return full resources
• count: return the count of search matches
• text: return only the text, id, meta, and top-level mandatory elements
• data: remove the text element

Sample Value: true

Name:

-include-sources

optional

Type:

query

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameters can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.

Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%InsurancePlans

Name:

-exclude-sources

optional

Type:

query

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.

Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%InsurancePlans

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=type,name,status,_elements:exclude=*.by

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.

Default Value: xml

Sample Value: json

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

-cursor

optional

Type:

query

Data Type:

string

Description:

This is a server internal parameter to navigate different pages, indicating the server a cursor till where result matches were already returned.

This parameter is returned by the server as part of the next link of a paginated query.

Name:

_count

optional

Type:

query

Data Type:

integer

Description:

Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.

The returned bundle may contain a next link if more results could be available.

Sample Value: 100

Name:

_sort

optional

Type:

query

Data Type:

string

Description:

Request which order results should be returned in.

Supported _sort parameters are:

• period to sort by InsurancePlan.period.start ascending.
• -period to sort by InsurancePlan.period.start descending.
• name to sort by InsurancePlan.name in ascending alphabetical order.
• -name to sort by InsurancePlan.name in descending alphabetical order.
• _lastUpdated to sort by InsurancePlan.meta.lastUpdated ascending.
• -_lastUpdated to sort by InsurancePlan.meta.lastUpdated descending.

You can use any combination of the parameters.

Default Value: -period

Sample Value: -name,-_lastUpdated

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

Sample Value: application/json

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)

Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The CSRF-Token from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

Content-Type

required

Type:

header

Data Type:

string

Description:

Specifies how to encode the form data. The Content-Type value must be application/x-www-form-urlencoded

Sample Value: application/x-www-form-urlencoded

Name:

address

optional

Type:

formData

Data Type:

array

Description:

Filters the InsurancePlan resources to those with an associated contact address matching the specified value(s), as identified by InsurancePlan.contact.address.

Note: Supports passing in a comma-separated list of values.

Sample Value: Grafton Road, Lincoln Road

Name:

address-city

optional

Type:

formData

Data Type:

array

Description:

Filters the InsurancePlan resources to those with an associated contact address in the specified city, as identified by InsurancePlan.contact.address.city.

Note: Supports passing in a comma-separated list of values.

Sample Value: Sydney

Name:

address-country

optional

Type:

formData

Data Type:

array

Description:

Filters the InsurancePlan resources to those with an associated contact address in the specified country, as identified by InsurancePlan.contact.address.country.

Note: Supports passing in a comma-separated list of values.

Sample Value: United States, Canada, New Zealand

Name:

address-postalcode

optional

Type:

formData

Data Type:

array

Description:

Filters the InsurancePlan resources to those with an associated contact address in the specified postcode, as identified by InsurancePlan.contact.address.postalcode.

Note: Supports passing in a comma-separated list of values.

Sample Value: 10004, 10020

Name:

address-state

optional

Type:

formData

Data Type:

array

Description:

Filters the InsurancePlan resources to those with an associated contact address in the specified state, as identified by InsurancePlan.contact.address.state.

Note: Supports passing in a comma-separated list of values.

Sample Value: California,Ohio,Georgia

Name:

address-use

optional

Type:

formData

Data Type:

array

Description:

Filters the InsurancePlans to those that match the specified address-use, identified by InsurancePlan.contact.address.use. Possible values are:

• home
• work
• temp
• old

• billing

  Note:

  • if an address use system is specified, only http://hl7.org/fhir/address-use can be used.
  • Supports passing in a comma-separated list of values.

Sample Value: home,work

Name:

administered-by

optional

Type:

formData

Data Type:

array

Description:

Filters InsurancePlans based on the organization that administers services on behalf of the health insurance product owner, identified by the InsurancePlan.administeredBy reference.

Note: administered-by can be chained to define filters on the reference. Each chained parameter can specify multiple comma-separated values.

Sample Value: - "administered-by=Organization/managing-org/1" - "administered-by.type=http://terminology.hl7.org/CodeSystem/organization-type|prov"

Name:

coverage-area

optional

Type:

formData

Data Type:

array

Description:

Filters InsurancePlans based on the location where a health insurance product's benefits apply, identified by the InsurancePlan.coverageArea reference. Note: coverage-area can be chained to define filters on the reference. Each chained parameter can specify multiple comma-separated values.

Sample Value: - "coverage-area.identifier=SYS_A|L1"

Name:

plan-type

optional

Type:

formData

Data Type:

array

Description:

Filters InsurancePlans based on the plan type of the insurance plan, identified by InsurancePlan.plan.type. For each specified plan-type, the system and code are separated using a URL-encoded | character i.e. %7c.

Note: Supports passing a comma-separated list of values.

Sample Value: sysA-plan-type|platinum, sysA-plan-type|deductible

Name:

endpoint

optional

Type:

formData

Data Type:

array

Description:

Filters InsurancePlans based on the endpoints providng access to services operated for the health insurance product, identified by InsurancePlan.endpoint reference.

Note: endpoint can be chained to define filters on the reference. Each chained parameter can specify multiple comma-separated values.

Sample Value: endpoint.status=active & endpoint.connection-type=http://terminology.hl7.org/CodeSystem/endpoint-connection-type|ihe-xcpd

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters InsurancePlans based on the unique identifier, identified by InsurancePlan.identifier. For each specified identifier, the system and code are separated using a URL-encoded | character i.e. %7c.

Note: Supports passing a comma-separated list of values.

Sample Value: identifier=SYS_A|L1,SYS_B|LB12

Name:

name

optional

Type:

formData

Data Type:

array

Description:

Filters InsurancePlans based on the name or alias of the health insurance product, identified by InsurancePlan.name or InsurancePlan.alias.

Note: Supports passing a comma-separated list of values.

Sample Value: Health Wellbeing I, Health Wellbeing II

Name:

owned-by

optional

Type:

formData

Data Type:

array

Description:

Filters InsurancePlans based on the organization that provies the health insurance product and underwriting the risk, identified by the InsurancePlan.ownedBy reference.

Note: owned-by can be chained to define filters on the reference. Each chained parameter can specify multiple comma-separated values.

Sample Value: owned-by.type=http://terminology.hl7.org/CodeSystem/organization-type|prov,http://terminology.hl7.org/CodeSystem/organization-type|dept

Name:

phonetic

optional

Type:

formData

Data Type:

array

Description:

Filters InsurancePlans based on a portion of the InsurancePlan name using some phonetic matching algorithm, identified by InsurancePlan.name.

Note: Supports passing a comma-separated list of values.

Sample Value: phonetic=iso21090-EN-phonetic

Name:

status

optional

Type:

formData

Data Type:

array

Description:

Filters InsurancePlans based on the current state of the health insurance product, identified by the InsurancePlan.status.

Possible values are:

• draft
• active
• retired

• unknown

  Note:

  • If a status system is specified, only http://hl7.org/fhir/publication-status can be used.
  • Supports passing a comma-separated list of values.

Sample Value: draft,unknown

Name:

type

optional

Type:

formData

Data Type:

array

Description:

Filters InsurancePlans based on the code that classifies the type of health insurance product, identified by InsurancePlan.type. For each specified facility type, the system and code are separated using a URL-encoded | character i.e. %7c.

Note: Supports passing a comma-separated list of values.

Sample Value: http://terminology.hl7.org/CodeSystem/insurance-plan-type|medical,http://terminology.hl7.org/CodeSystem/insurance-plan-type|mental

Name:

period

optional

Type:

formData

Data Type:

array

Description:

Filters the InsurancePlans by the period of time the health insurance product is available on, before, or after a specific date, date-time, or date range.

The supported prefixes are gt (greater than), ge (greater than or equal to), lt (less than), le (less than or equal to), and eq (equal to). If no prefix is used, exact date or date-time matching is implied.

Dates must be formatted according to ISO 8601, either as a date only (e.g., 1997-07-16) or as a date-time including the timezone (e.g., 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL-encoded (i.e., %2B).

The format of the query is

• period=gt{dateTimeValue}
• period=ge{dateTimeValue}&period=le{dateTimeValue}

Sample Value: period=gt2012-01-01&period=lt2022-01-01

Name:

_lastUpdated

optional

Type:

formData

Data Type:

array

Description:

Allows the user to filter InsurancePlans by the lastUpdated date. The date value can be a single date, as well as lower and/or upper bound.

The supported operations are: =gt, =ge, =lt, =ne, =le, =eq. For more information about using these search operators, refer to the date section on the FHIR Search page.

The {dateTimeValue} value should be in the following format: 2013-01-01T23:00:00-05:00. However, the time portion can be excluded. If a time portion is provided, the time zone must be provided as well.

It is highly recommended to provide the time zone portion in any query. Ensure that special characters such as '+' are encoded so that it can be interpreted correctly. For example: "2014-01-01T00:00:00+13:00" should be encoded like this: "2014-01-01T00:00:00%2B13:00".

If a date query comes in without a time zone, the date will be interpreted according to the server's time zone.

Including this query parameter includes all InsurancePlans that match the specified InsurancePlan.Meta.lastUpdated.

Sample Value: _lastUpdated=gt2012-01-01&_lastUpdated=lt2022-01-01

Name:

_summary

optional

Type:

formData

Data Type:

string

Description:

Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are

• true: return summaries only
• false: return full resources
• count: return the count of search matches
• text: return only the text, id, meta, and top-level mandatory elements
• data: remove the text element

Sample Value: true

Name:

-include-sources

optional

Type:

formData

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameters can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.

Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%InsurancePlans

Name:

-exclude-sources

optional

Type:

formData

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.

Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%InsurancePlans

Name:

_elements

optional

Type:

formData

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=type,name,status,_elements:exclude=*.by

Name:

_format

optional

Type:

formData

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.

Default Value: xml

Sample Value: json

Name:

_pretty

optional

Type:

formData

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

-cursor

optional

Type:

formData

Data Type:

string

Description:

This is a server internal parameter to navigate different pages, indicating the server a cursor till where result matches were already returned.

This parameter is returned by the server as part of the next link of a paginated query.

Name:

_count

optional

Type:

formData

Data Type:

integer

Description:

Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.

The returned bundle may contain a next link if more results could be available.

Sample Value: 100

Name:

_sort

optional

Type:

formData

Data Type:

string

Description:

Request which order results should be returned in.

Supported _sort parameters are:

• period to sort by InsurancePlan.period.start ascending.
• -period to sort by InsurancePlan.period.start descending.
• name to sort by InsurancePlan.name in ascending alphabetical order.
• -name to sort by InsurancePlan.name in descending alphabetical order.
• _lastUpdated to sort by InsurancePlan.meta.lastUpdated ascending.
• -_lastUpdated to sort by InsurancePlan.meta.lastUpdated descending.

You can use any combination of the parameters.

Default Value: -period

Sample Value: -period,-name

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

Sample Value: application/json

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)

Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The CSRF-Token from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

id

required

Type:

path

Data Type:

string

Description:

The ID of the InsurancePlan resource.

Sample Value: GQ3DQYZUG5RTSLLEMEZDOLJUHAZDILJYMFTDCLJRMQYDCOLEG44GIOBSMJAFGMI

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=type,name,status,_elements:exclude=*.by

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.

Default Value: xml

Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)

Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The CSRF-Token from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the InsurancePlan resource.

Sample Value: shaE7HJQLMDF567CSMLCATDYMMCGKUHPO425VCSFPH6SRVZIRU43N4Q

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=type,name,status,_elements:exclude=*.by

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.

Default Value: xml

Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)

Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The CSRF-Token from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the InsurancePlan resource

Sample Value: shaE7HJQLMDF567CSMLCATDYMMCGKUHPO425VCSFPH6SRVZIRU43N4Q

Name:

versionid

required

Type:

path

Data Type:

integer

Description:

The version of the InsurancePlan resource

Sample Value: 1

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.

Sample Value: _elements=type,name,status,_elements:exclude=*.by

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.

Default Value: true

Sample Value: true

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.

Default Value: xml

Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.

Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.

Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)

Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The CSRF-Token from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.

Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.