Home
API reference
Redox Data Models
Flowsheet
New

Flowsheet

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

This data model has event types that allow you to:

  • provide continuous vitals or assessments to a patient's chart.

New

Add new observations to the flowsheet. Multiple observations may be included in one message.

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Flowsheet

    • EventType
      required, string
      Reliable

      New

    • EventDateTime
      string, null
      Reliable

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

    • Test
      boolean, null
      Reliable

      Indicates whether the request is a test or not.

    • Source
      object

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

      • ID
        string, null
        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

      • Name
        string, null
        Reliable

        Displays the name of the system initiating the message.

    • Destinations
      Array of object

      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.

      • ID
        string, null
        Reliable

        Identifies the endpoint that the request is directed to.
        UUID

      • Name
        string, null
        Reliable

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

    • Logs
      Array of object

      Contains the log identifier(s) for the request.

      • ID
        string, null
        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

      • AttemptID
        string, null
        Reliable

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

    • FacilityCode
      string, null
      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
    required, object
    • Identifiers
      required, Array of object

      List of IDs and ID types that identify the patient

      • ID
        required, string
        Reliable

        ID for the patient

      • IDType
        required, string
        Reliable

        Type of ID.
        E.g. MRN, EPI

    • Demographics
      object
      • FirstName
        string, null
        Reliable

        Patient's first name

      • MiddleName
        string, null
        Possible

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

      • LastName
        string, null
        Reliable

        Patient's last name

      • DOB
        string, null
        Reliable

        Patient's date of birth.
        In ISO 8601 format

      • SSN
        string, null
        Probable

        Patient's social security number

      • Sex
        string, null
        Reliable
        Value Set

        Patient's sex

      • Race
        string, null
        Possible
        Value Set

        Patient's race

      • IsHispanic
        boolean, null
        Possible
        Value Set

        Indicates if the patient is of hispanic origin.

      • Religion
        string, null
        Possible
        Value Set

        Patient's religious affiliation

      • MaritalStatus
        string, null
        Possible
        Value Set

        Patient's marital status

      • IsDeceased
        boolean, null
        Possible

        Indicates if the patient is deceased

      • DeathDateTime
        string, null
        Possible

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

      • PhoneNumber
        object
        • Home
          string, null
          Probable

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

        • Office
          string, null
          Probable

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

        • Mobile
          string, null
          Probable

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

      • EmailAddresses
        Array of string

        Patient's email address(es)

      • Language
        string, null
        Possible
        Value Set

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

      • Citizenship
        Array of string

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

      • Address
        object

        Patient's home address

        • StreetAddress
          string, null
          Probable

          Street address

        • City
          string, null
          Probable

          City

        • State
          string, null
          Probable

          State

        • ZIP
          string, null
          Probable

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

    • Notes
      Array of string

      Patient-level notes

    • Contacts
      Array of object
      • FirstName
        string, null
        Possible

        First name of the contact

      • MiddleName
        string, null
        Possible

        Middle name of the contact

      • LastName
        string, null
        Possible

        Last name of the contact

      • Address
        object

        Address of the contact

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • PhoneNumber
        object
        • Home
          string, null
          Possible

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

        • Office
          string, null
          Possible

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

        • Mobile
          string, null
          Probable

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

      • RelationToPatient
        string, null
        Possible
        Value Set

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

      • EmailAddresses
        Array of string

        Email address(es) of the contact person

      • Roles
        Array of string

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

  • Observations
    required, Array of object

    List of values to be added to the flowsheet

    • DateTime
      required, string
      Reliable

      DateTime the value was recorded.
      ISO 8601 Format

    • Value
      required, string
      Reliable

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

    • ValueType
      required, string
      Reliable
      Value Set

      Data type of the value

    • Code
      required, string
      Reliable

      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.

    • Units
      string, null
      Probable

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

    • Codeset
      string, null
      Probable

      Codeset used to identify the code

    • Description
      string, null
      Probable

      Description of the flowsheet row

    • Status
      string, null
      Possible
      Value Set

      Status of the observation

    • Notes
      Array of string

      Notes about the observation

    • Observer
      object
      • ID
        string, null
        Possible

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

      • IDType
        string, null
        Possible

        ID type of the ID for the Observer

      • FirstName
        string, null
        Possible

        Optional code indicating who made the observation

      • LastName
        string, null
        Possible

        Optional code indicating who made the observation

    • ReferenceRange
      object

      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.

      • Low
        number, null
        Possible

        Lower bound for a normal observation

      • High
        number, null
        Possible

        Upper bound for a normal observation

      • Text
        string, null
        Possible

        The normal value for non-numeric observations

    • AbnormalFlag
      string, null
      Possible
      Value Set

      Indication of whether the observation was abnormal.
      One of the following: "Normal", "Low", "Very Low", "High", "Very High", "Abnormal", "Very Abnormal". Abnormal flags starting with "Very" indicate a panic level. The "High" and "Low" flags should be used with Numeric result values while "Abnormal" should be used with non-numeric values.

  • Visit
    object
    • VisitNumber
      string, null
      Reliable

      Number for the visit that contains the flowsheet.
      VisitNumber is highly recommended so that the document can be associated with a specific visit

    • AccountNumber
      string, null
      Possible

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

    • VisitDateTime
      string, null
      Possible

      DateTime of visit or appointment.
      ISO 8601 Format

    • Location
      object

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

      • Type
        string, null
        Probable

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

      • Facility
        string, null
        Probable

        Facility.
        Example: Community Hospital

      • FacilityIdentifiers
        Array of object

        List of IDs specific to this facility

        • ID
          string, null
          Probable

          An ID specific to this facility

        • IDType
          string, null
          Probable

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

      • Department
        string, null
        Probable

        Department

      • DepartmentIdentifiers
        Array of object

        List of IDs specific to this department

        • ID
          string, null
          Probable

          An ID specific to this department

        • IDType
          string, null
          Probable

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

      • Room
        string, null
        Probable

        Room.
        Example: 136

      • Bed
        string, null
        Probable

        Bed.
        Example: B

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Flowsheet",
4
    "EventType": "New",
