Home
API reference
Redox Data Models
PatientAdmin
VisitQuery

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.

VisitQuery

Query for more in-depth patient demographics and visit information after receiving other PatientAdmin event types. Results are returned in PatientAdmin.VisitQueryReponse.

Dev preview
Data on Demand Enabled

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      PatientAdmin

    • EventType
      required, string
      Reliable

      VisitQuery

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

  • PatientClasses
    Array of string

    Specify one or more classes of encounters to return (e.g., inpatient, outpatient, emergency). Any encounters with an unknown patient class won't be returned if this parameter is defined in a query.

  • Departments
    Array of string

    Specify one or more departments to filter the census results. If multiple departments are specified, the results will include all patient visits with any of the specified departments.

  • Facilities
    Array of string

    Specify one or more facilities to filter the census results. If multiple facilities are included, the results will contain all patient visits in any of the specified facilities.
    If both facility and department are specified, the results will only include patient visits that match both the facility and the department.

  • VisitStatuses
    Array of string

    One or more statuses of visits to query.
    Arrived, Cancelled, Finished, Planned, Unknown

  • Patients
    Array of object

    Array of patients to filter visits on.
    If multiple patients are provided, visits associated with any of the patients will be returned.

    • Identifiers
      Array of object

      List of IDs and ID types that identify the patient.
      If multiple identifiers are provided, only patients with all identifiers will be considered.

      • ID
        string, null
        Possible

        ID of the Patient

      • IDType
        string, null
        Possible

        ID Type for the corresponding ID of this patient (ie. MRN, EHRID)

  • VisitNumbers
    Array of string

    One or more identifiers for the visit.
    If multiple are provided, multiple visits may be returned.

  • VisitStartDateTime
    string, null
    Possible

    Start of the time range to search for the visit.
    ISO 8601 Format

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "PatientAdmin",
4
    "EventType": "VisitQuery",
5
    "EventDateTime": "2024-12-30T21:17:00.927Z",
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
  "PatientClasses": [],
26
  "Departments": [
27
    "3N"
28
  ],
29
  "Facilities": [
30
    "RES General Hospital"
31
  ],
32
  "VisitStatuses": [
33
    "Arrived"
34
  ],
35
  "Patients": [
36
    {
37
      "Identifiers": [
38
        {
39
          "ID": "0000000001",
40
          "IDType": "MR"
41
        },
42
        {
43
          "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
44
          "IDType": "EHRID"
45
        },
46
        {
47
          "ID": "a1d4ee8aba494ca",
48
          "IDType": "NIST"
49
        }
50
      ]
51
    }
52
  ],
53
  "VisitNumbers": [
54
    "1234",
55
    "5678"
56
  ],
57
  "VisitStartDateTime": "2024-12-30T21:17:01.220Z"
58
}