Home
API reference
Redox Data Models
PatientAdmin
PatientUpdate

PatientAdmin

This data model allows you to stay up-to-date on documented patient demographics, insurance, and the patient identifier used by the EHR system (usually an MRN). PatientAdmin relies on an admission, discharge, and transfer (ADT) feed from a provider.

PatientAdmin data can vary, but there are two main categories of data:

  • Patient-level: Information about the patient that persists over time (e.g., name, address, gender, DOB, email address, primary care provider) that isn't tied to a particular encounter.
  • Visit-level: Information pertaining to the patient's visit (e.g., the current location within the hospital, referring provider, admitting provider, care team, or discharge date/time).

This data model has event types that allow you to:

  • receive a notification about patient appointments or records;
  • query for and receive a list of admitted patients; or
  • query for and receive patient visit information.

PatientUpdate

Receive a notification when any patient or registration information changes while the patient isn't currently admitted.

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      PatientAdmin

    • EventType
      required, string
      Reliable

      PatientUpdate

    • 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

    • Diagnoses
      Array of object

      Contains a list of diagnoses associated with this patient visit.

      • Code
        string, null
        Probable

        Code for the diagnosis

      • Codeset
        string, null
        Probable
        Value Set

        Code set used to identify the diagnosis.
        One of the following: ICD-9, ICD-10, HCPCS, CPT

      • Name
        string, null
        Probable

        Name of the diagnosis

      • Type
        string, null
        Possible
        Value Set

        Type of the diagnosis

      • DocumentedDateTime
        string, null
        Possible

        DateTime the diagnosis was documented.
        ISO 8601 Format

    • Allergies
      Array of object

      Contains a list of the patient's allergies.

      • Code
        string, null
        Possible

        Code for the allergy

      • Codeset
        string, null
        Possible

        Code set used to identify the allergy.
        Typically RxNorm or SNOMED.

      • Name
        string, null
        Possible

        Name of the allergy

      • Type
        object

        Defines the type of allergy intolerance (e.g., food, drug).

        • Code
          string, null
          Possible

          Code for the allergy intolerance type

        • Codeset
          string, null
          Possible

          Code set used to identify the allergy intolerance type

        • Name
          string, null
          Possible

          Name of the allergy intolerance type

      • OnsetDateTime
        string, null
        Possible

        Displays the date and time that the patient first observed the allergy.

      • Reaction
        Array of object

        Contains a list of reactions caused by the identified allergy.

        • Code
          string, null
          Possible

          Code for the reaction

        • Codeset
          string, null
          Possible

          Code set used to identify the reaction

        • Name
          string, null
          Possible

          Name of the reaction

      • Severity
        object

        Contains details about the severity of the allergic reaction (e.g., moderate, severe).

        • Code
          string, null
          Possible

          Code for the reaction severity

        • Codeset
          string, null
          Possible

          Code set used to identify the reaction severity

        • Name
          string, null
          Possible

          Name of the reaction severity

      • Status
        string, null
        Possible

        Displays the current status of the allergy (e.g., active, inactive, resolved).

    • PCP
      object

      Displays the name of the patient's primary care provider.

      • NPI
        string, null
        Reliable

        NPI of the PCP

      • ID
        string, null
        Reliable

        ID of the PCP.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Reliable

        ID type of the ID for the PCP

      • FirstName
        string, null
        Possible

        First name of the PCP

      • LastName
        string, null
        Possible

        Last name of the PCP

      • Credentials
        Array of string

        List of credentials for the PCP.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • 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

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

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

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

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

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

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

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

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

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • Insurances
      Array of object

      List of insurance coverages for the patient

      • Plan
        object
        • ID
          string, null
          Probable

          Identifier of insurance plan

        • IDType
          string, null
          Probable

          ID type of insurance plan

        • Name
          string, null
          Probable

          Name of insurance plan

        • Type
          string, null
          Possible

          Type of insurance plan

      • MemberNumber
        string, null
        Possible

        Patient member number

      • Company
        object
        • ID
          string, null
          Probable

          ID of insurance company (payor)

        • IDType
          string, null
          Probable

          ID type of insurance company (payor)

        • Name
          string, null
          Probable

          Name of insurance company (payor)

        • Address
          object

          Insurance company's 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

        • PhoneNumber
          string, null
          Probable

          Insurance companys phone number.
          In E. 164 Format (i.e. +16085551234)

      • GroupNumber
        string, null
        Probable

        Insurance policy group number

      • GroupName
        string, null
        Probable

        Insurance policy group name

      • EffectiveDate
        string, null
        Probable

        Effect date of this insurance policy.
        In YYYY-MM-DD format

      • ExpirationDate
        string, null
        Probable

        Expiration date of this insurance policy.
        In YYYY-MM-DD format

      • PolicyNumber
        string, null
        Probable

        Insurance policy number

      • Priority
        string, null
        Possible
        Value Set

        The insurance priority sequence.
        If the insurance works in conjunction with other insurance plans, this field contains priority sequence.

      • AgreementType
        string, null
        Probable
        Value Set

        Type of insurance agreement.

      • CoverageType
        string, null
        Probable
        Value Set

        Type of insurance agreement.
        Indicates who will be receiving the bill for the service.

      • Insured
        object

        Individual who has the agreement with the insurance company for the related policy

        • Identifiers
          Array of object

          List of IDs and ID types that identify the insured

          • ID
            string, null
            Possible

            ID for the insured

          • IDType
            string, null
            Possible

            Type of ID.
            E.g. MRN, EPI

        • LastName
          string, null
          Possible

          Last name of the insured

        • MiddleName
          string, null
          Possible

          Middle name of the insured

        • FirstName
          string, null
          Possible

          First name of the insured

        • SSN
          string, null
          Possible

          Insured's social security number

        • Relationship
          string, null
          Possible
          Value Set

          Relationship of the insured to the patient

        • DOB
          string, null
          Possible

          Date of birth of the insured.
          In YYYY-MM-DD format

        • Sex
          string, null
          Possible
          Value Set

          Sex of the insured

        • Address
          object

          Address of the insured

          • 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

    • Guarantor
      object

      Person ultimately responsible for the bill for the patient.

      • Number
        string, null
        Probable

        Number of the guarantor

      • FirstName
        string, null
        Probable

        First name

      • MiddleName
        string, null
        Possible

        Middle name

      • LastName
        string, null
        Probable

        Last name

      • SSN
        string, null
        Possible

        Guarantor's social security number

      • DOB
        string, null
        Possible

        Guarantor's date of birth.
        In ISO 8601 format

      • Sex
        string, null
        Possible
        Value Set

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

      • Spouse
        object
        • FirstName
          string, null
          Probable

          Spouse's first name

        • LastName
          string, null
          Probable

          Spouse's last name

      • Address
        object

        Address of the guarantor

        • 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

      • PhoneNumber
        object
        • Home
          string, null
          Probable

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

        • Business
          string, null
          Probable

          Business phone number.
          In E. 164 Format (i.e. +16085551234)

        • Mobile
          string, null
          Probable

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

      • EmailAddresses
        Array of string

        Guarantor's email address(es)

      • Type
        string, null
        Probable

        Type of guarantor.
        E.g. institution, individual

      • RelationToPatient
        string, null
        Probable
        Value Set

        Relation to the patient

      • Employer
        object
        • Name
          string, null
          Probable

          Employer's name

        • Address
          object

          Employer's 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

        • PhoneNumber
          string, null
          Probable

          Employer phone number.
          In E. 164 Format (i.e. +16085551234)

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "PatientAdmin",
4
    "EventType": "PatientUpdate",
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": "4435 Victoria Ln",
63
        "City": "Madison",