5
    "EventDateTime": "2024-11-20T14:08:29.777Z",
6
    "Test": true,
7
    "Source": {
8
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
9
      "Name": "Redox Dev Tools"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
14
        "Name": "Redox EMR"
15
      }
16
    ],
17
    "Logs": [
18
      {
19
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
20
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
21
      }
22
    ],
23
    "FacilityCode": null
24
  },
25
  "Patient": {
26
    "Identifiers": [
27
      {
28
        "ID": "0000000001",
29
        "IDType": "MR"
30
      },
31
      {
32
        "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
33
        "IDType": "EHRID"
34
      },
35
      {
36
        "ID": "a1d4ee8aba494ca",
37
        "IDType": "NIST"
38
      }
39
    ],
40
    "Demographics": {
41
      "FirstName": "Timothy",
42
      "MiddleName": "Paul",
43
      "LastName": "Bixby",
44
      "DOB": "2008-01-06",
45
      "SSN": "101-01-0001",
46
      "Sex": "Male",
47
      "Race": "White",
48
      "IsHispanic": null,
49
      "Religion": null,
50
      "MaritalStatus": "Single",
51
      "IsDeceased": null,
52
      "DeathDateTime": null,
53
      "PhoneNumber": {
54
        "Home": "+18088675301",
55
        "Office": null,
56
        "Mobile": null
57
      },
58
      "EmailAddresses": [],
59
      "Language": "en",
60
      "Citizenship": [],
61
      "Address": {
62
        "StreetAddress": "4762 Hickory Street",
63
        "City": "Monroe",
64
        "State": "WI",
65
        "ZIP": "53566",
66
        "County": "Green",
67
        "Country": "US"
68
      }
69
    },
70
    "Notes": [],
71
    "Contacts": [
72
      {
73
        "FirstName": "Barbara",
74
        "MiddleName": null,
75
        "LastName": "Bixby",
76
        "Address": {
77
          "StreetAddress": "4762 Hickory Street",
78
          "City": "Monroe",
79
          "State": "WI",
80
          "ZIP": "53566",
81
          "County": "Green",
82
          "Country": "US"
83
        },
84
        "PhoneNumber": {
85
          "Home": "+18088675303",
86
          "Office": "+17077543758",
87
          "Mobile": "+19189368865"
88
        },
89
        "RelationToPatient": "Mother",
90
        "EmailAddresses": [
91
          "barb.bixby@test.net"
92
        ],
93
        "Roles": [
94
          "Emergency Contact"
95
        ]
96
      }
97
    ]
98
  },
99
  "Visit": {
100
    "VisitNumber": "1234",
101
    "AccountNumber": null,
102
    "VisitDateTime": null,
103
    "Location": {
104
      "Type": null,
105
      "Facility": null,
106
      "FacilityIdentifiers": [],
107
      "Department": null,
108
      "DepartmentIdentifiers": [],
109
      "Room": null,
110
      "Bed": null
111
    }
112
  },
113
  "Observations": [
114
    {
115
      "DateTime": "2015-08-13T21:08:57.581Z",
116
      "Value": "110.00",
117
      "ValueType": "Numeric",
118
      "Units": "mmHg",
119
      "Code": "Systolic",
120
      "Codeset": "RedoxEMR",
121
      "Description": null,
122
      "Status": null,
123
      "Notes": [
124
        "Observation note."
125
      ],
126
      "Observer": {
127
        "ID": "12312",
128
        "IDType": null,
129
        "FirstName": "Jimmy",
130
        "LastName": "JimJam"
131
      },
132
      "ReferenceRange": {
133
        "Low": null,
134
        "High": null,
135
        "Text": null
136
      },
137
      "AbnormalFlag": null
138
    },
139
    {
140
      "DateTime": "2015-08-13T21:08:57.581Z",
141
      "Value": "90.00",
142
      "ValueType": "Numeric",
143
      "Units": "mmHg",
144
      "Code": "Diastolic",
145
      "Codeset": "RedoxEMR",
146
      "Description": null,
147
      "Status": null,
148
      "Notes": [],
149
      "Observer": {
150
        "ID": "12312",
151
        "IDType": null,
152
        "FirstName": "Jimmy",
153
        "LastName": "JimJam"
154
      },
155
      "ReferenceRange": {
156
        "Low": null,
157
        "High": null,
158
        "Text": null
159
      },
160
      "AbnormalFlag": null
161
    },
162
    {
163
      "DateTime": "2015-08-13T21:08:57.581Z",
164
      "Value": "55",
165
      "ValueType": "Numeric",
166
      "Units": "beats/min",
167
      "Code": "Diastolic",
168
      "Codeset": "RedoxEMR",
169
      "Description": null,
170
      "Status": null,
171
      "Notes": [],
172
      "Observer": {
173
        "ID": "12312",
174
        "IDType": null,
175
        "FirstName": "Jimmy",
176
        "LastName": "JimJam"
177
      },
178
      "ReferenceRange": {
179
        "Low": null,
180
        "High": null,
181
        "Text": null
182
      },
183
      "AbnormalFlag": null
184
    }
185
  ]
186
}