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.

EHR support for Provider

An EHR system usually supports exchanging provider data via an MFN HL7v2 feed or their own proprietary API. Just note that MFN interfaces aren't common. However, the setup is site-specific, and we recommend talking with your connection to see what they support.

ProviderQueryResponse

Receive the relevant provider data based on the query parameters defined in ProviderQuery.

The populated response will vary depending on the EHR system you're integrating with. Work with your connection to understand what response to expect during implementation.

Beta

Request Body Schema

Show Required Fields Only

Show Translation Fields

Meta
required, object
- DataModel
  required, string
  Reliable
  Provider
- EventType
  required, string
  Reliable
  ProviderQueryResponse
- 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.
Providers
required, Array of object
The list of providers
- Identifiers
  required, Array of object
  Lists one or more identifiers associated with the provider.
  ID
  required, string
  Reliable
  Displays an identifier used to identify the provider in the EHR system.
  IDType
  string, null
  Reliable
  Displays the type of identifier used to identify the provider.
  e.g. NPI
- IsActive
  required, boolean
  Reliable
  Indicates whether the given provider is actively practicing or not.
- Demographics
  object
  FirstName
  string, null
  Reliable
  Displays the provider's first name.
  LastName
  string, null
  Reliable
  Displays the provider's last name
  MiddleName
  string, null
  Possible
  Displays the provider's middle name
  Credentials
  Array of string
  Lists the provider’s relevant credentials.
  e.g. MD, PhD
  Addresses
  Array of object
  Displays a list of addresses associated with the provider.
  These are addresses where the practitioner performs services, not residential addresses.
  Use
  string, null
  Reliable
  The use for this address.
  e.g. Home, Office
  StreetAddress
  string, null
  Reliable
  Displays the street for a given address.
  City
  string, null
  Reliable
  Displays the city for a given address.
  State
  string, null
  Reliable
  Displays the state for a given address.
  ZIP
  string, null
  Reliable
  Displays the postal code for a given address.
  County
  string, null
  Reliable
  Displays the county for a given address.
  Country
  string, null
  Reliable
  Displays the country for a given address.
  EmailAddresses
  Array of string
  Contains contact information for the provider, specifically any email addresses associated with the provider.
  PhoneNumber
  object
  Home
  string, null
  Probable
  Contains contact information for the provider, specifically any home phone numbers associated with the provider.
  In E. 164 Format. (e.g. +16085551234)
  Office
  string, null
  Reliable
  Contains contact information for the provider, specifically any office phone numbers associated with the provider.
  In E. 164 Format. (e.g. +16085551234)
  Mobile
  string, null
  Probable
  Contains contact information for the provider, specifically any mobile phone numbers associated with the provider.
  In E. 164 Format. (e.g. +16085551234)
  Sex
  string, null
  Reliable
  Value Set
  Displays the provider's sex.
  DOB
  string, null
  Reliable
  Displays the provider's date of birth.
  In ISO 8601 format
  Languages
  Array of string
  Lists one or more languages that the provider can use to communicate with patients.
- Qualifications
  Array of object
  Lists one or more qualifications the provider has obtained through professional training and certification.
  Identifiers
  Array of object
  Displays a list of identifiers and types for a given qualification.
  ID
  string, null
  Reliable
  Displays a string identifier provided by a third-party system for the given qualification.
  IDType
  string, null
  Reliable
  Displays the type of the identifier for the given qualification.
  Code
  string, null
  Reliable
  Displays a coded representation of the given qualification.
  Codeset
  string, null
  Reliable
  Displays the codeset associated with the provided code.
  Description
  string, null
  Reliable
  Contains a human-readable description of the given qualification.
  StartDate
  string, null
  Reliable
  Displays the date that the given qualification is valid.
  In ISO 8601 format
  EndDate
  string, null
  Reliable
  Displays the date that the given qualification expires.
  In ISO 8601 format
