Home
API reference
Redox Data Models
Provider
ProviderQuery

Provider

This data model conveys a provider's demographics, qualifications, and roles. If you persist provider to your system, we recommend using this to keep your database in sync with the EHR system.

Most patient-centric data models like PatientAdmin, Scheduling, and Order have references to provider data. The Provider data model isn't patient-centric, though. It focuses on who the provider is , not the provider's role in regards to the patient's treatment.

This data model has event types that allow you to:

  • receive a notification when provider records are created, updated, or deactivated; or
  • query and receive provider information.

ProviderQuery

Query for provider data from an EHR system.

The required query parameters vary depending on the EHR system you're integrating with. Work with your connection to understand which are required during implementation.

Beta

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Provider

    • EventType
      required, string
      Reliable

      ProviderQuery

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

  • Provider
    object
    • Identifiers
      Array of object

      List of IDs and ID types that identify the provider

      • ID
        string, null
        Reliable

        ID for the provider

      • IDType
        string, null
        Reliable

        Type of ID for the provider

    • Demographics
      object
      • FirstName
        string, null
        Reliable

        Provider's first name

      • LastName
        string, null
        Reliable

        Provider's last name

      • MiddleName
        string, null
        Possible

        Provider's middle name

      • Address
        object

        Provider's address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Provider",
4
    "EventType": "ProviderQuery",
5
    "EventDateTime": "2024-11-18T21:23:08.746Z",
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
  "Provider": {
26
    "Identifiers": [
27
      {
28
        "ID": "4356789876",
29
        "IDType": "NPI"
30
      }
31
    ],
32
    "Demographics": {
33
      "FirstName": "Pat",
34
      "LastName": "Granite",
35
      "MiddleName": "Marie",
36
      "Address": {
37
        "City": null,
38
        "State": null,
39
        "ZIP": null
40
      }
41
    }
42
  }
43
}