Table of Contents

Flowsheet

The Flowsheet data model is used to communicate discrete clinical data to or from an EHR system. Flowsheet data includes both inpatient and outpatient assessment information, vitals, patient-reported outcomes or questionnaires, and any other discrete clinical documentation.

The Flowsheet data model is almost identical to the Device 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 Flowsheet data model also differs from the Results data model in that the flowsheet 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.

Newlink

A New message is used to add a new observations to the flowsheet. Multiple different observations may be included in one message.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Flowsheet

    • Meta.EventType

      String

      Reliable
      Required

      New

    • Meta.EventDateTime

      DateTime

      Reliable

      Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
      ISO 8601 Format

    • Meta.Test

      Boolean

      Reliable

      Indicates whether the request is a test or not.

    • Meta.Source

      String

      Reliable

      Contains the information for the system initiating the message, including the source ID and name.
      Included in messages from Redox

    • Meta.Source.ID

      String

      Reliable

      Identifies 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.Name

      String

      Reliable

      Displays the name of the system initiating the message.

    • Meta.Destinations[]

      Array of Objects

      Reliable

      Contains 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[].ID

      String

      Reliable

      Identifies the endpoint that the request is directed to.
      UUID

    • Meta.Destinations[].Name

      String

      Reliable

      Displays the name of the endpoint that the request is directed to.

    • Meta.Logs[]

      Array of Objects

      Reliable

      Contains the log identifier(s) for the request.

    • Meta.Logs[].ID

      String

      Reliable

      Identifies 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[].AttemptID

      String

      Reliable

      Identifies the request log attempt value, which is useful when retries are possible.
      UUID

    • 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
      Required

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Reliable
      Required

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

      Boolean

      Possible
      ValueSet
      Indicates if the patient is of hispanic origin.
    • Patient.Demographics.Religion

      String

      Possible
      ValueSet
      Patient's religious affiliation
    • Patient.Demographics.MaritalStatus

      String

      Possible
      ValueSet
      Patient's marital status
    • 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
      ValueSet
      Patient's primary spoken language
    • Patient.Demographics.Citizenship[]

      Array of strings

      Possible
      ValueSet
      Patient's nation(s) of citizenship
    • 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.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[].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
      ValueSet
      Personal relationship to the patient
    • 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 that contains the flowsheet.
      VisitNumber is highly recommended so that the document can be associated with a specific visit

    • Visit.AccountNumber

      String

      Possible

      Account Number.
      An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.

    • Visit.VisitDateTime

      String

      Possible

      DateTime of visit or appointment.
      ISO 8601 Format

    • Visit.Location

      Object

      Probable

      Location of the patient. 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.FacilityIdentifiers[]

      Array of Objects

      Probable

      List of IDs specific to this facility

    • Visit.Location.FacilityIdentifiers[].ID

      String

      Probable

      An ID specific to this facility

    • Visit.Location.FacilityIdentifiers[].IDType

      String

      Probable

      The source or system to which this ID pertains.
      Could be an OID or a human-readable name

    • Visit.Location.Department

      String

      Probable

      Department

    • Visit.Location.DepartmentIdentifiers[]

      Array of Objects

      Probable

      List of IDs specific to this department

    • Visit.Location.DepartmentIdentifiers[].ID

      String

      Probable

      An ID specific to this department

    • Visit.Location.DepartmentIdentifiers[].IDType

      String

      Probable

      The source or system to which this ID pertains.
      Could be an OID or a human-readable name

    • Visit.Location.Room

      String

      Probable

      Room.
      Example: 136

    • Visit.Location.Bed

      String

      Probable

      Bed.
      Example: B

  • Observations
    • Observations[]

      Array of objects

      Reliable

      List of values to be added to the flowsheet

    • Observations[].DateTime

      String

      Reliable
      Required

      DateTime the value was recorded.
      ISO 8601 Format

    • Observations[].Value

      String

      Reliable
      Required

      Value to be recorded.
      For example, if the value is a heart rate, this will be 65

    • Observations[].Units

      String

      Probable

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

    • Observations[].Code

      String

      Reliable
      Required

      Code for the flowsheet row that the value should file to.
      This is usually provided by the EMR or you will asked to provide a list of codes you can send. For example, this is where you would specify "Heart Rate" for heart rate values.

    • Observations[].Codeset

      String

      Probable

      Codeset used to identify the code

    • Observations[].Description

      String

      Probable

      Description of the flowsheet row

    • Observations[].Notes[]

      Array of Strings

      Possible

      Notes about the observation

    • Observations[].Observer.ID

      String

      Possible

      Optional code indicating who made the observation.
      Typically represents an actual person, but may also be linked to device in some EHRs

    • Observations[].Observer.IDType

      String

      Possible

      ID type of the ID for the Observer

    • Observations[].Observer.FirstName

      String

      Possible

      Optional code indicating who made the observation

    • Observations[].Observer.LastName

      String

      Possible

      Optional code indicating who made the observation

    • Observations[].ReferenceRange

      Object

      Possible

      Reference range for the observation.
      Numeric observation values will use the low and high properties. Non-numeric observation values will put the normal value in the text property.

    • Observations[].ReferenceRange.Low

      Numeric

      Possible

      Lower bound for a normal observation

    • Observations[].ReferenceRange.High

      Numeric

      Possible

      Upper bound for a normal observation

    • Observations[].ReferenceRange.Text

      String

      Possible

      The normal value for non-numeric observations

    • Observations[].AbnormalFlag

      String

      Possible
      ValueSet
      Indication of whether the observation was abnormal
