FHIR.CoverageEligibilityRequest
Fields
Meta
Meta.DataModelString
ReliableRequiredFHIR.CoverageEligibilityRequest
Meta.EventTypeString
ReliableRequired$submit
Meta.EventDateTimeDateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.TestBoolean
ReliableIndicates whether the request is a test or not.
Meta.SourceString
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.IDString
ReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID
Meta.Source.NameString
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]Array of Objects
ReliableContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.
Meta.Destinations[].IDString
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].NameString
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].IDString
ReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID
Meta.Logs[].AttemptIDString
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCodeString
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Meta.SessionIDString
PossibleSession ID to be passed through for 3rd party sessions.
This is used for SMART App Launch and other OAuth/OpenID Connect flows where an access token is provided in addition to the SSO claims. The SessionID can be used on subsequent Redox API requests to fetch data.
Meta.RespondAsyncBoolean
PossibleA flag for indicating that the query response should follow the Asynchronous Buld Data Request pattern
{
"resourceType": "Bundle",
"id": "RedoxCoverageEligibilityRequestBundleExample",
"type": "collection",
"identifier": {
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:d348a18d-3676-426b-8105-e36085a710e3"
},
"timestamp": "2021-09-02T18:47:15.916Z",
"entry": [
{
"resource": {
"resourceType": "CoverageEligibilityRequest",
"id": "check-123456789",
"status": "active",
"patient": {
"reference": "Patient/RedoxPABeneficiaryExample"
},
"created": "2022-01-18T16:27:49.101Z",
"servicedPeriod": {
"start": "2022-01-18T16:20:00.101Z",
"end": "2022-01-18T17:20:00.101Z"
},
"purpose": [
"benefits"
],
"insurer": {
"reference": "Organization/RedoxPAInsurerOrganizationExample"
},
"provider": {
"reference": "Practitioner/RedoxPAPractitionerExamplePat"
},
"facility": {
"reference": "Location/RedoxLocationExample"
},
"priority": {
"coding": [
{
"code": "normal",
"system": "http://terminology.hl7.org/CodeSystem/processpriority"
}
]
},
"insurance": [
{
"focal": true,
"coverage": {
"reference": "Coverage/RedoxPACoverageExample"
}
}
],
"item": [
{
"category": {
"coding": [
{
"code": "30",
"system": "https://x12.org/codes/service-type-codes",
"display": "Plan Coverage and General Benefits"
}
]
}
}
]
}
},
{
"resource": {
"resourceType": "Patient",
"id": "RedoxPABeneficiaryExample",
"identifier": [
{
"system": "urn:redox:MRN",
"value": "M23462346"
}
],
"name": [
{
"given": [
"Timothy",
"Paul"
],
"family": "Bixby"
}
],
"gender": "male",
"birthDate": "2008-01-06"
}
},
{
"resource": {
"resourceType": "Coverage",
"id": "RedoxPACoverageWithRelatedSubscriberExample",
"class": [
{
"type": {
"coding": [
{
"code": "group",
"system": "http://terminology.hl7.org/CodeSystem/coverage-class"
}
]
},
"value": "GRP2245"
}
],
"status": "active",
"beneficiary": {
"reference": "Patient/RedoxPABeneficiaryExample"
},
"payor": [
{
"reference": "Organization/RedoxPAInsurerOrganizationExample"
}
],
"subscriber": {
"reference": "RelatedPerson/RedoxPASubscriberExample"
},
"subscriberId": "M2346623"
}
},
{
"resource": {
"resourceType": "Organization",
"id": "RedoxPAInsurerOrganizationExample",
"active": true,
"name": "Aetna",
"address": [
{
"line": [
"PO Box 14080"
],
"city": "Lexington",
"district": "Fayette",
"state": "KY",
"postalCode": "40512-4079",
"country": "USA"
}
]
}
},
{
"resource": {
"resourceType": "Practitioner",
"id": "RedoxPAPractitionerExamplePat",
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "4356789876"
}
],
"name": [
{
"given": [
"Pat"
],
"family": "Granite"
}
],
"address": [
{
"line": [
"123 Main St."
],
"city": "Madison",
"district": "Dane",
"state": "WI",
"postalCode": "53703",
"country": "USA"
}
],
"telecom": [
{
"value": "+16085551234"
}
]
}
},
{
"resource": {
"resourceType": "RelatedPerson",
"id": "RedoxPASubscriberExample",
"patient": {
"reference": "Patient/RedoxPABeneficiaryExample"
},
"name": [
{
"given": [
"Barbara"
],
"family": "Bixby"
}
],
"relationship": [
{
"text": "Mother"
}
]
}
},
{
"resource": {
"resourceType": "Location",
"id": "RedoxLocationExample",
"name": "RHS Vista Oaks Clinic",
"type": [
{
"coding": [
{
"code": "OF",
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"display": "Outpatient Facility"
}
]
}
],
"physicalType": {
"coding": [
{
"code": "bu",
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
"display": "Building"
}
]
}
}
}
],
"Meta": {
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"Test": true,
"EventDateTime": "2024-07-29T16:55:22.999Z",
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"DataModel": "FHIR.CoverageEligibilityRequest",
"EventType": "$submit"
}
}