# Provider New

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. 

Receive a notification when a provider instance is created in the EHR system. 

Status: Beta

## Request body

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

## Example

```json
{
  "Meta": {
    "DataModel": "Provider",
    "EventType": "New",
    "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
  },
  "Providers": [
    {
      "Identifiers": [
        {
          "ID": "4356789876",
          "IDType": "NPI"
        }
      ],
      "IsActive": true,
      "Demographics": {
        "FirstName": "Pat",
        "LastName": "Granite",
        "MiddleName": "Marie",
        "Credentials": [
          "MD"
        ],
        "Addresses": [
          {
            "Use": "Office",
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
          }
        ],
        "EmailAddresses": [
          "pat.granite@redoxengine.com"
        ],
        "PhoneNumber": {
          "Home": "+16085551235",
          "Office": "+16085551234",
          "Mobile": "+16085551236"
        },
        "Sex": "Female",
        "DOB": "1963-01-06",
        "Languages": [
          "English",
          "Spanish"
        ]
      },
      "Qualifications": [
        {
          "Identifiers": [
            {
              "ID": "5421",
              "IDType": null
            }
          ],
          "Code": "MD",
          "Codeset": "http://hl7.org/fhir/v2/0360/2.7",
          "Description": "Doctor of Medicine",
          "StartDate": "2000-02-01",
          "EndDate": null
        }
      ],
      "Roles": [
        {
          "Identifiers": [
            {
              "ID": "12",
              "IDType": null
            }
          ],
          "Organization": {
            "Identifiers": [
              {
                "ID": "135",
                "IDType": null
              }
            ],
            "IsActive": true,
            "Type": "Provider",
            "Name": "Redox Clinic",
            "Address": {
              "StreetAddress": "123 Main St.",
              "City": "Madison",
              "State": "WI",
              "ZIP": "53703",
              "County": "Dane",
              "Country": "USA"
            }
          },
          "Specialties": [
            {
              "Code": "394802001",
              "Codeset": "SnomedCT",
              "Description": "General Medicine"
            }
          ],
          "Locations": [
            {
              "Identifiers": [
                {
                  "ID": "123354",
                  "IDType": null
                }
              ],
              "Status": "active",
              "Name": "Redox Clinic",
              "Description": null,
              "Address": {
                "StreetAddress": "123 Main St",
                "City": "Madison",
                "State": "WI",
                "ZIP": "53703",
                "County": "Dane",
                "Country": "USA"
              },
              "EmailAddresses": [],
              "PhoneNumber": {
                "Office": "+16084455673"
              }
            }
          ],
          "Services": [
            {
              "Identifiers": [
                {
                  "ID": "60",
                  "IDType": null
                }
              ],
              "Type": "Nutrition",
              "Description": "Nutrition",
              "PhoneNumber": {
                "Office": "+16083334985"
              }
            }
          ],
          "Availability": [
            {
              "Days": [
                "Monday",
                "Tuesday"
              ],
              "AvailableStartTime": "09:00",
              "AvailableEndTime": "17:00"
            }
          ]
        }
      ]
    }
  ]
}
```