Sample MessageDownload JSON Schema 
{
   "Meta": {
      "DataModel": "Flowsheet",
      "EventType": "New",
      "EventDateTime": "2024-11-19T17:25:42.412Z",
      "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"
         }
      ],
      "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": [
               "barb.bixby@test.net"
            ],
            "Roles": [
               "Emergency Contact"
            ]
         }
      ]
   },
   "Visit": {
      "VisitNumber": "1234",
      "AccountNumber": null,
      "VisitDateTime": null,
      "Location": {
         "Type": null,
         "Facility": null,
         "FacilityIdentifiers": [],
         "Department": null,
         "DepartmentIdentifiers": [],
         "Room": null,
         "Bed": null
      }
   },
   "Observations": [
      {
         "DateTime": "2015-08-13T21:08:57.581Z",
         "Value": "110.00",
         "ValueType": "Numeric",
         "Units": "mmHg",
         "Code": "Systolic",
         "Codeset": "RedoxEMR",
         "Description": null,
         "Status": null,
         "Notes": [
            "Observation note."
         ],
         "Observer": {
            "ID": "12312",
            "IDType": null,
            "FirstName": "Jimmy",
            "LastName": "JimJam"
         },
         "ReferenceRange": {
            "Low": null,
            "High": null,
            "Text": null
         },
         "AbnormalFlag": null
      },
      {
         "DateTime": "2015-08-13T21:08:57.581Z",
         "Value": "90.00",
         "ValueType": "Numeric",
         "Units": "mmHg",
         "Code": "Diastolic",
         "Codeset": "RedoxEMR",
         "Description": null,
         "Status": null,
         "Notes": [],
         "Observer": {
            "ID": "12312",
            "IDType": null,
            "FirstName": "Jimmy",
            "LastName": "JimJam"
         },
         "ReferenceRange": {
            "Low": null,
            "High": null,
            "Text": null
         },
         "AbnormalFlag": null
      },
      {
         "DateTime": "2015-08-13T21:08:57.581Z",
         "Value": "55",
         "ValueType": "Numeric",
         "Units": "beats/min",
         "Code": "Diastolic",
         "Codeset": "RedoxEMR",
         "Description": null,
         "Status": null,
         "Notes": [],
         "Observer": {
            "ID": "12312",
            "IDType": null,
            "FirstName": "Jimmy",
            "LastName": "JimJam"
         },
         "ReferenceRange": {
            "Low": null,
            "High": null,
            "Text": null
         },
         "AbnormalFlag": null
      }
   ]
}