FHIR InsurancePlan
Base Path: /fhir/4.0/InsurancePlan
Version: 1.0.0
The FHIR InsurancePlan API allows you to look up details about the FHIR 4.0 Insurance Plans. The endpoint provides the ability to:
- Retrieve all Insurance Plan resources that match a search criteria
- Retrieve a specific Insurance Plan resource based on its FHIR ID.
- Retrieve the history of an Insurance Plan resource based on its FHIR ID
The InsurancePlan API aggregates data from multiple sources, to learn about working with aggregated APIs refer to the Aggregated APIs guide in the Knowledge Hub.
This API is based on the R4 release of the FHIR standard, for more information on this API refer to the official FHIR documentation.
Methods
Returns all available Insurance Plan resources using the GET method
GET /fhir/4.0/InsurancePlan/
Return all Insurance Plan resources for the given search criteria, or all Insurance Plans if a search criteria is not specified.
Parameters
Name
Type
Data Type
Description
Name:
address
optional
Type:
query
Data Type:
string
Description:
Filters the insurancePlans to those with contact address (InsurancePlan.contact.address) matching specified address
Sample Value: 123 Main St Suite 200 Anytown CA 12345 USA
Name:
address-city
optional
Type:
query
Data Type:
string
Description:
Filters the insurancePlans to those with contact address (InsurancePlan.contact.address.city) matching specified city
Sample Value: Sydney
Name:
address-country
optional
Type:
query
Data Type:
string
Description:
Filters the insurancePlans to those with contact address (InsurancePlan.contact.address.country) matching specified country
Sample Value: Australia
Name:
address-postalcode
optional
Type:
query
Data Type:
string
Description:
Filters the insurancePlans to those with contact address (InsurancePlan.contact.address.postalCode) matching specified postal code
Sample Value: 1466
Name:
address-state
optional
Type:
query
Data Type:
string
Description:
Filters the insurancePlans to those with contact address (InsurancePlan.contact.address.state) matching specified state
Sample Value: NSW
Name:
address-use
optional
Type:
query
Data Type:
string
Description:
Filters the insurancePlans to those with contact address (InsurancePlan.contact.address.use) matching specified use.
Sample Value: home
Name:
administered-by
optional
Type:
query
Data Type:
array
Description:
Filters the insurance plans to those where the Product administrator Organization match the specified Organization references.
Note: administered-by can be chained to define filters on the reference organization, each of the chained parameter can specify multiple comma separated values.
Sample Value: administered-by.name=Good Health Clinic, Burgers UMC Ear Nose Throat unit&administered-by.address.city=Auckland
Name:
coverage-area
optional
Type:
query
Data Type:
array
Description:
Filters the insurance plans to those that match the reference Location coverage area to where the product applies.
Note: coverage-area can be chained to define filters on the reference location, each of the chained parameter can specify multiple comma separated values
Sample Value: coverage-area.status=suspended&coverage-area.name=South wing Floor 2&coverage-area.address.city=Auckland
Name:
plan-type
optional
Type:
query
Data Type:
array
Description:
Filters the insurance plans to those that their plan.type matches the specified plan-type
Sample Value: High Deductable
Name:
endpoint
optional
Type:
query
Data Type:
array
Description:
Filters the insurance plans to those that their InsurancePlan.endpoint matches the specified endpoint references
Note: endpoint can be chained to define filter on the reference endpoint, each of the chained endpoint can specify multiple comma separated values.
Sample Value: endpoint.name=Questionnaire Destination&endpoint.status=active&endpoint.connection-type=http://terminology.hl7.org/CodeSystem/endpoint-connection-type|ihe-iid
Name:
identifier
optional
Type:
query
Data Type:
array
Description:
Filters the insurance plans to those with at least one identifier that matches one of the specified identifiers
Sample Value: http://hl7.org/fhir/sid/us-npi|1234567890
Name:
name
optional
Type:
query
Data Type:
array
Description:
Filters the insurance plans to those which their requested name is a portion of the insurance plan's name or alias
Sample Value: HealthGuard Plus, WellCare Prime
Name:
owned-by
optional
Type:
query
Data Type:
array
Description:
Filters the insurance plans to those that match the specified plan issuer Organization reference.
Note: owned-by can be chained to define filter on the reference organization, each of the chained endpoint can specify multiple comma separated values
Sample Value: owned-by.name=WellCare Prime&owned-by.active=true&owned-by.address.city=Auckland
Name:
phonetic
optional
Type:
query
Data Type:
array
Description:
Filters the insurance plans by giving a portion of the insurance plan's name using some phonetic matching algorithm
Sample Value: NIB Prem Plan
Name:
status
optional
Type:
query
Data Type:
string
Description:
Filters the insurance plans to those that match the specified status.
Sample Value: draft
Name:
type
optional
Type:
query
Data Type:
array
Description:
Filters the insurance plans to plans with a type that matches one of the specified types
Sample Value: http://terminology.hl7.org/CodeSystem/insurance-plan-type|medical
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 parameter 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.
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.
Name:
_format
optional
Type:
query
Data Type:
string
Description:
Media type of the response. It takes precedence over the accept header.
Default Value: json
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response
Default Value: application/xml
Sample Value: application/json
Responses
200
Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* Insurance Plan resources
400
This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.
Sample Requests
Retrieve all Insurance Plans by its identifier and status
curl -X GET "https://developer-solution/fhir/4.0/InsurancePlan/?identifier=http://hl7.org/fhir/sid/us-npi%7C1234567890&status=draft" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Returns all available Insurance Plan resources using the POST method
POST /fhir/4.0/InsurancePlan/_search
Return all Insurance Plan resources for the given search criteria, or all Insurance Plans if a search criteria is not specified.
Parameters
Name
Type
Data Type
Description
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:
string
Description:
Filters the insurancePlans to those with contact address (InsurancePlan.contact.address) matching specified address
Sample Value: 123 Main St Suite 200 Anytown CA 12345 USA
Name:
address-city
optional
Type:
formData
Data Type:
string
Description:
Filters the insurancePlans to those with contact address (InsurancePlan.contact.address.city) matching specified city
Sample Value: Sydney
Name:
address-country
optional
Type:
formData
Data Type:
string
Description:
Filters the insurancePlans to those with contact address (InsurancePlan.contact.address.country) matching specified country
Sample Value: Australia
Name:
address-postalcode
optional
Type:
formData
Data Type:
string
Description:
Filters the insurancePlans to those with contact address (InsurancePlan.contact.address.postalCode) matching specified postal code
Sample Value: 1466
Name:
address-state
optional
Type:
formData
Data Type:
string
Description:
Filters the insurancePlans to those with contact address (InsurancePlan.contact.address.state) matching specified state
Sample Value: NSW
Name:
address-use
optional
Type:
formData
Data Type:
string
Description:
Filters the insurancePlans to those with contact address (InsurancePlan.contact.address.use) matching specified use.
Sample Value: home
Name:
administered-by
optional
Type:
query
Data Type:
array
Description:
Filters the insurance plans to those where the Product administrator Organization match the specified Organization references.
Note: administered-by can be chained to define filters on the reference organization, each of the chained parameter can specify multiple comma separated values.
Sample Value: administered-by.name=Good Health Clinic, Burgers UMC Ear Nose Throat unit&administered-by.address.city=Auckland
Name:
coverage-area
optional
Type:
formData
Data Type:
array
Description:
Filters the insurance plans to those that match the reference Location coverage area to where the product applies.
Note: coverage-area can be chained to define filters on the reference location, each of the chained parameter can specify multiple comma separated values
Sample Value: coverage-area.status=suspended&coverage-area.name=South wing Floor 2&coverage-area.address.city=Auckland
Name:
plan-type
optional
Type:
formData
Data Type:
array
Description:
Filters the insurance plans to those that their plan.type matches the specified plan-type
Sample Value: High Deductable
Name:
endpoint
optional
Type:
formData
Data Type:
array
Description:
Filters the insurance plans to those that their InsurancePlan.endpoint matches the specified endpoint references
Note: endpoint can be chained to define filter on the reference endpoint, each of the chained endpoint can specify multiple comma separated values.
Sample Value: endpoint.name=Questionnaire Destination&endpoint.status=active&endpoint.connection-type=http://terminology.hl7.org/CodeSystem/endpoint-connection-type|ihe-iid
Name:
identifier
optional
Type:
formData
Data Type:
array
Description:
Filters the insurance plans to those with at least one identifier that matches one of the specified identifiers
Sample Value: http://hl7.org/fhir/sid/us-npi|1234567890
Name:
name
optional
Type:
formData
Data Type:
array
Description:
Filters the insurance plans to those that have a matching name or alias. The search for name allows partial matches, is case insensitive and can match any one of the specified names.
Sample Value: HealthGuard Plus, WellCare Prime
Name:
owned-by
optional
Type:
formData
Data Type:
array
Description:
Filters the insurance plans to those that match the specified plan issuer Organization reference.
Note: owned-by can be chained to define filter on the reference organization, each of the chained endpoint can specify multiple comma separated values.
Sample Value: owned-by.name=WellCare Prime&owned-by.active=true&owned-by.address.city=Auckland
Name:
phonetic
optional
Type:
formData
Data Type:
array
Description:
Filters the insurance plans by giving a portion of the insurance plan's name using some phonetic matching algorithm
Sample Value: NIB Prem Plan
Name:
status
optional
Type:
formData
Data Type:
string
Description:
Filters the insurance plans to those that match the specified status.
Sample Value: draft
Name:
type
optional
Type:
formData
Data Type:
array
Description:
Filters the insurance plans to plans with a type that matches one of the specified types
Sample Value: http://terminology.hl7.org/CodeSystem/insurance-plan-type|medical
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 parameter 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.
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.
Name:
_format
optional
Type:
formData
Data Type:
string
Description:
Media type of the response. It takes precedence over the accept header.
Default Value: json
Sample Value: json
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response
Default Value: application/xml
Sample Value: application/json
Responses
200
Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* Insurance Plan resources
400
This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.
Sample Requests
Retrieve all Insurance Plans by its status and type
curl -X POST "https://developer-solution/fhir/4.0/InsurancePlan/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'status=draft' \
-d 'type=http://terminology.hl7.org/CodeSystem/insurance-plan-type%7Cmedical'Retrieve a single Insurance Plan
GET /fhir/4.0/InsurancePlan/{id}
This method returns the Insurance Plan resource matching the requested resource ID.
Parameters
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The id of the Insurance Plan resource to query for
Sample Value: shaTWIQUXLR7RLNCR45AMPETZEQYJ6UDN6OV43CD6JCRJJZE3OX6IJQ
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. The default value is 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. The default value is application/xml.
Sample Value: application/xml
Responses
200
Returns an Insurance Plan resource matching the requested resource ID.
404
No Insurance Plan resource found with the requested resource ID.
Sample Requests
Retrieve an InsurancePlan identified by a specific resource id
curl -X GET "https://developer-solution/fhir/4.0/InsurancePlan/shaTWIQUXLR7RLNCR45AMPETZEQYJ6UDN6OV43CD6JCRJJZE3OX6IJQ" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve an Insurance Plan's history
GET /fhir/4.0/InsurancePlan/{id}/_history
This method returns the change history for an Insurance Plan resource matching the requested resource ID.
Parameters
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The id of the Insurance Plan resource to query for
Sample Value: shaTZJPZBQMDLCHZG2ZFGLUSU2CUWV2JVI5ZUVHDTNJP6XQCVSJMKFA
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. The default value is 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. The default value is application/xml.
Sample Value: application/xml
Responses
200
A FHIR Bundle containing 0..* Insurance Plan resources matching the requested resource ID.
400
The source providing the Insurance Plan resource is not capable of returning history of Insurance Plan resources.
404
No Insurance Plan resource found with the requested resource ID.
Sample Requests
Retrieve the history of an InsurancePlan identified a specific resource id.
curl -X GET "https://developer-solution/fhir/4.0/InsurancePlan/shaTZJPZBQMDLCHZG2ZFGLUSU2CUWV2JVI5ZUVHDTNJP6XQCVSJMKFA/_history" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='