FHIR.Event.Order
Fields
Meta
Meta.DataModelString
ReliableRequiredFHIR.Event.Order
Meta.EventTypeString
ReliableRequireddevice-request-cancelled
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.
Sample MessageDownload JSON Schema
{
"resourceType": "Bundle",
"id": "DeviceRequestCancelledFullBundleExample",
"type": "message",
"entry": [
{
"resource": {
"eventUri": "https://fhir.redoxengine.com/EventDefinition/DeviceRequestCancelled",
"resourceType": "MessageHeader",
"id": "DeviceRequestCancelledMessageHeader",
"source": {
"name": "Good Health Clinics",
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
},
"focus": [
{
"reference": "DeviceRequest/RedoxDeviceRequestExample"
},
{
"reference": "Patient/RedoxPatientExampleTimothy"
}
],
"definition": "https://fhir.redoxengine.com/MessageDefinition/DeviceRequestCancelledFull"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/DeviceRequest?identifier=56789302|urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"resource": {
"resourceType": "DeviceRequest",
"id": "RedoxDeviceRequestExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "56789302"
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"encounter": {
"reference": "Encounter/RedoxEncounterExample"
},
"status": "completed",
"occurrenceDateTime": "1999-11-01T05:00:00.000Z",
"codeCodeableConcept": {
"coding": [
{
"code": "72506001",
"system": "http://snomed.info/sct",
"display": "Automatic implantable cardioverter/defibrillator"
}
]
},
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/devicerequest-quantity",
"valueString": "2"
}
],
"_intent": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "unsupported"
}
]
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=0000000001|urn:redox:MRN",
"resource": {
"resourceType": "Patient",
"id": "RedoxPatientExampleTimothy",
"meta": {
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
"valueInteger": 1
}
]
},
"extension": [
{
"extension": [
{
"url": "text",
"valueString": "White"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"code": "2135-2",
"system": "urn:oid:2.16.840.1.113883.6.238",
"display": "Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Hispanic"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:health-one:MR"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"name": [
{
"given": [
"Timothy",
"Paul"
],
"family": "Bixby",
"use": "official"
},
{
"text": "Billy",
"use": "usual"
}
],
"gender": "male",
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
},
{
"value": "+18008675309",
"system": "phone",
"use": "work"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": [
{
"line": [
"4762 Hickory Street"
],
"city": "Monroe",
"district": "Greene",
"state": "WI",
"postalCode": "53566",
"country": "US",
"use": "home"
}
],
"maritalStatus": {
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
],
"text": "English"
}
}
],
"contact": [
{
"name": {
"given": [
"Barbara"
],
"family": "Bixby"
},
"telecom": [
{
"value": "+18088675303",
"system": "phone",
"use": "home"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": {
"line": [
"4762 Hickory St."
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "USA"
},
"relationship": [
{
"coding": [
{
"code": "MTH",
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"display": "mother"
}
],
"text": "Mother"
},
{
"coding": [
{
"code": "C",
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
"display": "Emergency Contact"
}
],
"text": "Emergency Contact"
}
]
}
],
"generalPractitioner": [
{
"reference": "Practitioner/RedoxPractitionerExamplePat"
}
],
"managingOrganization": {
"reference": "Organization/RedoxOrganizationManagingExample"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=zzz123Encounter|urn:redox:encounterId",
"resource": {
"resourceType": "Encounter",
"id": "RedoxEncounterExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
"value": "9601346482"
}
],
"status": "finished",
"class": {
"code": "IMP",
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"display": "inpatient encounter"
},
"type": [
{
"coding": [
{
"code": "99222",
"system": "http://www.ama-assn.org/go/cpt",
"display": "InPatient Admission"
}
]
}
],
"diagnosis": [
{
"condition": {
"reference": "Condition/RedoxConditionExampleEncounterDx"
}
}
],
"participant": [
{
"individual": {
"reference": "Practitioner/RedoxPractitionerExampleEncounter"
}
}
],
"location": [
{
"location": {
"reference": "Location/RedoxLocationExampleEncounter"
}
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"period": {
"start": "2022-02-06T04:00:00.000Z",
"end": "2022-02-06T04:15:00.000Z"
},
"length": {
"value": 16,
"code": "m",
"system": "http://unitsofmeasure.org"
},
"reasonCode": [
{
"coding": [
{
"code": "23360407",
"system": "http://snomed.info/sct"
}
],
"text": "Pneumonia"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExamplePat",
"resource": {
"resourceType": "Practitioner",
"id": "RedoxPractitionerExamplePat",
"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"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationManagingExample",
"resource": {
"resourceType": "Organization",
"id": "RedoxOrganizationManagingExample",
"identifier": [
{
"value": "1234",
"system": "urn:oid:1.2.3.4"
}
],
"active": true,
"name": "Custodial Org",
"address": [
{
"line": [
"123 Main St"
],
"city": "Madison",
"state": "WI"
}
],
"telecom": [
{
"value": "1-800-123-4567",
"system": "phone"
}
],
"type": [
{
"text": "Test Type"
}
]
}
}
],
"timestamp": "2021-06-17T20:33:22.422Z",
"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.Event.Order",
"EventType": "device-request-cancelled"
}
}Fields
Meta
Meta.DataModelString
ReliableRequiredFHIR.Event.Order
Meta.EventTypeString
ReliableRequireddevice-request-created
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.
Sample MessageDownload JSON Schema
{
"resourceType": "Bundle",
"id": "DeviceRequestCreatedFullBundleExample",
"type": "message",
"entry": [
{
"resource": {
"eventUri": "https://fhir.redoxengine.com/EventDefinition/DeviceRequestCreated",
"resourceType": "MessageHeader",
"id": "DeviceRequestCreatedMessageHeader",
"source": {
"name": "Good Health Clinics",
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
},
"focus": [
{
"reference": "DeviceRequest/RedoxDeviceRequestExample"
},
{
"reference": "Patient/RedoxPatientExampleTimothy"
}
],
"definition": "https://fhir.redoxengine.com/MessageDefinition/DeviceRequestCreatedFull"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/DeviceRequest?identifier=56789302|urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"resource": {
"resourceType": "DeviceRequest",
"id": "RedoxDeviceRequestExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "56789302"
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"encounter": {
"reference": "Encounter/RedoxEncounterExample"
},
"status": "completed",
"occurrenceDateTime": "1999-11-01T05:00:00.000Z",
"codeCodeableConcept": {
"coding": [
{
"code": "72506001",
"system": "http://snomed.info/sct",
"display": "Automatic implantable cardioverter/defibrillator"
}
]
},
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/devicerequest-quantity",
"valueString": "2"
}
],
"_intent": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "unsupported"
}
]
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=0000000001|urn:redox:MRN",
"resource": {
"resourceType": "Patient",
"id": "RedoxPatientExampleTimothy",
"meta": {
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
"valueInteger": 1
}
]
},
"extension": [
{
"extension": [
{
"url": "text",
"valueString": "White"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"code": "2135-2",
"system": "urn:oid:2.16.840.1.113883.6.238",
"display": "Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Hispanic"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:health-one:MR"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"name": [
{
"given": [
"Timothy",
"Paul"
],
"family": "Bixby",
"use": "official"
},
{
"text": "Billy",
"use": "usual"
}
],
"gender": "male",
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
},
{
"value": "+18008675309",
"system": "phone",
"use": "work"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": [
{
"line": [
"4762 Hickory Street"
],
"city": "Monroe",
"district": "Greene",
"state": "WI",
"postalCode": "53566",
"country": "US",
"use": "home"
}
],
"maritalStatus": {
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
],
"text": "English"
}
}
],
"contact": [
{
"name": {
"given": [
"Barbara"
],
"family": "Bixby"
},
"telecom": [
{
"value": "+18088675303",
"system": "phone",
"use": "home"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": {
"line": [
"4762 Hickory St."
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "USA"
},
"relationship": [
{
"coding": [
{
"code": "MTH",
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"display": "mother"
}
],
"text": "Mother"
},
{
"coding": [
{
"code": "C",
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
"display": "Emergency Contact"
}
],
"text": "Emergency Contact"
}
]
}
],
"generalPractitioner": [
{
"reference": "Practitioner/RedoxPractitionerExamplePat"
}
],
"managingOrganization": {
"reference": "Organization/RedoxOrganizationManagingExample"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=zzz123Encounter|urn:redox:encounterId",
"resource": {
"resourceType": "Encounter",
"id": "RedoxEncounterExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
"value": "9601346482"
}
],
"status": "finished",
"class": {
"code": "IMP",
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"display": "inpatient encounter"
},
"type": [
{
"coding": [
{
"code": "99222",
"system": "http://www.ama-assn.org/go/cpt",
"display": "InPatient Admission"
}
]
}
],
"diagnosis": [
{
"condition": {
"reference": "Condition/RedoxConditionExampleEncounterDx"
}
}
],
"participant": [
{
"individual": {
"reference": "Practitioner/RedoxPractitionerExampleEncounter"
}
}
],
"location": [
{
"location": {
"reference": "Location/RedoxLocationExampleEncounter"
}
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"period": {
"start": "2022-02-06T04:00:00.000Z",
"end": "2022-02-06T04:15:00.000Z"
},
"length": {
"value": 16,
"code": "m",
"system": "http://unitsofmeasure.org"
},
"reasonCode": [
{
"coding": [
{
"code": "23360407",
"system": "http://snomed.info/sct"
}
],
"text": "Pneumonia"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExamplePat",
"resource": {
"resourceType": "Practitioner",
"id": "RedoxPractitionerExamplePat",
"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"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationManagingExample",
"resource": {
"resourceType": "Organization",
"id": "RedoxOrganizationManagingExample",
"identifier": [
{
"value": "1234",
"system": "urn:oid:1.2.3.4"
}
],
"active": true,
"name": "Custodial Org",
"address": [
{
"line": [
"123 Main St"
],
"city": "Madison",
"state": "WI"
}
],
"telecom": [
{
"value": "1-800-123-4567",
"system": "phone"
}
],
"type": [
{
"text": "Test Type"
}
]
}
}
],
"timestamp": "2021-06-17T20:33:22.422Z",
"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.Event.Order",
"EventType": "device-request-created"
}
}Fields
Meta
Meta.DataModelString
ReliableRequiredFHIR.Event.Order
Meta.EventTypeString
ReliableRequireddevice-request-updated
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.
Sample MessageDownload JSON Schema
{
"resourceType": "Bundle",
"id": "DeviceRequestUpdatedFullBundleExample",
"type": "message",
"entry": [
{
"resource": {
"eventUri": "https://fhir.redoxengine.com/EventDefinition/DeviceRequestUpdated",
"resourceType": "MessageHeader",
"id": "DeviceRequestUpdatedMessageHeader",
"source": {
"name": "Good Health Clinics",
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
},
"focus": [
{
"reference": "DeviceRequest/RedoxDeviceRequestExample"
},
{
"reference": "Patient/RedoxPatientExampleTimothy"
}
],
"definition": "https://fhir.redoxengine.com/MessageDefinition/DeviceRequestUpdatedFull"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/DeviceRequest?identifier=56789302|urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"resource": {
"resourceType": "DeviceRequest",
"id": "RedoxDeviceRequestExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "56789302"
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"encounter": {
"reference": "Encounter/RedoxEncounterExample"
},
"status": "completed",
"occurrenceDateTime": "1999-11-01T05:00:00.000Z",
"codeCodeableConcept": {
"coding": [
{
"code": "72506001",
"system": "http://snomed.info/sct",
"display": "Automatic implantable cardioverter/defibrillator"
}
]
},
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/devicerequest-quantity",
"valueString": "2"
}
],
"_intent": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "unsupported"
}
]
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=0000000001|urn:redox:MRN",
"resource": {
"resourceType": "Patient",
"id": "RedoxPatientExampleTimothy",
"meta": {
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
"valueInteger": 1
}
]
},
"extension": [
{
"extension": [
{
"url": "text",
"valueString": "White"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"code": "2135-2",
"system": "urn:oid:2.16.840.1.113883.6.238",
"display": "Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Hispanic"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:health-one:MR"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"name": [
{
"given": [
"Timothy",
"Paul"
],
"family": "Bixby",
"use": "official"
},
{
"text": "Billy",
"use": "usual"
}
],
"gender": "male",
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
},
{
"value": "+18008675309",
"system": "phone",
"use": "work"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": [
{
"line": [
"4762 Hickory Street"
],
"city": "Monroe",
"district": "Greene",
"state": "WI",
"postalCode": "53566",
"country": "US",
"use": "home"
}
],
"maritalStatus": {
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
],
"text": "English"
}
}
],
"contact": [
{
"name": {
"given": [
"Barbara"
],
"family": "Bixby"
},
"telecom": [
{
"value": "+18088675303",
"system": "phone",
"use": "home"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": {
"line": [
"4762 Hickory St."
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "USA"
},
"relationship": [
{
"coding": [
{
"code": "MTH",
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"display": "mother"
}
],
"text": "Mother"
},
{
"coding": [
{
"code": "C",
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
"display": "Emergency Contact"
}
],
"text": "Emergency Contact"
}
]
}
],
"generalPractitioner": [
{
"reference": "Practitioner/RedoxPractitionerExamplePat"
}
],
"managingOrganization": {
"reference": "Organization/RedoxOrganizationManagingExample"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=zzz123Encounter|urn:redox:encounterId",
"resource": {
"resourceType": "Encounter",
"id": "RedoxEncounterExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
"value": "9601346482"
}
],
"status": "finished",
"class": {
"code": "IMP",
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"display": "inpatient encounter"
},
"type": [
{
"coding": [
{
"code": "99222",
"system": "http://www.ama-assn.org/go/cpt",
"display": "InPatient Admission"
}
]
}
],
"diagnosis": [
{
"condition": {
"reference": "Condition/RedoxConditionExampleEncounterDx"
}
}
],
"participant": [
{
"individual": {
"reference": "Practitioner/RedoxPractitionerExampleEncounter"
}
}
],
"location": [
{
"location": {
"reference": "Location/RedoxLocationExampleEncounter"
}
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"period": {
"start": "2022-02-06T04:00:00.000Z",
"end": "2022-02-06T04:15:00.000Z"
},
"length": {
"value": 16,
"code": "m",
"system": "http://unitsofmeasure.org"
},
"reasonCode": [
{
"coding": [
{
"code": "23360407",
"system": "http://snomed.info/sct"
}
],
"text": "Pneumonia"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExamplePat",
"resource": {
"resourceType": "Practitioner",
"id": "RedoxPractitionerExamplePat",
"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"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationManagingExample",
"resource": {
"resourceType": "Organization",
"id": "RedoxOrganizationManagingExample",
"identifier": [
{
"value": "1234",
"system": "urn:oid:1.2.3.4"
}
],
"active": true,
"name": "Custodial Org",
"address": [
{
"line": [
"123 Main St"
],
"city": "Madison",
"state": "WI"
}
],
"telecom": [
{
"value": "1-800-123-4567",
"system": "phone"
}
],
"type": [
{
"text": "Test Type"
}
]
}
}
],
"timestamp": "2021-06-17T20:33:22.422Z",
"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.Event.Order",
"EventType": "device-request-updated"
}
}Fields
Meta
Meta.DataModelString
ReliableRequiredFHIR.Event.Order
Meta.EventTypeString
ReliableRequiredmedication-request-cancelled
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.
Sample MessageDownload JSON Schema
{
"resourceType": "Bundle",
"id": "MedicationRequestCancelledFullBundleExample",
"type": "message",
"entry": [
{
"resource": {
"eventUri": "https://fhir.redoxengine.com/EventDefinition/MedicationRequestCancelled",
"resourceType": "MessageHeader",
"id": "MedicationRequestCancelledMessageHeader",
"source": {
"name": "Good Health Clinics",
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
},
"focus": [
{
"reference": "MedicationRequest/RedoxMedicationRequestExample"
},
{
"reference": "Patient/RedoxPatientExampleTimothy"
}
],
"definition": "https://fhir.redoxengine.com/MessageDefinition/MedicationRequestCancelledFull"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/MedicationRequest?identifier=06dc94e9-ce21-4ad6-89b7-bfb51154bbd6|urn:redox:example:MedOrderID",
"resource": {
"resourceType": "MedicationRequest",
"id": "RedoxMedicationRequestExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "865492246"
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"intent": "order",
"encounter": {
"reference": "Encounter/RedoxEncompassingEncounterExample"
},
"medicationCodeableConcept": {
"coding": [
{
"code": "104894",
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"display": "Ondansetron 4 Mg Po Tbdp"
}
],
"text": "Ondansetron 4 Mg Po Tbdp"
},
"dispenseRequest": {
"quantity": {
"value": 30,
"unit": "tablet"
},
"numberOfRepeatsAllowed": 0,
"validityPeriod": {
"start": "2019-04-01T00:00:00.000Z",
"end": "2019-05-31T00:00:00.000Z"
},
"performer": {
"reference": "Organization/RedoxOrganizationPharmacyExample"
}
},
"status": "active",
"priority": "routine",
"reasonCode": [
{
"coding": [
{
"code": "422587007",
"system": "http://snomed.info/sct"
}
],
"text": "Nausea"
}
],
"authoredOn": "2019-04-01T17:04:16.605Z",
"requester": {
"reference": "PractitionerRole/RedoxPAPractitionerRoleExamplePat"
},
"recorder": {
"reference": "Practitioner/RedoxPractitionerExampleMedicationRequest"
},
"dosageInstruction": [
{
"text": "one tablet every 8 hours",
"asNeededBoolean": false,
"route": {
"coding": [
{
"code": "C38288",
"system": "urn:oid:2.16.840.1.113883.3.26.1.1",
"display": "Oral"
}
]
},
"doseAndRate": [
{
"doseQuantity": {
"value": 4,
"unit": "mg"
}
}
],
"timing": {
"repeat": {
"frequency": 1,
"period": 8,
"periodUnit": "h",
"boundsPeriod": {
"start": "2013-11-11T05:00:00.000Z"
}
}
}
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=0000000001|urn:redox:MRN",
"resource": {
"resourceType": "Patient",
"id": "RedoxPatientExampleTimothy",
"meta": {
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
"valueInteger": 1
}
]
},
"extension": [
{
"extension": [
{
"url": "text",
"valueString": "White"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"code": "2135-2",
"system": "urn:oid:2.16.840.1.113883.6.238",
"display": "Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Hispanic"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:health-one:MR"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"name": [
{
"given": [
"Timothy",
"Paul"
],
"family": "Bixby",
"use": "official"
},
{
"text": "Billy",
"use": "usual"
}
],
"gender": "male",
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
},
{
"value": "+18008675309",
"system": "phone",
"use": "work"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": [
{
"line": [
"4762 Hickory Street"
],
"city": "Monroe",
"district": "Greene",
"state": "WI",
"postalCode": "53566",
"country": "US",
"use": "home"
}
],
"maritalStatus": {
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
],
"text": "English"
}
}
],
"contact": [
{
"name": {
"given": [
"Barbara"
],
"family": "Bixby"
},
"telecom": [
{
"value": "+18088675303",
"system": "phone",
"use": "home"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": {
"line": [
"4762 Hickory St."
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "USA"
},
"relationship": [
{
"coding": [
{
"code": "MTH",
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"display": "mother"
}
],
"text": "Mother"
},
{
"coding": [
{
"code": "C",
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
"display": "Emergency Contact"
}
],
"text": "Emergency Contact"
}
]
}
],
"generalPractitioner": [
{
"reference": "Practitioner/RedoxPractitionerExamplePat"
}
],
"managingOrganization": {
"reference": "Organization/RedoxOrganizationManagingExample"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=6425784126|urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
"resource": {
"resourceType": "Encounter",
"id": "RedoxEncompassingEncounterExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
"value": "6425784126"
}
],
"status": "finished",
"class": {
"code": "IMP",
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"display": "inpatient encounter"
},
"type": [
{
"coding": [
{
"code": "99222",
"system": "http://www.ama-assn.org/go/cpt",
"display": "InPatient Admission"
}
]
}
],
"period": {
"start": "2022-02-02T15:17:55.221Z",
"end": "2022-02-02T15:17:55.221Z"
},
"location": [
{
"location": {
"reference": "Location/RedoxLocationExampleFacility"
}
},
{
"location": {
"reference": "Location/RedoxLocationExampleDepartment"
}
},
{
"location": {
"reference": "Location/RedoxLocationExampleRoom"
}
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationPharmacyExample",
"resource": {
"resourceType": "Organization",
"id": "RedoxOrganizationPharmacyExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "4861304611"
},
{
"system": "http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber",
"value": "1234567"
}
],
"active": true,
"name": "Fake Pharmacy",
"type": [
{
"text": "Pharmacy",
"coding": [
{
"code": "PHARM",
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"display": "Pharmacy"
}
]
}
],
"address": [
{
"line": [
"123 Fake St."
],
"city": "Madison",
"district": "Dane",
"state": "WI",
"postalCode": "53703",
"country": "USA"
}
],
"telecom": [
{
"value": "+16085556789",
"system": "phone",
"use": "work"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExampleMedicationRequest",
"resource": {
"resourceType": "Practitioner",
"id": "RedoxPractitionerExampleMedicationRequest",
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "3459132305"
},
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698077",
"value": "4890215231"
}
],
"name": [
{
"given": [
"Aaheli"
],
"family": "Ghoshal"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/PractitionerRole/RedoxPAPractitionerRoleExamplePat",
"resource": {
"resourceType": "PractitionerRole",
"id": "RedoxPAPractitionerRoleExamplePat",
"practitioner": {
"reference": "Practitioner/RedoxPAPractitionerExamplePat"
},
"organization": {
"reference": "Organization/RedoxPARequestorOrganizationExample"
},
"location": [
{
"display": "1st Street Family Clinic"
}
],
"specialty": [
{
"coding": [
{
"code": "394579002",
"system": "http://snomed.info/sct",
"display": "Cardiology"
}
]
}
]
}
}
],
"timestamp": "2021-06-17T20:33:22.422Z",
"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.Event.Order",
"EventType": "medication-request-cancelled"
}
}Fields
Meta
Meta.DataModelString
ReliableRequiredFHIR.Event.Order
Meta.EventTypeString
ReliableRequiredmedication-request-created
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.
Sample MessageDownload JSON Schema
{
"resourceType": "Bundle",
"id": "MedicationRequestCreatedFullBundleExample",
"type": "message",
"entry": [
{
"resource": {
"eventUri": "https://fhir.redoxengine.com/EventDefinition/MedicationRequestCreated",
"resourceType": "MessageHeader",
"id": "MedicationRequestCreatedMessageHeader",
"source": {
"name": "Good Health Clinics",
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
},
"focus": [
{
"reference": "MedicationRequest/RedoxMedicationRequestExample"
},
{
"reference": "Patient/RedoxPatientExampleTimothy"
}
],
"definition": "https://fhir.redoxengine.com/MessageDefinition/MedicationRequestCreatedFull"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/MedicationRequest?identifier=06dc94e9-ce21-4ad6-89b7-bfb51154bbd6|urn:redox:example:MedOrderID",
"resource": {
"resourceType": "MedicationRequest",
"id": "RedoxMedicationRequestExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "865492246"
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"intent": "order",
"encounter": {
"reference": "Encounter/RedoxEncompassingEncounterExample"
},
"medicationCodeableConcept": {
"coding": [
{
"code": "104894",
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"display": "Ondansetron 4 Mg Po Tbdp"
}
],
"text": "Ondansetron 4 Mg Po Tbdp"
},
"dispenseRequest": {
"quantity": {
"value": 30,
"unit": "tablet"
},
"numberOfRepeatsAllowed": 0,
"validityPeriod": {
"start": "2019-04-01T00:00:00.000Z",
"end": "2019-05-31T00:00:00.000Z"
},
"performer": {
"reference": "Organization/RedoxOrganizationPharmacyExample"
}
},
"status": "active",
"priority": "routine",
"reasonCode": [
{
"coding": [
{
"code": "422587007",
"system": "http://snomed.info/sct"
}
],
"text": "Nausea"
}
],
"authoredOn": "2019-04-01T17:04:16.605Z",
"requester": {
"reference": "PractitionerRole/RedoxPAPractitionerRoleExamplePat"
},
"recorder": {
"reference": "Practitioner/RedoxPractitionerExampleMedicationRequest"
},
"dosageInstruction": [
{
"text": "one tablet every 8 hours",
"asNeededBoolean": false,
"route": {
"coding": [
{
"code": "C38288",
"system": "urn:oid:2.16.840.1.113883.3.26.1.1",
"display": "Oral"
}
]
},
"doseAndRate": [
{
"doseQuantity": {
"value": 4,
"unit": "mg"
}
}
],
"timing": {
"repeat": {
"frequency": 1,
"period": 8,
"periodUnit": "h",
"boundsPeriod": {
"start": "2013-11-11T05:00:00.000Z"
}
}
}
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=0000000001|urn:redox:MRN",
"resource": {
"resourceType": "Patient",
"id": "RedoxPatientExampleTimothy",
"meta": {
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
"valueInteger": 1
}
]
},
"extension": [
{
"extension": [
{
"url": "text",
"valueString": "White"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"code": "2135-2",
"system": "urn:oid:2.16.840.1.113883.6.238",
"display": "Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Hispanic"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:health-one:MR"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"name": [
{
"given": [
"Timothy",
"Paul"
],
"family": "Bixby",
"use": "official"
},
{
"text": "Billy",
"use": "usual"
}
],
"gender": "male",
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
},
{
"value": "+18008675309",
"system": "phone",
"use": "work"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": [
{
"line": [
"4762 Hickory Street"
],
"city": "Monroe",
"district": "Greene",
"state": "WI",
"postalCode": "53566",
"country": "US",
"use": "home"
}
],
"maritalStatus": {
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
],
"text": "English"
}
}
],
"contact": [
{
"name": {
"given": [
"Barbara"
],
"family": "Bixby"
},
"telecom": [
{
"value": "+18088675303",
"system": "phone",
"use": "home"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": {
"line": [
"4762 Hickory St."
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "USA"
},
"relationship": [
{
"coding": [
{
"code": "MTH",
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"display": "mother"
}
],
"text": "Mother"
},
{
"coding": [
{
"code": "C",
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
"display": "Emergency Contact"
}
],
"text": "Emergency Contact"
}
]
}
],
"generalPractitioner": [
{
"reference": "Practitioner/RedoxPractitionerExamplePat"
}
],
"managingOrganization": {
"reference": "Organization/RedoxOrganizationManagingExample"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=6425784126|urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
"resource": {
"resourceType": "Encounter",
"id": "RedoxEncompassingEncounterExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
"value": "6425784126"
}
],
"status": "finished",
"class": {
"code": "IMP",
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"display": "inpatient encounter"
},
"type": [
{
"coding": [
{
"code": "99222",
"system": "http://www.ama-assn.org/go/cpt",
"display": "InPatient Admission"
}
]
}
],
"period": {
"start": "2022-02-02T15:17:55.221Z",
"end": "2022-02-02T15:17:55.221Z"
},
"location": [
{
"location": {
"reference": "Location/RedoxLocationExampleFacility"
}
},
{
"location": {
"reference": "Location/RedoxLocationExampleDepartment"
}
},
{
"location": {
"reference": "Location/RedoxLocationExampleRoom"
}
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationPharmacyExample",
"resource": {
"resourceType": "Organization",
"id": "RedoxOrganizationPharmacyExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "4861304611"
},
{
"system": "http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber",
"value": "1234567"
}
],
"active": true,
"name": "Fake Pharmacy",
"type": [
{
"text": "Pharmacy",
"coding": [
{
"code": "PHARM",
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"display": "Pharmacy"
}
]
}
],
"address": [
{
"line": [
"123 Fake St."
],
"city": "Madison",
"district": "Dane",
"state": "WI",
"postalCode": "53703",
"country": "USA"
}
],
"telecom": [
{
"value": "+16085556789",
"system": "phone",
"use": "work"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExampleMedicationRequest",
"resource": {
"resourceType": "Practitioner",
"id": "RedoxPractitionerExampleMedicationRequest",
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "3459132305"
},
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698077",
"value": "4890215231"
}
],
"name": [
{
"given": [
"Aaheli"
],
"family": "Ghoshal"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/PractitionerRole/RedoxPAPractitionerRoleExamplePat",
"resource": {
"resourceType": "PractitionerRole",
"id": "RedoxPAPractitionerRoleExamplePat",
"practitioner": {
"reference": "Practitioner/RedoxPAPractitionerExamplePat"
},
"organization": {
"reference": "Organization/RedoxPARequestorOrganizationExample"
},
"location": [
{
"display": "1st Street Family Clinic"
}
],
"specialty": [
{
"coding": [
{
"code": "394579002",
"system": "http://snomed.info/sct",
"display": "Cardiology"
}
]
}
]
}
}
],
"timestamp": "2021-06-17T20:33:22.422Z",
"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.Event.Order",
"EventType": "medication-request-created"
}
}Fields
Meta
Meta.DataModelString
ReliableRequiredFHIR.Event.Order
Meta.EventTypeString
ReliableRequiredmedication-request-updated
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.
Sample MessageDownload JSON Schema
{
"resourceType": "Bundle",
"id": "MedicationRequestUpdatedFullBundleExample",
"type": "message",
"entry": [
{
"resource": {
"eventUri": "https://fhir.redoxengine.com/EventDefinition/MedicationRequestUpdated",
"resourceType": "MessageHeader",
"id": "MedicationRequestUpdatedMessageHeader",
"source": {
"name": "Good Health Clinics",
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
},
"focus": [
{
"reference": "MedicationRequest/RedoxMedicationRequestExample"
},
{
"reference": "Patient/RedoxPatientExampleTimothy"
}
],
"definition": "https://fhir.redoxengine.com/MessageDefinition/MedicationRequestUpdatedFull"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/MedicationRequest?identifier=06dc94e9-ce21-4ad6-89b7-bfb51154bbd6|urn:redox:example:MedOrderID",
"resource": {
"resourceType": "MedicationRequest",
"id": "RedoxMedicationRequestExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "865492246"
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"intent": "order",
"encounter": {
"reference": "Encounter/RedoxEncompassingEncounterExample"
},
"medicationCodeableConcept": {
"coding": [
{
"code": "104894",
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"display": "Ondansetron 4 Mg Po Tbdp"
}
],
"text": "Ondansetron 4 Mg Po Tbdp"
},
"dispenseRequest": {
"quantity": {
"value": 30,
"unit": "tablet"
},
"numberOfRepeatsAllowed": 0,
"validityPeriod": {
"start": "2019-04-01T00:00:00.000Z",
"end": "2019-05-31T00:00:00.000Z"
},
"performer": {
"reference": "Organization/RedoxOrganizationPharmacyExample"
}
},
"status": "active",
"priority": "routine",
"reasonCode": [
{
"coding": [
{
"code": "422587007",
"system": "http://snomed.info/sct"
}
],
"text": "Nausea"
}
],
"authoredOn": "2019-04-01T17:04:16.605Z",
"requester": {
"reference": "PractitionerRole/RedoxPAPractitionerRoleExamplePat"
},
"recorder": {
"reference": "Practitioner/RedoxPractitionerExampleMedicationRequest"
},
"dosageInstruction": [
{
"text": "one tablet every 8 hours",
"asNeededBoolean": false,
"route": {
"coding": [
{
"code": "C38288",
"system": "urn:oid:2.16.840.1.113883.3.26.1.1",
"display": "Oral"
}
]
},
"doseAndRate": [
{
"doseQuantity": {
"value": 4,
"unit": "mg"
}
}
],
"timing": {
"repeat": {
"frequency": 1,
"period": 8,
"periodUnit": "h",
"boundsPeriod": {
"start": "2013-11-11T05:00:00.000Z"
}
}
}
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=0000000001|urn:redox:MRN",
"resource": {
"resourceType": "Patient",
"id": "RedoxPatientExampleTimothy",
"meta": {
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
"valueInteger": 1
}
]
},
"extension": [
{
"extension": [
{
"url": "text",
"valueString": "White"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"code": "2135-2",
"system": "urn:oid:2.16.840.1.113883.6.238",
"display": "Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Hispanic"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:health-one:MR"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"name": [
{
"given": [
"Timothy",
"Paul"
],
"family": "Bixby",
"use": "official"
},
{
"text": "Billy",
"use": "usual"
}
],
"gender": "male",
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
},
{
"value": "+18008675309",
"system": "phone",
"use": "work"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": [
{
"line": [
"4762 Hickory Street"
],
"city": "Monroe",
"district": "Greene",
"state": "WI",
"postalCode": "53566",
"country": "US",
"use": "home"
}
],
"maritalStatus": {
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
],
"text": "English"
}
}
],
"contact": [
{
"name": {
"given": [
"Barbara"
],
"family": "Bixby"
},
"telecom": [
{
"value": "+18088675303",
"system": "phone",
"use": "home"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": {
"line": [
"4762 Hickory St."
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "USA"
},
"relationship": [
{
"coding": [
{
"code": "MTH",
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"display": "mother"
}
],
"text": "Mother"
},
{
"coding": [
{
"code": "C",
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
"display": "Emergency Contact"
}
],
"text": "Emergency Contact"
}
]
}
],
"generalPractitioner": [
{
"reference": "Practitioner/RedoxPractitionerExamplePat"
}
],
"managingOrganization": {
"reference": "Organization/RedoxOrganizationManagingExample"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=6425784126|urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
"resource": {
"resourceType": "Encounter",
"id": "RedoxEncompassingEncounterExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
"value": "6425784126"
}
],
"status": "finished",
"class": {
"code": "IMP",
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"display": "inpatient encounter"
},
"type": [
{
"coding": [
{
"code": "99222",
"system": "http://www.ama-assn.org/go/cpt",
"display": "InPatient Admission"
}
]
}
],
"period": {
"start": "2022-02-02T15:17:55.221Z",
"end": "2022-02-02T15:17:55.221Z"
},
"location": [
{
"location": {
"reference": "Location/RedoxLocationExampleFacility"
}
},
{
"location": {
"reference": "Location/RedoxLocationExampleDepartment"
}
},
{
"location": {
"reference": "Location/RedoxLocationExampleRoom"
}
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationPharmacyExample",
"resource": {
"resourceType": "Organization",
"id": "RedoxOrganizationPharmacyExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "4861304611"
},
{
"system": "http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber",
"value": "1234567"
}
],
"active": true,
"name": "Fake Pharmacy",
"type": [
{
"text": "Pharmacy",
"coding": [
{
"code": "PHARM",
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"display": "Pharmacy"
}
]
}
],
"address": [
{
"line": [
"123 Fake St."
],
"city": "Madison",
"district": "Dane",
"state": "WI",
"postalCode": "53703",
"country": "USA"
}
],
"telecom": [
{
"value": "+16085556789",
"system": "phone",
"use": "work"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExampleMedicationRequest",
"resource": {
"resourceType": "Practitioner",
"id": "RedoxPractitionerExampleMedicationRequest",
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "3459132305"
},
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698077",
"value": "4890215231"
}
],
"name": [
{
"given": [
"Aaheli"
],
"family": "Ghoshal"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/PractitionerRole/RedoxPAPractitionerRoleExamplePat",
"resource": {
"resourceType": "PractitionerRole",
"id": "RedoxPAPractitionerRoleExamplePat",
"practitioner": {
"reference": "Practitioner/RedoxPAPractitionerExamplePat"
},
"organization": {
"reference": "Organization/RedoxPARequestorOrganizationExample"
},
"location": [
{
"display": "1st Street Family Clinic"
}
],
"specialty": [
{
"coding": [
{
"code": "394579002",
"system": "http://snomed.info/sct",
"display": "Cardiology"
}
]
}
]
}
}
],
"timestamp": "2021-06-17T20:33:22.422Z",
"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.Event.Order",
"EventType": "medication-request-updated"
}
}Fields
Meta
Meta.DataModelString
ReliableRequiredFHIR.Event.Order
Meta.EventTypeString
ReliableRequiredservice-request-cancelled
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.
Sample MessageDownload JSON Schema
{
"resourceType": "Bundle",
"id": "ServiceRequestCancelledFullBundleExample",
"type": "message",
"entry": [
{
"resource": {
"eventUri": "https://fhir.redoxengine.com/EventDefinition/ServiceRequestCancelled",
"resourceType": "MessageHeader",
"id": "ServiceRequestCancelledMessageHeader",
"source": {
"name": "Good Health Clinics",
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
},
"focus": [
{
"reference": "ServiceRequest/RedoxServiceRequestOrderExample"
},
{
"reference": "Patient/RedoxPatientExampleTimothy"
}
],
"definition": "https://fhir.redoxengine.com/MessageDefinition/ServiceRequestCancelledFull"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/ServiceRequest?identifier=6547891230|urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"resource": {
"resourceType": "ServiceRequest",
"id": "RedoxServiceRequestOrderExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "6547891230"
}
],
"intent": "order",
"priority": "stat",
"status": "active",
"code": {
"coding": [
{
"code": "49086-2",
"system": "http://loinc.org",
"display": "First trimester maternal screen with nuchal translucency panel"
}
]
},
"authoredOn": "2022-08-08T08:00:00.000Z",
"note": [
{
"text": "Additional information"
}
],
"reasonReference": [
{
"reference": "DocumentReference/RedoxDocumentReferenceExampleMediaTimothy"
}
],
"supportingInfo": [
{
"reference": "Observation/RedoxPlateletObservationExample"
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"requester": {
"reference": "Practitioner/RedoxPractitionerExamplePat"
},
"performer": [
{
"reference": "Practitioner/RedoxPractitionerExampleJoan"
}
],
"specimen": [
{
"reference": "Specimen/RedoxSpecimenExample"
}
],
"encounter": {
"reference": "Encounter/RedoxEncounterExample"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=0000000001|urn:redox:MRN",
"resource": {
"resourceType": "Patient",
"id": "RedoxPatientExampleTimothy",
"meta": {
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
"valueInteger": 1
}
]
},
"extension": [
{
"extension": [
{
"url": "text",
"valueString": "White"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"code": "2135-2",
"system": "urn:oid:2.16.840.1.113883.6.238",
"display": "Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Hispanic"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:health-one:MR"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"name": [
{
"given": [
"Timothy",
"Paul"
],
"family": "Bixby",
"use": "official"
},
{
"text": "Billy",
"use": "usual"
}
],
"gender": "male",
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
},
{
"value": "+18008675309",
"system": "phone",
"use": "work"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": [
{
"line": [
"4762 Hickory Street"
],
"city": "Monroe",
"district": "Greene",
"state": "WI",
"postalCode": "53566",
"country": "US",
"use": "home"
}
],
"maritalStatus": {
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
],
"text": "English"
}
}
],
"contact": [
{
"name": {
"given": [
"Barbara"
],
"family": "Bixby"
},
"telecom": [
{
"value": "+18088675303",
"system": "phone",
"use": "home"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": {
"line": [
"4762 Hickory St."
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "USA"
},
"relationship": [
{
"coding": [
{
"code": "MTH",
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"display": "mother"
}
],
"text": "Mother"
},
{
"coding": [
{
"code": "C",
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
"display": "Emergency Contact"
}
],
"text": "Emergency Contact"
}
]
}
],
"generalPractitioner": [
{
"reference": "Practitioner/RedoxPractitionerExamplePat"
}
],
"managingOrganization": {
"reference": "Organization/RedoxOrganizationManagingExample"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=zzz123Encounter|urn:redox:encounterId",
"resource": {
"resourceType": "Encounter",
"id": "RedoxEncounterExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
"value": "9601346482"
}
],
"status": "finished",
"class": {
"code": "IMP",
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"display": "inpatient encounter"
},
"type": [
{
"coding": [
{
"code": "99222",
"system": "http://www.ama-assn.org/go/cpt",
"display": "InPatient Admission"
}
]
}
],
"diagnosis": [
{
"condition": {
"reference": "Condition/RedoxConditionExampleEncounterDx"
}
}
],
"participant": [
{
"individual": {
"reference": "Practitioner/RedoxPractitionerExampleEncounter"
}
}
],
"location": [
{
"location": {
"reference": "Location/RedoxLocationExampleEncounter"
}
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"period": {
"start": "2022-02-06T04:00:00.000Z",
"end": "2022-02-06T04:15:00.000Z"
},
"length": {
"value": 16,
"code": "m",
"system": "http://unitsofmeasure.org"
},
"reasonCode": [
{
"coding": [
{
"code": "23360407",
"system": "http://snomed.info/sct"
}
],
"text": "Pneumonia"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExamplePat",
"resource": {
"resourceType": "Practitioner",
"id": "RedoxPractitionerExamplePat",
"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"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExampleJoan",
"resource": {
"resourceType": "Practitioner",
"id": "RedoxPractitionerExampleJoan",
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "4336749876"
}
],
"name": [
{
"given": [
"Joan"
],
"family": "Fishman"
}
],
"address": [
{
"line": [
"4762 Hickory St."
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "USA"
}
],
"telecom": [
{
"value": "+16085558899"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationManagingExample",
"resource": {
"resourceType": "Organization",
"id": "RedoxOrganizationManagingExample",
"identifier": [
{
"value": "1234",
"system": "urn:oid:1.2.3.4"
}
],
"active": true,
"name": "Custodial Org",
"address": [
{
"line": [
"123 Main St"
],
"city": "Madison",
"state": "WI"
}
],
"telecom": [
{
"value": "1-800-123-4567",
"system": "phone"
}
],
"type": [
{
"text": "Test Type"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/DocumentReference?identifier=129.6.58.92.88336|urn:redox:test:media",
"resource": {
"resourceType": "DocumentReference",
"id": "RedoxDocumentReferenceExampleMediaTimothy",
"masterIdentifier": {
"value": "129.6.58.92.88336",
"system": "urn:redox:test:media",
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/identifier-origin",
"valueString": "RedoxApi"
}
]
},
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"status": "current",
"description": "Test Description",
"type": {
"text": "Empty File"
},
"category": [
{
"coding": [
{
"system": "urn:redox:document_kind",
"code": "Media"
}
]
}
],
"context": {
"period": {
"start": "2015-05-06T06:00:58.872Z"
}
},
"content": [
{
"attachment": {
"data": "PC4uLmJhc2UgNjQgZmlsZSBjb250ZW50cy4uLj4=",
"contentType": "application/pdf",
"title": "SamplePDF-Order Specific Media"
}
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Observation?identifier=4910481243|urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"resource": {
"resourceType": "Observation",
"id": "RedoxPlateletObservationExample",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "laboratory"
}
]
}
],
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "4910481243"
}
],
"status": "final",
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"basedOn": [
{
"reference": "ServiceRequest/RedoxServiceRequestOrderExample"
}
],
"code": {
"coding": [
{
"code": "26515-7",
"system": "http://loinc.org"
}
],
"text": "Platelets"
},
"specimen": {
"reference": "Specimen/RedoxSpecimenExample"
},
"issued": "2022-02-16T17:26:19.778Z",
"valueQuantity": {
"value": 201,
"unit": "10+3/ul"
},
"note": [
{
"text": "An observation result note"
}
],
"interpretation": [
{
"coding": [
{
"code": "N",
"system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
"display": "Normal"
}
]
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Specimen?identifier=123|urn:redox:example:SpecimenID",
"resource": {
"resourceType": "Specimen",
"id": "RedoxSpecimenExample",
"identifier": [
{
"system": "urn:redox:example:SpecimenID",
"value": "123"
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"type": {
"coding": [
{
"code": "WB",
"system": "http://terminology.hl7.org/CodeSystem/v2-0487",
"display": "Blood, Whole"
}
],
"text": "Blood, Whole"
},
"collection": {
"bodySite": {
"text": "Left arm"
},
"collectedDateTime": "2022-02-14T19:20:02.762Z"
}
}
}
],
"timestamp": "2021-06-17T20:33:22.422Z",
"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.Event.Order",
"EventType": "service-request-cancelled"
}
}Fields
Meta
Meta.DataModelString
ReliableRequiredFHIR.Event.Order
Meta.EventTypeString
ReliableRequiredservice-request-created
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.
Sample MessageDownload JSON Schema
{
"resourceType": "Bundle",
"id": "ServiceRequestCreatedFullBundleExample",
"type": "message",
"entry": [
{
"resource": {
"eventUri": "https://fhir.redoxengine.com/EventDefinition/ServiceRequestCreated",
"resourceType": "MessageHeader",
"id": "ServiceRequestCreatedMessageHeader",
"source": {
"name": "Good Health Clinics",
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
},
"focus": [
{
"reference": "ServiceRequest/RedoxServiceRequestOrderExample"
},
{
"reference": "Patient/RedoxPatientExampleTimothy"
}
],
"definition": "https://fhir.redoxengine.com/MessageDefinition/ServiceRequestCreatedFull"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/ServiceRequest?identifier=6547891230|urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"resource": {
"resourceType": "ServiceRequest",
"id": "RedoxServiceRequestOrderExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "6547891230"
}
],
"intent": "order",
"priority": "stat",
"status": "active",
"code": {
"coding": [
{
"code": "49086-2",
"system": "http://loinc.org",
"display": "First trimester maternal screen with nuchal translucency panel"
}
]
},
"authoredOn": "2022-08-08T08:00:00.000Z",
"note": [
{
"text": "Additional information"
}
],
"reasonReference": [
{
"reference": "DocumentReference/RedoxDocumentReferenceExampleMediaTimothy"
}
],
"supportingInfo": [
{
"reference": "Observation/RedoxPlateletObservationExample"
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"requester": {
"reference": "Practitioner/RedoxPractitionerExamplePat"
},
"performer": [
{
"reference": "Practitioner/RedoxPractitionerExampleJoan"
}
],
"specimen": [
{
"reference": "Specimen/RedoxSpecimenExample"
}
],
"encounter": {
"reference": "Encounter/RedoxEncounterExample"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=0000000001|urn:redox:MRN",
"resource": {
"resourceType": "Patient",
"id": "RedoxPatientExampleTimothy",
"meta": {
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
"valueInteger": 1
}
]
},
"extension": [
{
"extension": [
{
"url": "text",
"valueString": "White"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"code": "2135-2",
"system": "urn:oid:2.16.840.1.113883.6.238",
"display": "Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Hispanic"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:health-one:MR"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"name": [
{
"given": [
"Timothy",
"Paul"
],
"family": "Bixby",
"use": "official"
},
{
"text": "Billy",
"use": "usual"
}
],
"gender": "male",
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
},
{
"value": "+18008675309",
"system": "phone",
"use": "work"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": [
{
"line": [
"4762 Hickory Street"
],
"city": "Monroe",
"district": "Greene",
"state": "WI",
"postalCode": "53566",
"country": "US",
"use": "home"
}
],
"maritalStatus": {
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
],
"text": "English"
}
}
],
"contact": [
{
"name": {
"given": [
"Barbara"
],
"family": "Bixby"
},
"telecom": [
{
"value": "+18088675303",
"system": "phone",
"use": "home"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": {
"line": [
"4762 Hickory St."
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "USA"
},
"relationship": [
{
"coding": [
{
"code": "MTH",
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"display": "mother"
}
],
"text": "Mother"
},
{
"coding": [
{
"code": "C",
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
"display": "Emergency Contact"
}
],
"text": "Emergency Contact"
}
]
}
],
"generalPractitioner": [
{
"reference": "Practitioner/RedoxPractitionerExamplePat"
}
],
"managingOrganization": {
"reference": "Organization/RedoxOrganizationManagingExample"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=zzz123Encounter|urn:redox:encounterId",
"resource": {
"resourceType": "Encounter",
"id": "RedoxEncounterExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
"value": "9601346482"
}
],
"status": "finished",
"class": {
"code": "IMP",
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"display": "inpatient encounter"
},
"type": [
{
"coding": [
{
"code": "99222",
"system": "http://www.ama-assn.org/go/cpt",
"display": "InPatient Admission"
}
]
}
],
"diagnosis": [
{
"condition": {
"reference": "Condition/RedoxConditionExampleEncounterDx"
}
}
],
"participant": [
{
"individual": {
"reference": "Practitioner/RedoxPractitionerExampleEncounter"
}
}
],
"location": [
{
"location": {
"reference": "Location/RedoxLocationExampleEncounter"
}
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"period": {
"start": "2022-02-06T04:00:00.000Z",
"end": "2022-02-06T04:15:00.000Z"
},
"length": {
"value": 16,
"code": "m",
"system": "http://unitsofmeasure.org"
},
"reasonCode": [
{
"coding": [
{
"code": "23360407",
"system": "http://snomed.info/sct"
}
],
"text": "Pneumonia"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExamplePat",
"resource": {
"resourceType": "Practitioner",
"id": "RedoxPractitionerExamplePat",
"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"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExampleJoan",
"resource": {
"resourceType": "Practitioner",
"id": "RedoxPractitionerExampleJoan",
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "4336749876"
}
],
"name": [
{
"given": [
"Joan"
],
"family": "Fishman"
}
],
"address": [
{
"line": [
"4762 Hickory St."
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "USA"
}
],
"telecom": [
{
"value": "+16085558899"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationManagingExample",
"resource": {
"resourceType": "Organization",
"id": "RedoxOrganizationManagingExample",
"identifier": [
{
"value": "1234",
"system": "urn:oid:1.2.3.4"
}
],
"active": true,
"name": "Custodial Org",
"address": [
{
"line": [
"123 Main St"
],
"city": "Madison",
"state": "WI"
}
],
"telecom": [
{
"value": "1-800-123-4567",
"system": "phone"
}
],
"type": [
{
"text": "Test Type"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/DocumentReference?identifier=129.6.58.92.88336|urn:redox:test:media",
"resource": {
"resourceType": "DocumentReference",
"id": "RedoxDocumentReferenceExampleMediaTimothy",
"masterIdentifier": {
"value": "129.6.58.92.88336",
"system": "urn:redox:test:media",
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/identifier-origin",
"valueString": "RedoxApi"
}
]
},
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"status": "current",
"description": "Test Description",
"type": {
"text": "Empty File"
},
"category": [
{
"coding": [
{
"system": "urn:redox:document_kind",
"code": "Media"
}
]
}
],
"context": {
"period": {
"start": "2015-05-06T06:00:58.872Z"
}
},
"content": [
{
"attachment": {
"data": "PC4uLmJhc2UgNjQgZmlsZSBjb250ZW50cy4uLj4=",
"contentType": "application/pdf",
"title": "SamplePDF-Order Specific Media"
}
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Observation?identifier=4910481243|urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"resource": {
"resourceType": "Observation",
"id": "RedoxPlateletObservationExample",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "laboratory"
}
]
}
],
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "4910481243"
}
],
"status": "final",
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"basedOn": [
{
"reference": "ServiceRequest/RedoxServiceRequestOrderExample"
}
],
"code": {
"coding": [
{
"code": "26515-7",
"system": "http://loinc.org"
}
],
"text": "Platelets"
},
"specimen": {
"reference": "Specimen/RedoxSpecimenExample"
},
"issued": "2022-02-16T17:26:19.778Z",
"valueQuantity": {
"value": 201,
"unit": "10+3/ul"
},
"note": [
{
"text": "An observation result note"
}
],
"interpretation": [
{
"coding": [
{
"code": "N",
"system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
"display": "Normal"
}
]
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Specimen?identifier=123|urn:redox:example:SpecimenID",
"resource": {
"resourceType": "Specimen",
"id": "RedoxSpecimenExample",
"identifier": [
{
"system": "urn:redox:example:SpecimenID",
"value": "123"
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"type": {
"coding": [
{
"code": "WB",
"system": "http://terminology.hl7.org/CodeSystem/v2-0487",
"display": "Blood, Whole"
}
],
"text": "Blood, Whole"
},
"collection": {
"bodySite": {
"text": "Left arm"
},
"collectedDateTime": "2022-02-14T19:20:02.762Z"
}
}
}
],
"timestamp": "2021-06-17T20:33:22.422Z",
"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.Event.Order",
"EventType": "service-request-created"
}
}Fields
Meta
Meta.DataModelString
ReliableRequiredFHIR.Event.Order
Meta.EventTypeString
ReliableRequiredservice-request-updated
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.
Sample MessageDownload JSON Schema
{
"resourceType": "Bundle",
"id": "ServiceRequestUpdatedFullBundleExample",
"type": "message",
"entry": [
{
"resource": {
"eventUri": "https://fhir.redoxengine.com/EventDefinition/ServiceRequestUpdated",
"resourceType": "MessageHeader",
"id": "ServiceRequestUpdatedMessageHeader",
"source": {
"name": "Good Health Clinics",
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
},
"focus": [
{
"reference": "ServiceRequest/RedoxServiceRequestOrderExample"
},
{
"reference": "Patient/RedoxPatientExampleTimothy"
}
],
"definition": "https://fhir.redoxengine.com/MessageDefinition/ServiceRequestUpdatedFull"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/ServiceRequest?identifier=6547891230|urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"resource": {
"resourceType": "ServiceRequest",
"id": "RedoxServiceRequestOrderExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "6547891230"
}
],
"intent": "order",
"priority": "stat",
"status": "active",
"code": {
"coding": [
{
"code": "49086-2",
"system": "http://loinc.org",
"display": "First trimester maternal screen with nuchal translucency panel"
}
]
},
"authoredOn": "2022-08-08T08:00:00.000Z",
"note": [
{
"text": "Additional information"
}
],
"reasonReference": [
{
"reference": "DocumentReference/RedoxDocumentReferenceExampleMediaTimothy"
}
],
"supportingInfo": [
{
"reference": "Observation/RedoxPlateletObservationExample"
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"requester": {
"reference": "Practitioner/RedoxPractitionerExamplePat"
},
"performer": [
{
"reference": "Practitioner/RedoxPractitionerExampleJoan"
}
],
"specimen": [
{
"reference": "Specimen/RedoxSpecimenExample"
}
],
"encounter": {
"reference": "Encounter/RedoxEncounterExample"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=0000000001|urn:redox:MRN",
"resource": {
"resourceType": "Patient",
"id": "RedoxPatientExampleTimothy",
"meta": {
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
"valueInteger": 1
}
]
},
"extension": [
{
"extension": [
{
"url": "text",
"valueString": "White"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
},
{
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"code": "2135-2",
"system": "urn:oid:2.16.840.1.113883.6.238",
"display": "Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Hispanic"
}
],
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
}
],
"identifier": [
{
"value": "0000000001",
"system": "urn:redox:health-one:MR"
},
{
"value": "101-01-0001",
"system": "http://hl7.org/fhir/sid/us-ssn"
}
],
"name": [
{
"given": [
"Timothy",
"Paul"
],
"family": "Bixby",
"use": "official"
},
{
"text": "Billy",
"use": "usual"
}
],
"gender": "male",
"birthDate": "2008-01-06",
"telecom": [
{
"value": "+18088675301",
"system": "phone",
"use": "home"
},
{
"value": "+18008675309",
"system": "phone",
"use": "work"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": [
{
"line": [
"4762 Hickory Street"
],
"city": "Monroe",
"district": "Greene",
"state": "WI",
"postalCode": "53566",
"country": "US",
"use": "home"
}
],
"maritalStatus": {
"coding": [
{
"code": "M",
"system": "http://hl7.org/fhir/v3/MaritalStatus",
"display": "Married"
}
],
"text": "Married"
},
"communication": [
{
"language": {
"coding": [
{
"code": "en",
"system": "urn:ietf:bcp:47"
}
],
"text": "English"
}
}
],
"contact": [
{
"name": {
"given": [
"Barbara"
],
"family": "Bixby"
},
"telecom": [
{
"value": "+18088675303",
"system": "phone",
"use": "home"
},
{
"value": "[email protected]",
"system": "email"
}
],
"address": {
"line": [
"4762 Hickory St."
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "USA"
},
"relationship": [
{
"coding": [
{
"code": "MTH",
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"display": "mother"
}
],
"text": "Mother"
},
{
"coding": [
{
"code": "C",
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
"display": "Emergency Contact"
}
],
"text": "Emergency Contact"
}
]
}
],
"generalPractitioner": [
{
"reference": "Practitioner/RedoxPractitionerExamplePat"
}
],
"managingOrganization": {
"reference": "Organization/RedoxOrganizationManagingExample"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter?identifier=zzz123Encounter|urn:redox:encounterId",
"resource": {
"resourceType": "Encounter",
"id": "RedoxEncounterExample",
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
"value": "9601346482"
}
],
"status": "finished",
"class": {
"code": "IMP",
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"display": "inpatient encounter"
},
"type": [
{
"coding": [
{
"code": "99222",
"system": "http://www.ama-assn.org/go/cpt",
"display": "InPatient Admission"
}
]
}
],
"diagnosis": [
{
"condition": {
"reference": "Condition/RedoxConditionExampleEncounterDx"
}
}
],
"participant": [
{
"individual": {
"reference": "Practitioner/RedoxPractitionerExampleEncounter"
}
}
],
"location": [
{
"location": {
"reference": "Location/RedoxLocationExampleEncounter"
}
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"period": {
"start": "2022-02-06T04:00:00.000Z",
"end": "2022-02-06T04:15:00.000Z"
},
"length": {
"value": 16,
"code": "m",
"system": "http://unitsofmeasure.org"
},
"reasonCode": [
{
"coding": [
{
"code": "23360407",
"system": "http://snomed.info/sct"
}
],
"text": "Pneumonia"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExamplePat",
"resource": {
"resourceType": "Practitioner",
"id": "RedoxPractitionerExamplePat",
"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"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExampleJoan",
"resource": {
"resourceType": "Practitioner",
"id": "RedoxPractitionerExampleJoan",
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "4336749876"
}
],
"name": [
{
"given": [
"Joan"
],
"family": "Fishman"
}
],
"address": [
{
"line": [
"4762 Hickory St."
],
"city": "Monroe",
"district": "Green",
"state": "WI",
"postalCode": "53566",
"country": "USA"
}
],
"telecom": [
{
"value": "+16085558899"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationManagingExample",
"resource": {
"resourceType": "Organization",
"id": "RedoxOrganizationManagingExample",
"identifier": [
{
"value": "1234",
"system": "urn:oid:1.2.3.4"
}
],
"active": true,
"name": "Custodial Org",
"address": [
{
"line": [
"123 Main St"
],
"city": "Madison",
"state": "WI"
}
],
"telecom": [
{
"value": "1-800-123-4567",
"system": "phone"
}
],
"type": [
{
"text": "Test Type"
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/DocumentReference?identifier=129.6.58.92.88336|urn:redox:test:media",
"resource": {
"resourceType": "DocumentReference",
"id": "RedoxDocumentReferenceExampleMediaTimothy",
"masterIdentifier": {
"value": "129.6.58.92.88336",
"system": "urn:redox:test:media",
"extension": [
{
"url": "https://fhir.redoxengine.com/StructureDefinition/identifier-origin",
"valueString": "RedoxApi"
}
]
},
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"status": "current",
"description": "Test Description",
"type": {
"text": "Empty File"
},
"category": [
{
"coding": [
{
"system": "urn:redox:document_kind",
"code": "Media"
}
]
}
],
"context": {
"period": {
"start": "2015-05-06T06:00:58.872Z"
}
},
"content": [
{
"attachment": {
"data": "PC4uLmJhc2UgNjQgZmlsZSBjb250ZW50cy4uLj4=",
"contentType": "application/pdf",
"title": "SamplePDF-Order Specific Media"
}
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Observation?identifier=4910481243|urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"resource": {
"resourceType": "Observation",
"id": "RedoxPlateletObservationExample",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "laboratory"
}
]
}
],
"identifier": [
{
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
"value": "4910481243"
}
],
"status": "final",
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"basedOn": [
{
"reference": "ServiceRequest/RedoxServiceRequestOrderExample"
}
],
"code": {
"coding": [
{
"code": "26515-7",
"system": "http://loinc.org"
}
],
"text": "Platelets"
},
"specimen": {
"reference": "Specimen/RedoxSpecimenExample"
},
"issued": "2022-02-16T17:26:19.778Z",
"valueQuantity": {
"value": 201,
"unit": "10+3/ul"
},
"note": [
{
"text": "An observation result note"
}
],
"interpretation": [
{
"coding": [
{
"code": "N",
"system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
"display": "Normal"
}
]
}
]
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Specimen?identifier=123|urn:redox:example:SpecimenID",
"resource": {
"resourceType": "Specimen",
"id": "RedoxSpecimenExample",
"identifier": [
{
"system": "urn:redox:example:SpecimenID",
"value": "123"
}
],
"subject": {
"reference": "Patient/RedoxPatientExampleTimothy"
},
"type": {
"coding": [
{
"code": "WB",
"system": "http://terminology.hl7.org/CodeSystem/v2-0487",
"display": "Blood, Whole"
}
],
"text": "Blood, Whole"
},
"collection": {
"bodySite": {
"text": "Left arm"
},
"collectedDateTime": "2022-02-14T19:20:02.762Z"
}
}
}
],
"timestamp": "2021-06-17T20:33:22.422Z",
"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.Event.Order",
"EventType": "service-request-updated"
}
}