Home
API reference
Redox Data Models
PatientSearch
LocationQueryResponse

PatientSearch

This data model allows you to locate a patient record based on incomplete identifying information. You can search for a patient by:

You can only search for a patient at one organization at a time. If you want to search for a patient at multiple organizations, you can use this data model in conjunction with Network Onramps to search a clinical network. Learn about options for patient searches.

This data model has event types that allow you to:

  • query for or receive patient records; or
  • query for and receive a location's information about a patient.

LocationQueryResponse

Receive any known patient identifiers from the location(s) based on the query parameters defined in LocationQuery.

Identifiers are returned in the Patients array, along with any known location information such as organization identifiers, contacts, or addresses.

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      PatientSearch

    • EventType
      required, string
      Reliable

      LocationQueryResponse

    • 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
    required, Array of 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

    • Organization
      object
      • Name
        string, null
        Possible

        The name of the organization

      • Aliases
        Array of string

        Name aliases for this organization

      • Identifiers
        Array of object

        An array of IDs and IDTypes to identify this organization

        • ID
          string, null
          Possible

          The ID for the organization

        • IDType
          string, null
          Possible

          The IDType associated with the ID

      • Contacts
        Array of object

        Any specified contact information for the organization

        • Purpose
          string, null
          Possible

          The contact's role at this organization

        • Name
          string, null
          Possible

          The contact's full name

        • EmailAddresses
          Array of string

          The contact's emails

        • PhoneNumber
          object

          The contact's phone numbers

          • Home
            string, null
            Possible

            The contact's home number

          • Work
            string, null
            Possible

            The contact's work number

          • Mobile
            string, null
            Possible

            The contact's mobile number

      • Address
        object

        The address information for the organization

        • 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

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "PatientSearch",
4
    "EventType": "LocationQueryResponse",
5
    "EventDateTime": "2024-12-20T18:11:36.537Z",
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
      "Organization": {
42
        "Name": "Test Org",
43
        "Aliases": [],
44
        "Identifiers": [
45
          {
46
            "ID": "0000000001",
47
            "IDType": "FACID"
48
          },
49
          {
50
            "ID": "1.2.3.4.5",
51
            "IDType": "OID"
52
          }
53
        ],
54
        "Contacts": [
55
          {
56
            "Purpose": null,
57
            "Name": "Bixby, Barbara",
58
            "EmailAddresses": [
59
              "barb.bixby@test.net"
60
            ],
61
            "PhoneNumber": {
62
              "Home": "+18088675303",
63
              "Work": null,
64
              "Mobile": "+19189368865"
65
            }
66
          }
67
        ],
68
        "Address": {
69
          "StreetAddress": "123 Main St.",
70
          "City": "ATown",
71
          "State": "AL",
72
          "ZIP": "86754",
73
          "County": "Madison",
74
          "Country": "USA"
75
        }
76
      }
77
    }
78
  ]
79
}