# Provider ProviderQuery

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. 

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.

Status: Beta

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Provider |
| `Meta.EventType` | string | Yes | ProviderQuery |
| `Meta.EventDateTime` | string or null | No | Displays the UTC date and time that an outgoing request is delivered or an incoming request is received. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Meta.Test` | boolean or null | No | Indicates whether the request is a test or not. |
| `Meta.Source` | object | No | Contains the information for the system initiating the message, including the source ID and name. *Included in messages from Redox* |
| `Meta.Source.ID` | string or null | No | 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* |
| `Meta.Source.Name` | string or null | No | Displays the name of the system initiating the message. |
| `Meta.Destinations` | Array of object | No | 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.* |
| `Meta.Destinations[].ID` | string or null | No | Identifies the endpoint that the request is directed to. *UUID* |
| `Meta.Destinations[].Name` | string or null | No | Displays the name of the endpoint that the request is directed to. |
| `Meta.Logs` | Array of object | No | Contains the log identifier(s) for the request. |
| `Meta.Logs[].ID` | string or null | No | 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* |
| `Meta.Logs[].AttemptID` | string or null | No | Identifies the request log attempt value, which is useful when retries are possible. *UUID* |
| `Meta.FacilityCode` | string or null | No | 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 | No |  |
| `Provider.Identifiers` | Array of object | No | List of IDs and ID types that identify the provider |
| `Provider.Identifiers[].ID` | string or null | No | ID for the provider |
| `Provider.Identifiers[].IDType` | string or null | No | Type of ID for the provider |
| `Provider.Demographics` | object | No |  |
| `Provider.Demographics.FirstName` | string or null | No | Provider's first name |
| `Provider.Demographics.LastName` | string or null | No | Provider's last name |
| `Provider.Demographics.MiddleName` | string or null | No | Provider's middle name |
| `Provider.Demographics.Address` | object | No | Provider's address |
| `Provider.Demographics.Address.City` | string or null | No | City |
| `Provider.Demographics.Address.State` | string or null | No | State |
| `Provider.Demographics.Address.ZIP` | string or null | No | ZIP |

## Example

```json
{
  "Meta": {
    "DataModel": "Provider",
    "EventType": "ProviderQuery",
    "EventDateTime": "2026-11-18T19:05:05.809Z",
    "Test": true,
    "Source": {
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
      "Name": "Redox Dev Tools"
    },
    "Destinations": [
      {
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
        "Name": "Redox EMR"
      }
    ],
    "Logs": [
      {
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
      }
    ],
    "FacilityCode": null
  },
  "Provider": {
    "Identifiers": [
      {
        "ID": "4356789876",
        "IDType": "NPI"
      }
    ],
    "Demographics": {
      "FirstName": "Pat",
      "LastName": "Granite",
      "MiddleName": "Marie",
      "Address": {
        "City": null,
        "State": null,
        "ZIP": null
      }
    }
  }
}
```