64
        "State": "WI",
65
        "ZIP": "53719",
66
        "County": "Dane",
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
    "Diagnoses": [
99
      {
100
        "Code": "R07.0",
101
        "Codeset": "ICD-10",
102
        "Name": "Pain in throat",
103
        "Type": null,
104
        "DocumentedDateTime": null
105
      }
106
    ],
107
    "Allergies": [
108
      {
109
        "Code": "7982",
110
        "Codeset": "RxNorm",
111
        "Name": "Penicillin",
112
        "Type": {
113
          "Code": null,
114
          "Codeset": null,
115
          "Name": null
116
        },
117
        "OnsetDateTime": null,
118
        "Reaction": [
119
          {
120
            "Code": "28926001",
121
            "Codeset": "SNOMED CT",
122
            "Name": "Rash"
123
          },
124
          {
125
            "Code": "247472004",
126
            "Codeset": "SNOMED CT",
127
            "Name": "Hives"
128
          }
129
        ],
130
        "Severity": {
131
          "Code": null,
132
          "Codeset": null,
133
          "Name": null
134
        },
135
        "Status": null
136
      }
137
    ],
138
    "PCP": {
139
      "NPI": "4356789876",
140
      "ID": "4356789876",
141
      "IDType": "NPI",
142
      "FirstName": "Pat",
143
      "LastName": "Granite",
144
      "Credentials": [
145
        "MD"
146
      ],
147
      "Address": {
148
        "StreetAddress": "123 Main St.",
149
        "City": "Madison",
150
        "State": "WI",
151
        "ZIP": "53703",
152
        "County": "Dane",
153
        "Country": "USA"
154
      },
155
      "EmailAddresses": [],
156
      "PhoneNumber": {
157
        "Office": "+16085551234"
158
      },
159
      "Location": {
160
        "Type": null,
161
        "Facility": null,
162
        "FacilityIdentifiers": [],
163
        "Department": null,
164
        "DepartmentIdentifiers": [],
165
        "Room": null
166
      }
167
    },