- Roles
  Array of object
  Contains the role(s) that the provider has served or currently serves in.
  Identifiers
  Array of object
  Displays a list of identifiers and and types for the given role.
  ID
  string, null
  Reliable
  Displays a string identifier provided by a third-party system for the given role.
  IDType
  string, null
  Reliable
  Defines the type of identifier for the given role.
  Organization
  object
  Describes the organization where the provider has or currently operates in the given role.
  Identifiers
  Array of object
  Lists one or more identifiers for the organization associated with the role.
  ID
  string, null
  Reliable
  Displays a string identifier provided by a third-party system for the given organization.
  IDType
  string, null
  Reliable
  Displays the type of the identifier for the given organization.
  IsActive
  string, null
  Reliable
  Indicates whether the given organization is currently active.
  Type
  string, null
  Reliable
  Describes the type of the organization associated with the role.
  Name
  string, null
  Reliable
  Displays the name of the organization associated with the role.
  Address
  object
  StreetAddress
  string, null
  Reliable
  Displays the street address where the organization is based.
  City
  string, null
  Reliable
  Displays the city where the organization is based.
  State
  string, null
  Reliable
  Displays the state where the organization is based.
  ZIP
  string, null
  Reliable
  Displays the postal code where the organization is based.
  County
  string, null
  Reliable
  Displays the county where the organization is based.
  Country
  string, null
  Reliable
  Displays the country where the organization is based.
  Specialties
  Array of object
  Lists the coded representation of a given specialty associated with the role.
  Code
  string, null
  Probable
  Code
  Codeset
  string, null
  Probable
  Code set
  Description
  string, null
  Probable
  Description
  Locations
  Array of object
  Lists the specific facilities where the provider provides care while serving in the given role.
  Identifiers
  Array of object
  Displays a list of identifiers and types that identify the location/
  ID
  string, null
  Reliable
  Displays a string identifier provided by a third-party system for the given location.
  IDType
  string, null
  Reliable
  Displays the type of the identifier for the given location.
  Status
  string, null
  Reliable
  Indicates whether the given location is currently active, suspended, or inactive.
  One of Active, Suspended, Inactive
  Name
  string, null
  Reliable
  Displays the name of the given location.
  Description
  string, null
  Reliable
  Contains a human-readable description of the given location.
  Address
  object
  StreetAddress
  string, null
  Reliable
  Displays the street for the given location.
  City
  string, null
  Reliable
  Displays the city for the current location.
  State
  string, null
  Reliable
  Displays the state/province for the given location.
  ZIP
  string, null
  Reliable
  Displays the postal code for the given location.
  County
  string, null
  Reliable
  Displays the county for the given location.
  Country
  string, null
  Reliable
  Displays the country for the given location.
  EmailAddresses
  Array of string
  Contains contact information for the location, specifically the email address(es).
  PhoneNumber
  object
  Office
  string, null
  Reliable
  Contains contact information for the location, specifically the phone number(s).
  In E. 164 Format. (e.g. +16085551234)
  Services
  Array of object
  Describes the healthcare services that the provider offers while serving in the given role.
  Identifiers
  Array of object
  Lists one or more identifiers for the healthcare services associated with the role.
  ID
  string, null
  Reliable
  Displays a string identifier provided by a third-party system for the given service.
  IDType
  string, null
  Reliable
  Defines the type of identifier for the given service
  Type
  string, null
  Reliable
  Describes the type of healthcare service that may be delivered or performed for the given service.
  Description
  string, null
  Reliable
  Contains a human-readable description of the given service.
  PhoneNumber
  object
  Office
  string, null
  Reliable
  Displays the office phone number for information on the given service.
  In E. 164 Format. (e.g. +16085551234)
  Availability
  Array of object
  Defines the provider’s availability (day/time) when serving in the given role. OR Lists the typical days/times that the provider serves in the given role.
  Days
  Array of string
  Displays a list of days that the given role is available.
  One of the following: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
  AvailableStartTime
  string, null
  Reliable
  Displays the UTC start time for the provider's availability in the given role.
  ISO 8601 Format
  AvailableEndTime
  string, null
  Reliable
  Displays the UTC end time for the provider’s availability in the given role.
  ISO 8601 Format

