Device

The Device data model allows integration of discrete clinical data captured by a device into a patient's chart. Device data can include a wide variety of information. Some examples are heart rate and estimated blood loss.

Newlink

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.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. E.g. New, Update

    • Meta.Test

      Boolean

      Reliable

      Flag as a test message

    • Meta.Source

      String

      Reliable

      Where the message originated. Included in messages from Redox

    • Meta.Source.ID

      String

      Reliable

      ID of the source. UUID

    • Meta.Source.Name

      String

      Reliable

      Name of the source

    • Meta.Destinations[]

      Array of Objects

      Reliable

      List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination. Required when sending data to Redox

    • Meta.Destinations[].ID

      String

      Reliable

      ID of the destination. UUID

    • Meta.Destinations[].Name

      String

      Reliable

      Name of the destination

    • Meta.Message

      String

      Reliable

      Record in Redox that corresponds to the communication sent from the source to Redox. Included in messages from Redox

    • Meta.Message.ID

      Numeric

      Reliable

      ID of the message created in Redox

    • Meta.Transmission

      String

      Reliable

      Record in Redox that corresponds to the communication sent from Redox to your destination. Included in messages from Redox

    • Meta.Transmission.ID

      Numeric

      Reliable

      ID of the transmission created in Redox

    • Meta.FacilityCode

      String

      Possible

      Code 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

      Reliable

      List of IDs and ID types that identify the patient

    • Patient.Identifiers[].ID

      String

      Reliable

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Reliable

      Type of ID. E.g. MRN, EPI

    • Patient.Demographics.FirstName

      String

      Reliable

      Patient's first name

    • Patient.Demographics.MiddleName

      String

      Possible

      Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.

    • Patient.Demographics.LastName

      String

      Reliable

      Patient's last name

    • Patient.Demographics.DOB

      String

      Reliable

      Patient's date of birth. In ISO 8601 format

    • Patient.Demographics.SSN

      String

      Probable

      Patient's social security number

    • Patient.Demographics.Sex

      String

      Reliable

      Patient's sex. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • Patient.Demographics.IsDeceased

      Boolean

      Possible

      Indicates if the patient is deceased

    • Patient.Demographics.DeathDateTime

      DateTime

      Possible

      Date and Time the patient was proclaimed deceased. ISO 8601 Format

    • Patient.Demographics.PhoneNumber.Home

      String

      Probable

      Patient's home phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Office

      String

      Probable

      Patient's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Mobile

      String

      Probable

      Patient's mobile phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.EmailAddresses[]

      Array of Strings

      Probable

      Patient's email address(es)

    • Patient.Demographics.Language

      String

      Possible

      Patient's primary spoken language. In ISO 639-1 alpha values (e.g. 'en'). Supported Values

    • Patient.Demographics.Citizenship[]

      Array of strings

      Possible

      Patient's nation(s) of citizenship. *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.

      Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*

    • Patient.Demographics.Address

      Object

      Probable

      Patient's home address

    • Patient.Demographics.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.Demographics.Address.City

      String

      Probable

      City

    • Patient.Demographics.Address.State

      String

      Probable

      State

    • Patient.Demographics.Address.ZIP

      String

      Probable

      ZIP

    • Patient.Demographics.Address.County

      String

      Possible

      County

    • Patient.Demographics.Address.Country

      String

      Possible

      Country

    • Patient.Notes[]

      Array of strings

      Possible

      Patient-level notes

    • Patient.Contacts[].FirstName

      String

      Possible

      First name of the contact

    • Patient.Contacts[].MiddleName

      String

      Possible

      Middle name of the contact

    • Patient.Contacts[].LastName

      String

      Possible

      Last name of the contact

    • Patient.Contacts[].Address

      Object

      Possible

      Address of the contact

    • Patient.Contacts[].Address.StreetAddress

      String

      Possible

      Street address

    • Patient.Contacts[].Address.City

      String

      Possible

      City

    • Patient.Contacts[].Address.State

      String

      Possible

      State

    • Patient.Contacts[].Address.ZIP

      String

      Possible

      ZIP

    • Patient.Contacts[].Address.County

      String

      Possible

      County

    • Patient.Contacts[].Address.Country

      String

      Possible

      Country

    • Patient.Contacts[].PhoneNumber.Home

      String

      Possible

      Home phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Contacts[].PhoneNumber.Office

      String

      Possible

      Office phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Contacts[].PhoneNumber.Mobile

      String

      Probable

      Mobile phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Contacts[].RelationToPatient

      String

      Possible

      Personal relationship to the patient. e.x. Father, Spouse

    • Patient.Contacts[].EmailAddresses[]

      Array of string

      Possible

      Email address(es) of the contact person

    • Patient.Contacts[].Roles[]

      Array of strings

      Possible

      Role of this contact for the patient. e.x. Employer, Emergency Contact

  • Visit
    • Visit.VisitNumber

      String

      Reliable

      Number for the visit

    • Visit.Location

      Object

      Probable

      Location of the visit. This may be used for validation or to identify your application/device.

    • Visit.Location.Type

      String

      Probable

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.Location.Facility

      String

      Probable

      Facility. Example: Community Hospital

    • Visit.Location.Department

      String

      Probable

      Department

    • Visit.Location.Room

      String

      Probable

      Room. Example: 136

    • Visit.Location.Bed

      String

      Probable

      Bed. Example: B

  • Device
    • Device.ID

      String

      Reliable
      Required

      Identifier for the device. This ID is used to map the device to the patient in the EMR

  • Observations
    • Observations[]

      Array of objects

      Reliable

      List of values to be added to the patient's chart

    • Observations[].DateTime

      String

      Reliable
      Required

      DateTime the value was recorded. ISO 8601 Format

    • Observations[].Code

      String

      Reliable
      Required

      Code 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[].Value

      String

      Reliable
      Required

      Value to be recorded for corresponding code. For example, if the code is "Heart Rate", this may be 65

    • Observations[].ValueType

      String

      Reliable
      Required

      Data type for the value. One of the following: "Numeric", "String", "Date", "Time", "DateTime", "Coded Entry", "Encapsulated Data". Derived from HL7 Table 0125. For example, if the code is "Heart Rate", this may be "Numeric"

    • Observations[].Units

      String

      Probable

      Units of the value. If the code is "Heart Rate", this may be "BPM"

{
   "Meta": {
      "DataModel": "Device",
      "EventType": "New",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "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": "Asian",
         "IsHispanic": 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": [
               "barb.bixby@test.net"
            ],
            "Roles": [
               "Emergency Contact"
            ]
         }
      ]
   },
   "Visit": {
      "VisitNumber": "1234",
      "Location": {
         "Type": null,
         "Facility": null,
         "Department": null,
         "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"
      }
   ]
}