FHIR.CoverageEligibilityResponse
Fields
Meta
Meta.DataModelString
ReliableRequiredFHIR.CoverageEligibilityResponse
Meta.EventTypeString
ReliableRequired$respond
Meta.EventDateTimeDateTime
ReliableDateTime of the event.
ISO 8601 Format
Meta.TestBoolean
ReliableFlag as a test message
Meta.SourceString
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.IDString
ReliableID of the source.
UUID
Meta.Source.NameString
ReliableName of the source
Meta.Destinations[]Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].IDString
ReliableID of the destination.
UUID
Meta.Destinations[].NameString
ReliableName of the destination
Meta.Logs[]Array of Objects
ReliableRequest log identifiers.
Meta.Logs[].IDString
ReliableID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID
Meta.Logs[].AttemptIDString
ReliableID of request log attempt. Useful in cases where retries are possible.
UUID
Meta.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.IDNumeric
ReliableID of the message created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.IDNumeric
ReliableID of the transmission created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
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.
{
"resourceType": "Bundle",
"id": "RedoxCoverageEligibilityResponseBundleExample",
"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": "CoverageEligibilityResponse",
"id": "check-123456789",
"status": "fm-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": [
"eligibilityrequest-purpose-benefits"
],
"request": {
"reference": "CoverageEligibilityRequest/check-123456789"
},
"outcome": "eligibility-outcome-complete",
"insurer": {
"reference": "Organization/RedoxPAInsurerOrganizationExample"
},
"insurance": [
{
"coverage": {
"reference": "Coverage/RedoxPACoverageExample"
},
"benefitPeriod": {
"start": "2022-01-18T16:20:00.101Z",
"end": "2023-01-18T17:20:00.101Z"
},
"item": [
{
"category": {
"coding": [
{
"code": "1",
"system": "https://x12.org/codes/service-type-codes",
"display": "Medical Care"
}
]
},
"benefit": [
{
"type": {
"coding": [
{
"code": "benefit-type-benefit",
"system": "https://terminology.hl7.org/3.0.0/CodeSystem-benefit-type.html"
}
]
}
},
{
"type": {
"coding": [
{
"code": "copay-maximum",
"system": "https://terminology.hl7.org/3.0.0/CodeSystem-benefit-type.html"
}
]
},
"allowedMoney": {
"value": 20
}
}
]
},
{
"category": {
"coding": [
{
"code": "33",
"system": "https://x12.org/codes/service-type-codes",
"display": "Chiropractic"
}
]
},
"benefit": [
{
"type": {
"coding": [
{
"code": "benefit-type-benefit",
"system": "https://terminology.hl7.org/3.0.0/CodeSystem-benefit-type.html"
}
]
}
},
{
"type": {
"coding": [
{
"code": "copay-maximum",
"system": "https://terminology.hl7.org/3.0.0/CodeSystem-benefit-type.html"
}
]
},
"allowedMoney": {
"value": 20
}
}
]
},
{
"category": {
"coding": [
{
"code": "35",
"system": "https://x12.org/codes/service-type-codes",
"display": "Dental Care"
}
]
},
"benefit": [
{
"type": {
"coding": [
{
"code": "benefit-type-benefit",
"system": "https://terminology.hl7.org/3.0.0/CodeSystem-benefit-type.html"
}
]
}
},
{
"type": {
"coding": [
{
"code": "copay-maximum",
"system": "https://terminology.hl7.org/3.0.0/CodeSystem-benefit-type.html"
}
]
},
"allowedMoney": {
"value": 20
}
}
]
},
{
"category": {
"coding": [
{
"code": "47",
"system": "https://x12.org/codes/service-type-codes",
"display": "Hospital"
}
]
},
"benefit": [
{
"type": {
"coding": [
{
"code": "benefit-type-benefit",
"system": "https://terminology.hl7.org/3.0.0/CodeSystem-benefit-type.html"
}
]
}
},
{
"type": {
"coding": [
{
"code": "copay-maximum",
"system": "https://terminology.hl7.org/3.0.0/CodeSystem-benefit-type.html"
}
]
},
"allowedMoney": {
"value": 20
}
}
]
},
{
"category": {
"coding": [
{
"code": "86",
"system": "https://x12.org/codes/service-type-codes",
"display": "Emergency Services"
}
]
}
}
]
}
]
}
},
{
"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": "RedoxPABeneficiary"
},
"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": "2022-07-01T17:19:28.573Z",
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"DataModel": "FHIR.CoverageEligibilityResponse",
"EventType": "$respond"
}
}