Value
Female
Male
Unknown
Other
Nonbinary
Prefer not to answer

Example

json

1
{
2
  "Meta": {
3
    "DataModel": "Provider",
4
    "EventType": "ProviderQueryResponse",
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
  "Providers": [
26
    {
27
      "Identifiers": [
28
        {
29
          "ID": "4356789876",
30
          "IDType": "NPI"
31
        }
32
      ],
33
      "IsActive": true,
34
      "Demographics": {
35
        "FirstName": "Pat",
36
        "LastName": "Granite",
37
        "MiddleName": "Marie",
38
        "Credentials": [
39
          "MD"
40
        ],
41
        "Addresses": [
42
          {
43
            "Use": "Office",
44
            "StreetAddress": "123 Main St.",
45
            "City": "Madison",
46
            "State": "WI",
47
            "ZIP": "53703",
48
            "County": "Dane",
49
            "Country": "USA"
50
          }
51
        ],
52
        "EmailAddresses": [
53
          "pat.granite@redoxengine.com"
54
        ],
55
        "PhoneNumber": {
56
          "Home": "+16085551235",
57
          "Office": "+16085551234",
58
          "Mobile": "+16085551236"
59
        },
60
        "Sex": "Female",
61
        "DOB": "1963-01-06",
62
        "Languages": [
63
          "English",
64
          "Spanish"
65
        ]
66
      },
67
      "Qualifications": [
68
        {
69
          "Identifiers": [
70
            {
71
              "ID": "5421",
72
              "IDType": null
73
            }
74
          ],
75
          "Code": "MD",
76
          "Codeset": "http://hl7.org/fhir/v2/0360/2.7",
77
          "Description": "Doctor of Medicine",
78
          "StartDate": "2000-02-01",
79
          "EndDate": null
80
        }
81
      ],
82
      "Roles": [
83
        {
84
          "Identifiers": [
85
            {
86
              "ID": "12",
87
              "IDType": null
88
            }
89
          ],
90
          "Organization": {
91
            "Identifiers": [
92
              {
93
                "ID": "135",
94
                "IDType": null
95
              }
96
            ],
97
            "IsActive": true,
98
            "Type": "Provider",
99
            "Name": "Redox Clinic",
100
            "Address": {
101
              "StreetAddress": "123 Main St.",
102
              "City": "Madison",
103
              "State": "WI",
104
              "ZIP": "53703",
105
              "County": "Dane",
106
              "Country": "USA"
107
            }
108
          },
109
          "Specialties": [
110
            {
111
              "Code": "394802001",
112
              "Codeset": "SnomedCT",
113
              "Description": "General Medicine"
114
            }
115
          ],
116
          "Locations": [
117
            {
118
              "Identifiers": [
119
                {
120
                  "ID": "123354",
121
                  "IDType": null
122
                }
123
              ],
124
              "Status": "active",
125
              "Name": "Redox Clinic",
126
              "Description": null,
127
              "Address": {
128
                "StreetAddress": "123 Main St",
129
                "City": "Madison",
130
                "State": "WI",
131
                "ZIP": "53703",
132
                "County": "Dane",
133
                "Country": "USA"
134
              },
135
              "EmailAddresses": [],
136
              "PhoneNumber": {
137
                "Office": "+16084455673"
138
              }
139
            }
140
          ],
141
          "Services": [
142
            {
143
              "Identifiers": [
144
                {
145
                  "ID": "60",
146
                  "IDType": null
147
                }
148
              ],
149
              "Type": "Nutrition",
150
              "Description": "Nutrition",
151
              "PhoneNumber": {
152
                "Office": "+16083334985"
153
              }
154
            }
155
          ],
156
          "Availability": [
157
            {
158
              "Days": [
159
                "Monday",
160
                "Tuesday"
161
              ],
162
              "AvailableStartTime": "09:00",
163
              "AvailableEndTime": "17:00"
164
            }
165
          ]
166
        }
167
      ]
168
    }
169
  ]
170
}

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.