168
    "Insurances": [
169
      {
170
        "Plan": {
171
          "ID": "31572",
172
          "IDType": "Payor ID",
173
          "Name": "HMO Deductible Plan",
174
          "Type": null
175
        },
176
        "MemberNumber": null,
177
        "Company": {
178
          "ID": "60054",
179
          "IDType": null,
180
          "Name": "aetna (60054 0131)",
181
          "Address": {
182
            "StreetAddress": "PO Box 14080",
183
            "City": "Lexington",
184
            "State": "KY",
185
            "ZIP": "40512-4079",
186
            "County": "Fayette",
187
            "Country": "US"
188
          },
189
          "PhoneNumber": "+18089541123"
190
        },
191
        "GroupNumber": "847025-024-0009",
192
        "GroupName": "Accelerator Labs",
193
        "EffectiveDate": "2015-01-01",
194
        "ExpirationDate": "2020-12-31",
195
        "PolicyNumber": "9140860055",
196
        "Priority": null,
197
        "AgreementType": null,
198
        "CoverageType": null,
199
        "Insured": {
200
          "Identifiers": [],
201
          "LastName": null,
202
          "MiddleName": null,
203
          "FirstName": null,
204
          "SSN": null,
205
          "Relationship": null,
206
          "DOB": null,
207
          "Sex": null,
208
          "Address": {
209
            "StreetAddress": null,
210
            "City": null,
211
            "State": null,
212
            "ZIP": null,
213
            "County": null,
214
            "Country": null
215
          }
216
        }
217
      }
218
    ],
219
    "Guarantor": {
220
      "Number": "10001910",
221
      "FirstName": "Kent",
222
      "MiddleName": null,
223
      "LastName": "Bixby",
224
      "SSN": null,
225
      "DOB": null,
226
      "Sex": null,
227
      "Spouse": {
228
        "FirstName": "Barbara",
229
        "LastName": "Bixby"
230
      },
231
      "Address": {
232
        "StreetAddress": "4762 Hickory Street",
233
        "City": "Monroe",
234
        "State": "WI",
235
        "ZIP": "53566",
236
        "County": "Green",
237
        "Country": "USA"
238
      },
239
      "PhoneNumber": {
240
        "Home": null,
241
        "Business": null,
242
        "Mobile": null
243
      },
244
      "EmailAddresses": [],
245
      "Type": null,
246
      "RelationToPatient": "Father",
247
      "Employer": {
248
        "Name": "Accelerator Labs",
249
        "Address": {
250
          "StreetAddress": "1456 Old Sauk Road",
251
          "City": "Madison",
252
          "State": "WI",
253
          "ZIP": "53719",
254
          "County": "Dane",
255
          "Country": "USA"
256
        },
257
        "PhoneNumber": "+18083451121"
258
      }
259
    }
260
  }
261
}