FHIR R4 APIs for Oracle Health Millennium Platform

Get a coverage by ID

get

/Coverage/{ID}

Retrieves a coverage by the associated coverage ID.

Authorization Types

This operation supports the following authorization types:

Request

Path Parameters

ID(required): string

The logical resource ID associated with the resource.

Header Parameters

accept(required): string

The media type to be requested. See what the resource's operation produces for what is supported.
authorization(required): string

Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

Response

Supported Media Types

application/fhir+json

Default Response

Example retrieval of patient-level private coverage.

Example Request:

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage/12724066-490016987-490016987

Example Response:

{
    '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>'
    },
    '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 retrieval of encounter-level private coverage.

Example Request:

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage/97954095-98320174

Example Response:

{
    '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 retrieval of encounter-level public coverage.

Example Request:

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage/PH-98371617-97701467

Example Response:

{
    '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-patient-level-public Response

Example retrieval of patient-level public coverage.

Example Request:

GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Coverage/PHP-490218084-12724066

Example Response:

{
    '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.