Get a list of insurance plans
get
/InsurancePlan
Retrieves a list of insurance plans that meet supplied query parameters.
Authorization Types
This operation supports the following authorization types:
Request
Query Parameters
-
_id: string
The logical resource ID.
- This parameter is required if the
owned-byparameter is not used. - May be provided with a single value or a comma-separated list of references. Example:
_id=12345or_id=12345,67890. - May not be provided with
owned-by.
_id=1234 - This parameter is required if the
-
owned-by: string
The organization associated with the insurance plan.
- This parameter is required if the
_idparameter is not used. - Must be provided only once.
- May not be provided with
_id.
owned-by=Organization/5678 - This parameter is required if the
Header Parameters
-
Authorization(required): string
Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer token.
-
accept(required): string
The media type to be requested. See what the resource's operation produces for what is supported.
Response
Supported Media Types
- application/json+fhir
Default Response
Example search by
Example Request:
owned-by.Example Request:
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/InsurancePlan?owned-by=Organization/589783{
'resourceType': 'Bundle',
'id': 'e445217e-122b-4e89-9ae3-74e0ba1c24fb',
'type': 'searchset',
'total': 4,
'link': [
{
'relation': 'self',
'url': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/InsurancePlan?owned-by=589783'
}
],
'entry': [
{
'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/InsurancePlan/2798233',
'resource': {
'resourceType': 'InsurancePlan',
'id': '2798233',
'text': {
'status': 'generated',
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Insurance Plan</b></p><p><b>Name</b>:Medicare Part A</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:Organization/589783</p><p><b>Period Start Date</b>: Aug 14, 2015 2:32 P.M. UTC</p></div>'
},
'status': 'active',
'type': [
{
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/27137',
'code': '4372138',
'display': 'Medical Service Plan',
'userSelected': true
},
{
'system': 'http://terminology.hl7.org/CodeSystem/insurance-plan-type',
'code': 'medical',
'display': 'Medical',
'userSelected': false
}
],
'text': 'Medical Service Plan'
}
],
'name': 'Medicare Part A',
'period': {
'start': '2015-08-14T14:32:01.000Z'
},
'ownedBy': {
'reference': 'Organization/589783'
}
}
},
{
'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/InsurancePlan/3132244',
'resource': {
'resourceType': 'InsurancePlan',
'id': '3132244',
'text': {
'status': 'generated',
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Insurance Plan</b></p><p><b>Name</b>:Medicare Part A and B</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:Organization/589783</p><p><b>Period Start Date</b>: Apr 3, 2018 8:37 P.M. UTC</p></div>'
},
'status': 'active',
'type': [
{
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/27137',
'code': '4372138',
'display': 'Medical Service Plan',
'userSelected': true
},
{
'system': 'http://terminology.hl7.org/CodeSystem/insurance-plan-type',
'code': 'medical',
'display': 'Medical',
'userSelected': false
}
],
'text': 'Medical Service Plan'
}
],
'name': 'Medicare Part A and B',
'period': {
'start': '2018-04-03T20:37:54.000Z'
},
'ownedBy': {
'reference': 'Organization/589783'
}
}
},
{
'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/InsurancePlan/3132243',
'resource': {
'resourceType': 'InsurancePlan',
'id': '3132243',
'text': {
'status': 'generated',
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Insurance Plan</b></p><p><b>Name</b>:Medicare Part B</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:Organization/589783</p><p><b>Period Start Date</b>: Apr 3, 2018 8:36 P.M. UTC</p></div>'
},
'status': 'active',
'type': [
{
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/27137',
'code': '4372138',
'display': 'Medical Service Plan',
'userSelected': true
},
{
'system': 'http://terminology.hl7.org/CodeSystem/insurance-plan-type',
'code': 'medical',
'display': 'Medical',
'userSelected': false
}
],
'text': 'Medical Service Plan'
}
],
'name': 'Medicare Part B',
'period': {
'start': '2018-04-03T20:36:27.000Z'
},
'ownedBy': {
'reference': 'Organization/589783'
}
}
},
{
'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/InsurancePlan/3226346',
'resource': {
'resourceType': 'InsurancePlan',
'id': '3226346',
'text': {
'status': 'generated',
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Insurance Plan</b></p><p><b>Name</b>:Medicare Provider Liable</p><p><b>Type</b>: Medical Service Plan</p><p><b>Owned By</b>:Organization/589783</p><p><b>Period Start Date</b>: Apr 16, 2019 5:42 P.M. UTC</p></div>'
},
'status': 'active',
'type': [
{
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/27137',
'code': '4372138',
'display': 'Medical Service Plan',
'userSelected': true
},
{
'system': 'http://terminology.hl7.org/CodeSystem/insurance-plan-type',
'code': 'medical',
'display': 'Medical',
'userSelected': false
}
],
'text': 'Medical Service Plan'
}
],
'name': 'Medicare Provider Liable',
'period': {
'start': '2019-04-16T17:42:34.000Z'
},
'ownedBy': {
'reference': 'Organization/589783'
}
}
}
]
}Headers
-
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id, if present.