Get a list of coverages
get
/Coverage
Retrieves a list of patient-level or encounter-level coverages that meet supplied query parameters.
Note: Public Healthcare represents an insurance policy funded by a public health system such as a provincial or national health plan. If any public coverages exist, they are returned with an ID prefixed with PH or PHP and returned in the payload with the rest of the coverages (private coverages).
Authorization Types
This operation supports the following authorization types:
Request
Query Parameters
-
-encounter(required): string
The logical resource ID of the clinical encounter. Required if
patientis not used.Example:
-encounter=98028029 -
_id(required): string
The logical resource ID associated with the resource. Required if
patientor-encounteris not used.Example:
_id=12724066-490016987-490016987 -
patient(required): string
The entity that caused the expenses. Required if
-encounteris not used.Example:
patient=Patient/12345
Header Parameters
-
Authorization(required): string
Contains the credentials to authenticate a consumer to the service. The credentials 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/fhir+json
Default Response
Example search for patient-level private coverage.
Example Request:GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage?patient=12724066{
'resourceType': 'Bundle',
'id': 'a8876443-c615-4244-9044-047dea2d92dd',
'type': 'searchset',
'total': 1,
'link': [
{
'relation': 'self',
'url': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage?patient=12724066'
}
],
'entry': [
{
'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage/12724066-490016987-490016987',
'resource': {
'resourceType': 'Coverage',
'id': '12724066-490016987-490016987',
'meta': {
'versionId': '24-24',
'lastUpdated': '2020-07-06T17:03:43.000Z'
},
'text': {
'status': 'generated',
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Coverage</b></p><p><b>Status</b>: Active</p><p><b>Subscriber</b>: SMART, NANCY</p><p><b>Beneficiary</b>: SMART, NANCY</p><p><b>Coverage Start Date</b>: Aug 14, 2015 7:07 P.M. UTC</p><p><b>Payor</b>: SELF PAY</p><p><b>Class</b>: plan: Value: 2800235 Name: Self Pay</p></div>'
},
'identifier': [
{
'type': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/v2-0203',
'code': 'MB'
}
]
},
'value': '123'
},
{
'type': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/v2-0203',
'code': 'MB'
}
]
},
'value': '123'
}
],
'status': 'active',
'type': {
'coding': [
{
'system': 'urn:oid:2.16.840.1.113883.3.221.5',
'code': '5',
'display': 'PRIVATE HEALTH INSURANCE',
'userSelected': false
}
],
'text': 'Private Health Insurance'
},
'subscriber': {
'reference': 'Patient/12724066',
'display': 'SMART, NANCY'
},
'beneficiary': {
'reference': 'Patient/12724066',
'display': 'SMART, NANCY'
},
'relationship': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/subscriber-relationship',
'code': 'self',
'display': 'Self',
'userSelected': false
}
],
'text': 'Self'
},
'period': {
'start': '2015-08-14T19:07:56.000Z'
},
'payor': [
{
'reference': 'Organization/589803',
'display': 'SELF PAY'
}
],
'class': [
{
'type': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/coverage-class',
'code': 'plan'
}
]
},
'value': '2800235',
'name': 'Self Pay'
}
]
}
}
]
}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.
x-encounter-level-private Response
Example search for encounter-level private coverage.
Example Request:GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage?-encounter=97954095{
'resourceType': 'Bundle',
'id': 'd42baa44-1566-458c-8457-10fbfacfc3e5',
'type': 'searchset',
'total': 1,
'link': [
{
'relation': 'self',
'url': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage?-encounter=97954095'
}
],
'entry': [
{
'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage/97954095-98320174',
'resource': {
'resourceType': 'Coverage',
'id': '97954095-98320174',
'meta': {
'versionId': '0',
'lastUpdated': '2020-07-27T21:01:55.000Z'
},
'text': {
'status': 'extensions',
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Coverage</b></p><p><b>Status</b>: Active</p><p><b>Subscriber</b>: SMART, NANCY</p><p><b>Subscriber Id</b>: 12345</p><p><b>Encounter</b>: 97954095</p><p><b>Beneficiary</b>: SMART, NANCY</p><p><b>Dependent Number</b>: 12345</p><p><b>Coverage Start Date</b>: Feb 2, 2020 6:00 A.M. UTC</p><p><b>Coverage End Date</b>: Feb 3, 2021 5:59 A.M. UTC</p><p><b>Payor</b>: Aetna</p><p><b>Class</b>: plan: Value: 2830233 Name: Aetna</p></div>'
},
'extension': [
{
'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/coverage-encounter',
'valueReference': {
'reference': 'Encounter/97954095'
}
}
],
'status': 'active',
'type': {
'coding': [
{
'system': 'urn:oid:2.16.840.1.113883.3.221.5',
'code': '5',
'display': 'PRIVATE HEALTH INSURANCE',
'userSelected': false
}
],
'text': 'Private Health Insurance'
},
'subscriber': {
'reference': 'Patient/12724066',
'display': 'SMART, NANCY'
},
'subscriberId': '12345',
'beneficiary': {
'reference': 'Patient/12724066',
'display': 'SMART, NANCY'
},
'dependent': '12345',
'relationship': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/subscriber-relationship',
'code': 'self',
'display': 'Self',
'userSelected': false
}
],
'text': 'Self'
},
'period': {
'start': '2020-02-02T06:00:00.000Z',
'end': '2021-02-03T05:59:59.000Z'
},
'payor': [
{
'reference': 'Organization/3064032',
'display': 'Aetna'
}
],
'class': [
{
'type': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/coverage-class',
'code': 'plan'
}
]
},
'value': '2830233',
'name': 'Aetna'
}
]
}
}
]
}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.
x-encounter-level-public Response
Example search for encounter-level public coverage.
Example Request:GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage?-encounter=97701467{
'resourceType': 'Bundle',
'id': '1714d1b5-cabf-4c4a-bb76-c1e2e4d76d64',
'type': 'searchset',
'total': 1,
'link': [
{
'relation': 'self',
'url': 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage?-encounter=97701467'
}
],
'entry': [
{
'fullUrl': 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage/PH-98371617-97701467',
'resource': {
'resourceType': 'Coverage',
'id': 'PH-98371617-97701467',
'meta': {
'versionId': '2-0',
'lastUpdated': '2020-09-24T17:11:10.000Z'
},
'text': {
'status': 'extensions',
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Coverage</b></p><p><b>Status</b>: Active</p><p><b>Encounter</b>: 97701467</p><p><b>Beneficiary</b>: TRAUMA SURGERY, TESTONE</p><p><b>Coverage Start Date</b>: Jul 1, 2022 5:00 A.M. UTC</p><p><b>Coverage End Date</b>: Jul 1, 2025 5:00 A.M. UTC</p><p><b>Payor</b>: Government</p><p><b>Class</b>:</p><dl><dt>Class</dt><dd><b>Value</b>: 2572499881</dd><dd><b>Name</b>: Charging Category</dd></dl><p><b>Type</b>: public healthcare</p></div>'
},
'extension': [
{
'valueReference': {
'reference': 'Encounter/97701467'
},
'url': 'https://fhir-ehr.cerner.com/r4/StructureDefinition/coverage-encounter'
}
],
'status': 'active',
'type': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/v3-ActCode',
'code': 'PUBLICPOL',
'display': 'public healthcare'
}
],
'text': 'public healthcare'
},
'beneficiary': {
'reference': 'Patient/12462008',
'display': 'TRAUMA SURGERY, TESTONE'
},
'period': {
'start': '2022-07-01T05:00:00.000Z',
'end': '2025-07-01T05:00:00.000Z'
},
'payor': [
{
'display': 'Government'
}
],
'class': [
{
'type': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/coverage-class',
'code': 'class'
}
]
},
'value': '2572499881',
'name': 'Charging Category'
}
]
}
}
]
}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.
x-id-level-private Response
Example search for ID-level private coverage.
Example Request:GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage?_id=12724066-491651736-491651736{
'resourceType': 'Coverage',
'id': '12724066-491651736-491651736',
'meta': {
'versionId': '4-4',
'lastUpdated': '2024-01-10T19:33:27.000Z'
},
'text': {
'status': 'generated',
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Coverage</b></p><p><b>Status</b>: Active</p><p><b>Subscriber</b>: SMART II, NANCY</p><p><b>Beneficiary</b>: SMART II, NANCY</p><p><b>Relationship</b>: Self</p><p><b>Coverage Start Date</b>: Jun 6, 2021 12:00 A.M. UTC</p><p><b>Payor</b>: MEDICARE</p><p><b>Class</b>:</p><dl><dt>Plan</dt><dd><b>Value</b>: 3132243</dd><dd><b>Name</b>: Medicare Part B</dd></dl></div>'
},
'identifier': [
{
'extension': [
{
'valueCode': 'unknown',
'url': 'http://hl7.org/fhir/StructureDefinition/data-absent-reason'
}
]
}
],
'status': 'active',
'type': {
'coding': [
{
'system': 'urn:oid:2.16.840.1.113883.3.221.5',
'code': '5',
'display': 'PRIVATE HEALTH INSURANCE',
'userSelected': false
}
],
'text': 'Private Health Insurance'
},
'subscriber': {
'reference': 'Patient/12724066',
'display': 'SMART II, NANCY'
},
'beneficiary': {
'reference': 'Patient/12724066',
'display': 'SMART II, NANCY'
},
'relationship': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/subscriber-relationship',
'code': 'self',
'display': 'Self',
'userSelected': false
}
],
'text': 'Self'
},
'period': {
'start': '2021-06-06T00:00:00.000Z'
},
'payor': [
{
'reference': 'Organization/589783',
'display': 'MEDICARE'
}
],
'class': [
{
'type': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/coverage-class',
'code': 'plan'
}
]
},
'value': '3132243',
'name': 'Medicare Part B'
}
]
}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.
x-patient-level-public Response
Example search for patient-level public coverage.
Example Request:GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage?patient=12724066{
'resourceType': 'Bundle',
'id': '8ff4481d-ce55-4b3f-ac2c-4d4fd3cad4c0',
'type': 'searchset',
'total': 1,
'link': [
{
'relation': 'self',
'url': 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage?patient=12724066'
}
],
'entry': [
{
'fullUrl': 'https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage/PHP-490218084-12724066',
'resource': {
'resourceType': 'Coverage',
'id': 'PHP-490218084-12724066',
'meta': {
'versionId': '134-0',
'lastUpdated': '2021-03-16T20:04:11.000Z'
},
'text': {
'status': 'generated',
'div': '<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Coverage</b></p><p><b>Status</b>: Active</p><p><b>Beneficiary</b>: SMART, NANCY</p><p><b>Coverage Start Date</b>: Mar 16, 2021 8:04 P.M. UTC</p><p><b>Payor</b>: Government</p><p><b>Class</b>:</p><dl><dt>Charging Category</dt><dd><b>Value</b>:2572940471</dd><dd><b>Name</b>: 10-OPC, Class II</dd></dl><p><b>Type</b>: public healthcare</p></div>'
},
'status': 'active',
'type': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/v3-ActCode',
'code': 'PUBLICPOL',
'display': 'public healthcare'
}
],
'text': 'public healthcare'
},
'beneficiary': {
'reference': 'Patient/12462008',
'display': 'TRAUMA SURGERY, TESTONE'
},
'period': {
'start': '2021-03-16T20:04:11.000Z'
},
'payor': [
{
'display': 'Government'
}
],
'class': [
{
'type': {
'text': 'Charging Category'
},
'value': '2572940471',
'name': '10-OPC, Class II'
}
]
}
}
]
}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.