Device
The Device data model is used to send discrete continuous physiological monitoring data to a patient's chart (e.g., heart rate, estimated blood loss). This is useful when an EHR system is maintaining the link from the device to the patient. The app sending the device data back to the EHR system needs to include the device ID to save the data back to the patient's chart. There are two types of device patient association in the EHR: a) Static: If a device is not movable and is set in a single patient room, it can be assumed that any patient in that room is using the device when data comes back for it. No manual step is needed for association of the device to the patient, only validation of the data by a nurse to file it to the chart; b) Dynamic: If a device is mobile and moves from room to room, typically a user generally manually associates the device with a patient in the EHR system before data flows to that chart and can be validated.
The Device data model is almost identical to the Flowsheets data model except for one key difference: the Device data model requires a device ID to match the results with the patient's chart while the Flowsheets model (and almost every other data model) requires a patient ID. The Device data model also differs from the Results data model in that the device data is continuous, whereas results are generally a one-time outcome of an order. Check out the Results data model if you're interested in results from an ordered test. Typically, EHR systems that support device data offer an HL7v2 ORU interface or API to file the data.
A New message is used to add new observations from a device to a patient's chart. Multiple different observations may be included in one message. Note that patient information and visit information may be included. However, in most cases, the EHR maps the device ID either to the patient directly, or to a room/bed directly, and ignores the patient and visit information.
Fields
Meta
Meta.DataModelString
ReliableRequiredDevice
Meta.EventTypeString
ReliableRequiredNew
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.
Meta.SourceString
ReliableContains the information for the system originating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.IDString
ReliableIdentifies the system that originates the message. If you're using OAuth keys, this value is required; if you're using legacy API keys, this value is optional since legacy keys are specific to a given originating system.
UUID
Meta.Source.NameString
ReliableDisplays the name of the system that originates 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.MessageString
ReliableRecord in Redox that corresponds to the communication sent from the source system to Redox.
Included in requests from Redox.
Meta.Message.IDNumeric
ReliableRetiredIdentifies the numeric value of the message created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
Meta.TransmissionString
ReliableRecord in Redox that corresponds to the communication sent from Redox to the destination endpoint.
Included in messages from Redox.
Meta.Transmission.IDNumeric
ReliableRetiredIdentifies the numeric value of the transmission created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
Meta.FacilityCodeString
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].IDString
ReliableID for the patient
Patient.Identifiers[].IDTypeString
ReliableType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstNameString
ReliablePatient's first name
Patient.Demographics.MiddleNameString
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastNameString
ReliablePatient's last name
Patient.Demographics.DOBString
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSNString
ProbablePatient's social security number
Patient.Demographics.SexString
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.RaceString
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanicBoolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.ReligionString
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatusString
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceasedBoolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTimeDateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.HomeString
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.OfficeString
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.MobileString
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.LanguageString
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.AddressObject
ProbablePatient's home address
Patient.Demographics.Address.StreetAddressString
ProbableStreet address
Patient.Demographics.Address.CityString
ProbableCity
Patient.Demographics.Address.StateString
ProbableState
Patient.Demographics.Address.ZIPString
ProbableZIP
Patient.Demographics.Address.CountyString
PossibleCounty
Patient.Demographics.Address.CountryString
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]Array of strings
PossiblePatient-level notes
Patient.Contacts[].FirstNameString
PossibleFirst name of the contact
Patient.Contacts[].MiddleNameString
PossibleMiddle name of the contact
Patient.Contacts[].LastNameString
PossibleLast name of the contact
Patient.Contacts[].AddressObject
PossibleAddress of the contact
Patient.Contacts[].Address.StreetAddressString
PossibleStreet address
Patient.Contacts[].Address.CityString
PossibleCity
Patient.Contacts[].Address.StateString
PossibleState
Patient.Contacts[].Address.ZIPString
PossibleZIP
Patient.Contacts[].Address.CountyString
PossibleCounty
Patient.Contacts[].Address.CountryString
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Contacts[].PhoneNumber.HomeString
PossibleHome phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.OfficeString
PossibleOffice phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.MobileString
ProbableMobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].RelationToPatientString
PossibleValueSetPersonal relationship to the patient
-
Additional values may be added by Redox in the future.
-
Patient.Contacts[].EmailAddresses[]Array of string
PossibleEmail address(es) of the contact person
Patient.Contacts[].Roles[]Array of strings
PossibleRole of this contact for the patient.
e.x. Employer, Emergency Contact
Visit
Visit.VisitNumberString
ReliableNumber for the visit
Visit.LocationObject
ProbableLocation of the visit. This may be used for validation or to identify your application/device.
Visit.Location.TypeString
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.FacilityString
ProbableFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]Array of Objects
ProbableList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].IDString
ProbableAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDTypeString
ProbableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.DepartmentString
ProbableDepartment
Visit.Location.DepartmentIdentifiers[]Array of Objects
ProbableList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].IDString
ProbableAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDTypeString
ProbableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.RoomString
ProbableRoom.
Example: 136
Visit.Location.BedString
ProbableBed.
Example: B
Device
Device.IDString
ReliableRequiredIdentifier for the device.
This ID is used to map the device to the patient in the EMR
Observations
Observations[]Array of objects
ReliableList of values to be added to the patient's chart
Observations[].DateTimeString
ReliableRequiredDateTime the value was recorded.
ISO 8601 Format
Observations[].CodeString
ReliableRequiredCode for the metric measured.
This is usually provided by the EMR or you will be asked to provide a list of codes you can send. For example, this is where you would specify "Heart Rate"
Observations[].ValueString
ReliableRequiredValue to be recorded for corresponding code.
For example, if the code is "Heart Rate", this may be 65
Observations[].ValueTypeString
ReliableValueSetRequiredData type for the value
-
Additional values may be added by Redox in the future.
-
Observations[].UnitsString
ProbableUnits of the value.
If the code is "Heart Rate", this may be "BPM"
{
"Meta": {
"DataModel": "Device",
"EventType": "New",
"EventDateTime": "2022-12-09T19:46:29.921Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": [],
"Contacts": [
{
"FirstName": "Barbara",
"MiddleName": null,
"LastName": "Bixby",
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
},
"PhoneNumber": {
"Home": "+18088675303",
"Office": "+17077543758",
"Mobile": "+19189368865"
},
"RelationToPatient": "Mother",
"EmailAddresses": [
"[email protected]"
],
"Roles": [
"Emergency Contact"
]
}
]
},
"Visit": {
"VisitNumber": "1234",
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null,
"Bed": null
}
},
"Device": {
"ID": "dev28701"
},
"Observations": [
{
"DateTime": "2015-08-13T21:08:57.581Z",
"Code": "Systolic",
"Value": "110.00",
"ValueType": "Numeric",
"Units": "mmHg"
},
{
"DateTime": "2015-08-13T21:08:57.581Z",
"Code": "Diastolic",
"Value": "90.00",
"ValueType": "Numeric",
"Units": "mmHg"
},
{
"DateTime": "2015-08-13T21:08:57.581Z",
"Code": "Heart Rate",
"Value": "55",
"ValueType": "Numeric",
"Units": "beats/min"
}
]
}