Home
API reference
Redox Data Models
PatientAdmin
VisitQueryResponse

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.

VisitQueryResponse

Receive patient and visit details based on the query parameters defined in PatientAdmin.VisitQuery.

Dev preview
Data on Demand Enabled

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      PatientAdmin

    • EventType
      required, string
      Reliable

      VisitQueryResponse

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

  • Patients
    Array of object
    • Identifiers
      Array of object

      List of IDs and ID types that identify the patient

      • ID
        string, null
        Reliable

        ID for the patient

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

    • Visits
      Array of object

      Contains a list of relevant patient visits.

      • VisitNumber
        string, null
        Reliable

        Displays a unique identifier for the patient visit.

      • VisitDateTime
        string, null
        Reliable

        Displays the timestamp for the patient visit or the time that the patient arrived for admission.
        ISO 8601 Format

      • PatientClass
        string, null
        Reliable

        Classifies the department or type of patient care. Patient class is used in many EHR systems to determine where to put the patient (e.g., inpatient, outpatient, emergency).
        Examples: Inpatient, Outpatient, Emergency

      • Location
        object

        Identifies the location of the patient visit.

        • 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

      • Reason
        string, null
        Probable

        Reason for visit.

      • Status
        string, null
        Reliable

        Status of the visit.
        Arrived, Cancelled, Finished, Planned, Unknown

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "PatientAdmin",
4
    "EventType": "VisitQueryResponse",
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
  "Patients": [
26
    {
27
      "Identifiers": [
28
        {
29
          "ID": "0000000001",
30
          "IDType": "MR"
31
        },
32
        {
33
          "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
34
          "IDType": "EHRID"
35
        },
36
        {
37
          "ID": "a1d4ee8aba494ca",
38
          "IDType": "NIST"
39
        }
40
      ],
41
      "Demographics": {
42
        "FirstName": "Timothy",
43
        "MiddleName": "Paul",
44
        "LastName": "Bixby",
45
        "DOB": "2008-01-06",
46
        "SSN": "101-01-0001",
47
        "Sex": "Male",
48
        "Race": "White",
49
        "IsHispanic": null,
50
        "Religion": null,
51
        "MaritalStatus": "Single",
52
        "IsDeceased": null,
53
        "DeathDateTime": null,
54
        "PhoneNumber": {
55
          "Home": "+18088675301",
56
          "Office": null,
57
          "Mobile": null
58
        },
59
        "EmailAddresses": [],
60
        "Language": "en",
61
        "Citizenship": [],
62
        "Address": {
63
          "StreetAddress": "4762 Hickory Street",
64
          "City": "Monroe",
65
          "State": "WI",
66
          "ZIP": "53566",
67
          "County": "Green",
68
          "Country": "US"
69
        }
70
      },
71
      "Visits": [
72
        {
73
          "VisitNumber": "1234",
74
          "VisitDateTime": "2024-11-20T14:08:30.107Z",
75
          "PatientClass": "Inpatient",
76
          "Location": {
77
            "Type": "Inpatient",
78
            "Facility": "RES General Hospital",
79
            "FacilityIdentifiers": [],
80
            "Department": "3N",
81
            "DepartmentIdentifiers": [],
82
            "Room": "136",
83
            "Bed": "B"
84
          },
85
          "Reason": "Check up",
86
          "Status": "Arrived"
87
        }
88
      ]
89
    }
90
  ]
91
}