Redox | Provider

Provider

The Provider data model contains a provider's demographics, qualifications, and roles. If you persist provider data to your system, we recommend using this to keep your database in sync with the EHR system. Healthcare organizations that support the Provider data model trigger messages when provider records are created, updated, or deactivated.

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

A healthcare organization can typically send Provider data via an MFN HL7v2 feed or their own proprietary API. Just note that MFN interfaces aren't incredibly common. However, the setup is site-specific, and we recommend talking with your connection to see what they support.

New
Update
Activate
Deactivate
ProviderQuery
ProviderQueryResponse

New

BETA

A New message is used to convey provider instances that have just been created.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Provider
- Meta.EventType
  String
  Reliable
  Required
  ProviderQueryResponse
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  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
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  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
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  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
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  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
- Providers[]
  Array of Objects
  Reliable
  The list of providers
- Providers[].Identifiers[]
  Array of Objects
  Reliable
  Lists one or more identifiers associated with the provider.
- Providers[].Identifiers[].ID
  String
  Reliable
  Required
  Displays an identifier used to identify the provider in the EHR system.
- Providers[].Identifiers[].IDType
  String
  Reliable
  Displays the type of identifier used to identify the provider.
  e.g. NPI
- Providers[].IsActive
  Boolean
  Reliable
  Required
  Indicates whether the given provider is actively practicing or not.
- Providers[].Demographics.FirstName
  String
  Reliable
  Displays the provider's first name.
- Providers[].Demographics.LastName
  String
  Reliable
  Displays the provider's last name
- Providers[].Demographics.MiddleName
  String
  Possible
  Displays the provider's middle name
- Providers[].Demographics.Credentials[]
  Array of Strings
  Possible
  Lists the provider’s relevant credentials.
  e.g. MD, PhD
- Providers[].Demographics.Addresses[]
  Array of Objects
  Probable
  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
  Reliable
  The use for this address.
  e.g. Home, Office
- Providers[].Demographics.Addresses[].StreetAddress
  String
  Reliable
  Displays the street for a given address.
- Providers[].Demographics.Addresses[].City
  String
  Reliable
  Displays the city for a given address.
- Providers[].Demographics.Addresses[].State
  String
  Reliable
  Displays the state for a given address.
- Providers[].Demographics.Addresses[].ZIP
  String
  Reliable
  Displays the postal code for a given address.
- Providers[].Demographics.Addresses[].County
  String
  Reliable
  Displays the county for a given address.
- Providers[].Demographics.Addresses[].Country
  String
  Reliable
  Displays the country for a given address.
- Providers[].Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Contains contact information for the provider, specifically any email addresses associated with the provider.
- Providers[].Demographics.PhoneNumber.Home
  String
  Probable
  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
  Reliable
  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
  Probable
  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
  Reliable
  ValueSet
  Displays the provider's sex.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Providers[].Demographics.DOB
  String
  Reliable
  Displays the provider's date of birth.
  In ISO 8601 format
- Providers[].Demographics.Languages[]
  Array of Strings
  Reliable
  Lists one or more languages that the provider can use to communicate with patients.
- Providers[].Qualifications[]
  Array of Objects
  Possible
  Lists one or more qualifications the provider has obtained through professional training and certification.
- Providers[].Qualifications[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and types for a given qualification.
- Providers[].Qualifications[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given qualification.
- Providers[].Qualifications[].Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given qualification.
- Providers[].Qualifications[].Code
  String
  Reliable
  Displays a coded representation of the given qualification.
- Providers[].Qualifications[].Codeset
  String
  Reliable
  Displays the codeset associated with the provided code.
- Providers[].Qualifications[].Description
  String
  Reliable
  Contains a human-readable description of the given qualification.
- Providers[].Qualifications[].StartDate
  String
  Reliable
  Displays the date that the given qualification is valid.
  In ISO 8601 format
- Providers[].Qualifications[].EndDate
  String
  Reliable
  Displays the date that the given qualification expires.
  In ISO 8601 format
- Providers[].Roles[]
  Array of Objects
  Probable
  Contains the role(s) that the provider has served or currently serves in.
- Providers[].Roles[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and and types for the given role.
- Providers[].Roles[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given role.
- Providers[].Roles[].Identifiers[].IDType
  String
  Reliable
  Defines the type of identifier for the given role.
- Providers[].Roles[].Organization
  Object
  Reliable
  Describes the organization where the provider has or currently operates in the given role.
- Providers[].Roles[].Organization.Identifiers[]
  Array of Objects
  Reliable
  Lists one or more identifiers for the organization associated with the role.
- Providers[].Roles[].Organization.Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given organization.
- Providers[].Roles[].Organization.Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given organization.
- Providers[].Roles[].Organization.IsActive
  String
  Reliable
  Indicates whether the given organization is currently active.
- Providers[].Roles[].Organization.Type
  String
  Reliable
  Describes the type of the organization associated with the role.
- Providers[].Roles[].Organization.Name
  String
  Reliable
  Displays the name of the organization associated with the role.
- Providers[].Roles[].Organization.Address.StreetAddress
  String
  Reliable
  Displays the street address where the organization is based.
- Providers[].Roles[].Organization.Address.City
  String
  Reliable
  Displays the city where the organization is based.
- Providers[].Roles[].Organization.Address.State
  String
  Reliable
  Displays the state where the organization is based.
- Providers[].Roles[].Organization.Address.ZIP
  String
  Reliable
  Displays the postal code where the organization is based.
- Providers[].Roles[].Organization.Address.County
  String
  Reliable
  Displays the county where the organization is based.
- Providers[].Roles[].Organization.Address.Country
  String
  Reliable
  Displays the country where the organization is based.
- Providers[].Roles[].Specialties[]
  Array of Objects
  Probable
  Lists the coded representation of a given specialty associated with the role.
- Providers[].Roles[].Specialties[].Code
  String
  Probable
  Code
- Providers[].Roles[].Specialties[].Codeset
  String
  Probable
  Code set
- Providers[].Roles[].Specialties[].Description
  String
  Probable
  Description
- Providers[].Roles[].Locations[]
  Array of Objects
  Reliable
  Lists the specific facilities where the provider provides care while serving in the given role.
- Providers[].Roles[].Locations[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and types that identify the location/
- Providers[].Roles[].Locations[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given location.
- Providers[].Roles[].Locations[].Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given location.
- Providers[].Roles[].Locations[].Status
  String
  Reliable
  Indicates whether the given location is currently active, suspended, or inactive.
  One of Active, Suspended, Inactive
- Providers[].Roles[].Locations[].Name
  String
  Reliable
  Displays the name of the given location.
- Providers[].Roles[].Locations[].Description
  String
  Reliable
  Contains a human-readable description of the given location.
- Providers[].Roles[].Locations[].Address.StreetAddress
  String
  Reliable
  Displays the street for the given location.
- Providers[].Roles[].Locations[].Address.City
  String
  Reliable
  Displays the city for the current location.
- Providers[].Roles[].Locations[].Address.State
  String
  Reliable
  Displays the state/province for the given location.
- Providers[].Roles[].Locations[].Address.ZIP
  String
  Reliable
  Displays the postal code for the given location.
- Providers[].Roles[].Locations[].Address.County
  String
  Reliable
  Displays the county for the given location.
- Providers[].Roles[].Locations[].Address.Country
  String
  Reliable
  Displays the country for the given location.
- Providers[].Roles[].Locations[].EmailAddresses[]
  Array of Strings
  Reliable
  Contains contact information for the location, specifically the email address(es).
- Providers[].Roles[].Locations[].PhoneNumber.Office
  String
  Reliable
  Contains contact information for the location, specifically the phone number(s).
  In E. 164 Format. (e.g. +16085551234)
- Providers[].Roles[].Services[]
  Array of Objects
  Reliable
  Describes the healthcare services that the provider offers while serving in the given role.
- Providers[].Roles[].Services[].Identifiers[]
  String
  Reliable
  Lists one or more identifiers for the healthcare services associated with the role.
- Providers[].Roles[].Services[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given service.
- Providers[].Roles[].Services[].Identifiers[].IDType
  String
  Reliable
  Defines the type of identifier for the given service
- Providers[].Roles[].Services[].Type
  String
  Reliable
  Describes the type of healthcare service that may be delivered or performed for the given service.
- Providers[].Roles[].Services[].Description
  String
  Reliable
  Contains a human-readable description of the given service.
- Providers[].Roles[].Services[].PhoneNumber.Office
  String
  Reliable
  Displays the office phone number for information on the given service.
  In E. 164 Format. (e.g. +16085551234)
- Providers[].Roles[].Availability[]
  Array of Objects
  Possible
  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 Strings
  Reliable
  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
  Time
  Reliable
  Displays the UTC start time for the provider's availability in the given role.
  ISO 8601 Format
- Providers[].Roles[].Availability[].AvailableEndTime
  Time
  Reliable
  Displays the UTC end time for the provider’s availability in the given role.
  ISO 8601 Format

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Provider",
      "EventType": "New",
      "EventDateTime": "2023-05-23T13:49:48.036Z",
      "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": [
               "[email protected]"
            ],
            "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"
                  }
               ]
            }
         ]
      }
   ]
}

Update

BETA

An Update message is used to convey changes in information for a provider.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Provider
- Meta.EventType
  String
  Reliable
  Required
  ProviderQueryResponse
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  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
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  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
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  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
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  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
- Providers[]
  Array of Objects
  Reliable
  The list of providers
- Providers[].Identifiers[]
  Array of Objects
  Reliable
  Lists one or more identifiers associated with the provider.
- Providers[].Identifiers[].ID
  String
  Reliable
  Required
  Displays an identifier used to identify the provider in the EHR system.
- Providers[].Identifiers[].IDType
  String
  Reliable
  Displays the type of identifier used to identify the provider.
  e.g. NPI
- Providers[].IsActive
  Boolean
  Reliable
  Required
  Indicates whether the given provider is actively practicing or not.
- Providers[].Demographics.FirstName
  String
  Reliable
  Displays the provider's first name.
- Providers[].Demographics.LastName
  String
  Reliable
  Displays the provider's last name
- Providers[].Demographics.MiddleName
  String
  Possible
  Displays the provider's middle name
- Providers[].Demographics.Credentials[]
  Array of Strings
  Possible
  Lists the provider’s relevant credentials.
  e.g. MD, PhD
- Providers[].Demographics.Addresses[]
  Array of Objects
  Probable
  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
  Reliable
  The use for this address.
  e.g. Home, Office
- Providers[].Demographics.Addresses[].StreetAddress
  String
  Reliable
  Displays the street for a given address.
- Providers[].Demographics.Addresses[].City
  String
  Reliable
  Displays the city for a given address.
- Providers[].Demographics.Addresses[].State
  String
  Reliable
  Displays the state for a given address.
- Providers[].Demographics.Addresses[].ZIP
  String
  Reliable
  Displays the postal code for a given address.
- Providers[].Demographics.Addresses[].County
  String
  Reliable
  Displays the county for a given address.
- Providers[].Demographics.Addresses[].Country
  String
  Reliable
  Displays the country for a given address.
- Providers[].Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Contains contact information for the provider, specifically any email addresses associated with the provider.
- Providers[].Demographics.PhoneNumber.Home
  String
  Probable
  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
  Reliable
  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
  Probable
  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
  Reliable
  ValueSet
  Displays the provider's sex.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Providers[].Demographics.DOB
  String
  Reliable
  Displays the provider's date of birth.
  In ISO 8601 format
- Providers[].Demographics.Languages[]
  Array of Strings
  Reliable
  Lists one or more languages that the provider can use to communicate with patients.
- Providers[].Qualifications[]
  Array of Objects
  Possible
  Lists one or more qualifications the provider has obtained through professional training and certification.
- Providers[].Qualifications[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and types for a given qualification.
- Providers[].Qualifications[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given qualification.
- Providers[].Qualifications[].Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given qualification.
- Providers[].Qualifications[].Code
  String
  Reliable
  Displays a coded representation of the given qualification.
- Providers[].Qualifications[].Codeset
  String
  Reliable
  Displays the codeset associated with the provided code.
- Providers[].Qualifications[].Description
  String
  Reliable
  Contains a human-readable description of the given qualification.
- Providers[].Qualifications[].StartDate
  String
  Reliable
  Displays the date that the given qualification is valid.
  In ISO 8601 format
- Providers[].Qualifications[].EndDate
  String
  Reliable
  Displays the date that the given qualification expires.
  In ISO 8601 format
- Providers[].Roles[]
  Array of Objects
  Probable
  Contains the role(s) that the provider has served or currently serves in.
- Providers[].Roles[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and and types for the given role.
- Providers[].Roles[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given role.
- Providers[].Roles[].Identifiers[].IDType
  String
  Reliable
  Defines the type of identifier for the given role.
- Providers[].Roles[].Organization
  Object
  Reliable
  Describes the organization where the provider has or currently operates in the given role.
- Providers[].Roles[].Organization.Identifiers[]
  Array of Objects
  Reliable
  Lists one or more identifiers for the organization associated with the role.
- Providers[].Roles[].Organization.Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given organization.
- Providers[].Roles[].Organization.Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given organization.
- Providers[].Roles[].Organization.IsActive
  String
  Reliable
  Indicates whether the given organization is currently active.
- Providers[].Roles[].Organization.Type
  String
  Reliable
  Describes the type of the organization associated with the role.
- Providers[].Roles[].Organization.Name
  String
  Reliable
  Displays the name of the organization associated with the role.
- Providers[].Roles[].Organization.Address.StreetAddress
  String
  Reliable
  Displays the street address where the organization is based.
- Providers[].Roles[].Organization.Address.City
  String
  Reliable
  Displays the city where the organization is based.
- Providers[].Roles[].Organization.Address.State
  String
  Reliable
  Displays the state where the organization is based.
- Providers[].Roles[].Organization.Address.ZIP
  String
  Reliable
  Displays the postal code where the organization is based.
- Providers[].Roles[].Organization.Address.County
  String
  Reliable
  Displays the county where the organization is based.
- Providers[].Roles[].Organization.Address.Country
  String
  Reliable
  Displays the country where the organization is based.
- Providers[].Roles[].Specialties[]
  Array of Objects
  Probable
  Lists the coded representation of a given specialty associated with the role.
- Providers[].Roles[].Specialties[].Code
  String
  Probable
  Code
- Providers[].Roles[].Specialties[].Codeset
  String
  Probable
  Code set
- Providers[].Roles[].Specialties[].Description
  String
  Probable
  Description
- Providers[].Roles[].Locations[]
  Array of Objects
  Reliable
  Lists the specific facilities where the provider provides care while serving in the given role.
- Providers[].Roles[].Locations[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and types that identify the location/
- Providers[].Roles[].Locations[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given location.
- Providers[].Roles[].Locations[].Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given location.
- Providers[].Roles[].Locations[].Status
  String
  Reliable
  Indicates whether the given location is currently active, suspended, or inactive.
  One of Active, Suspended, Inactive
- Providers[].Roles[].Locations[].Name
  String
  Reliable
  Displays the name of the given location.
- Providers[].Roles[].Locations[].Description
  String
  Reliable
  Contains a human-readable description of the given location.
- Providers[].Roles[].Locations[].Address.StreetAddress
  String
  Reliable
  Displays the street for the given location.
- Providers[].Roles[].Locations[].Address.City
  String
  Reliable
  Displays the city for the current location.
- Providers[].Roles[].Locations[].Address.State
  String
  Reliable
  Displays the state/province for the given location.
- Providers[].Roles[].Locations[].Address.ZIP
  String
  Reliable
  Displays the postal code for the given location.
- Providers[].Roles[].Locations[].Address.County
  String
  Reliable
  Displays the county for the given location.
- Providers[].Roles[].Locations[].Address.Country
  String
  Reliable
  Displays the country for the given location.
- Providers[].Roles[].Locations[].EmailAddresses[]
  Array of Strings
  Reliable
  Contains contact information for the location, specifically the email address(es).
- Providers[].Roles[].Locations[].PhoneNumber.Office
  String
  Reliable
  Contains contact information for the location, specifically the phone number(s).
  In E. 164 Format. (e.g. +16085551234)
- Providers[].Roles[].Services[]
  Array of Objects
  Reliable
  Describes the healthcare services that the provider offers while serving in the given role.
- Providers[].Roles[].Services[].Identifiers[]
  String
  Reliable
  Lists one or more identifiers for the healthcare services associated with the role.
- Providers[].Roles[].Services[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given service.
- Providers[].Roles[].Services[].Identifiers[].IDType
  String
  Reliable
  Defines the type of identifier for the given service
- Providers[].Roles[].Services[].Type
  String
  Reliable
  Describes the type of healthcare service that may be delivered or performed for the given service.
- Providers[].Roles[].Services[].Description
  String
  Reliable
  Contains a human-readable description of the given service.
- Providers[].Roles[].Services[].PhoneNumber.Office
  String
  Reliable
  Displays the office phone number for information on the given service.
  In E. 164 Format. (e.g. +16085551234)
- Providers[].Roles[].Availability[]
  Array of Objects
  Possible
  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 Strings
  Reliable
  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
  Time
  Reliable
  Displays the UTC start time for the provider's availability in the given role.
  ISO 8601 Format
- Providers[].Roles[].Availability[].AvailableEndTime
  Time
  Reliable
  Displays the UTC end time for the provider’s availability in the given role.
  ISO 8601 Format

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Provider",
      "EventType": "Update",
      "EventDateTime": "2023-05-23T13:49:48.036Z",
      "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": [
               "[email protected]"
            ],
            "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"
                  }
               ]
            }
         ]
      }
   ]
}

Activate

BETA

An Activate message is used to convey that a provider's status has changed from Inactive to Active.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Provider
- Meta.EventType
  String
  Reliable
  Required
  ProviderQueryResponse
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  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
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  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
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  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
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  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
- Providers[]
  Array of Objects
  Reliable
  The list of providers
- Providers[].Identifiers[]
  Array of Objects
  Reliable
  Lists one or more identifiers associated with the provider.
- Providers[].Identifiers[].ID
  String
  Reliable
  Required
  Displays an identifier used to identify the provider in the EHR system.
- Providers[].Identifiers[].IDType
  String
  Reliable
  Displays the type of identifier used to identify the provider.
  e.g. NPI
- Providers[].Demographics.FirstName
  String
  Reliable
  Displays the provider's first name.
- Providers[].Demographics.LastName
  String
  Reliable
  Displays the provider's last name
- Providers[].Demographics.MiddleName
  String
  Possible
  Displays the provider's middle name
- Providers[].Demographics.Credentials[]
  Array of Strings
  Possible
  Lists the provider’s relevant credentials.
  e.g. MD, PhD
- Providers[].Demographics.Addresses[]
  Array of Objects
  Probable
  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
  Reliable
  The use for this address.
  e.g. Home, Office
- Providers[].Demographics.Addresses[].StreetAddress
  String
  Reliable
  Displays the street for a given address.
- Providers[].Demographics.Addresses[].City
  String
  Reliable
  Displays the city for a given address.
- Providers[].Demographics.Addresses[].State
  String
  Reliable
  Displays the state for a given address.
- Providers[].Demographics.Addresses[].ZIP
  String
  Reliable
  Displays the postal code for a given address.
- Providers[].Demographics.Addresses[].County
  String
  Reliable
  Displays the county for a given address.
- Providers[].Demographics.Addresses[].Country
  String
  Reliable
  Displays the country for a given address.
- Providers[].Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Contains contact information for the provider, specifically any email addresses associated with the provider.
- Providers[].Demographics.PhoneNumber.Home
  String
  Probable
  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
  Reliable
  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
  Probable
  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
  Reliable
  ValueSet
  Displays the provider's sex.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Providers[].Demographics.DOB
  String
  Reliable
  Displays the provider's date of birth.
  In ISO 8601 format
- Providers[].Demographics.Languages[]
  Array of Strings
  Reliable
  Lists one or more languages that the provider can use to communicate with patients.
- Providers[].Qualifications[]
  Array of Objects
  Possible
  Lists one or more qualifications the provider has obtained through professional training and certification.
- Providers[].Qualifications[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and types for a given qualification.
- Providers[].Qualifications[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given qualification.
- Providers[].Qualifications[].Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given qualification.
- Providers[].Qualifications[].Code
  String
  Reliable
  Displays a coded representation of the given qualification.
- Providers[].Qualifications[].Codeset
  String
  Reliable
  Displays the codeset associated with the provided code.
- Providers[].Qualifications[].Description
  String
  Reliable
  Contains a human-readable description of the given qualification.
- Providers[].Qualifications[].StartDate
  String
  Reliable
  Displays the date that the given qualification is valid.
  In ISO 8601 format
- Providers[].Qualifications[].EndDate
  String
  Reliable
  Displays the date that the given qualification expires.
  In ISO 8601 format
- Providers[].Roles[]
  Array of Objects
  Probable
  Contains the role(s) that the provider has served or currently serves in.
- Providers[].Roles[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and and types for the given role.
- Providers[].Roles[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given role.
- Providers[].Roles[].Identifiers[].IDType
  String
  Reliable
  Defines the type of identifier for the given role.
- Providers[].Roles[].Organization
  Object
  Reliable
  Describes the organization where the provider has or currently operates in the given role.
- Providers[].Roles[].Organization.Identifiers[]
  Array of Objects
  Reliable
  Lists one or more identifiers for the organization associated with the role.
- Providers[].Roles[].Organization.Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given organization.
- Providers[].Roles[].Organization.Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given organization.
- Providers[].Roles[].Organization.IsActive
  String
  Reliable
  Indicates whether the given organization is currently active.
- Providers[].Roles[].Organization.Type
  String
  Reliable
  Describes the type of the organization associated with the role.
- Providers[].Roles[].Organization.Name
  String
  Reliable
  Displays the name of the organization associated with the role.
- Providers[].Roles[].Organization.Address.StreetAddress
  String
  Reliable
  Displays the street address where the organization is based.
- Providers[].Roles[].Organization.Address.City
  String
  Reliable
  Displays the city where the organization is based.
- Providers[].Roles[].Organization.Address.State
  String
  Reliable
  Displays the state where the organization is based.
- Providers[].Roles[].Organization.Address.ZIP
  String
  Reliable
  Displays the postal code where the organization is based.
- Providers[].Roles[].Organization.Address.County
  String
  Reliable
  Displays the county where the organization is based.
- Providers[].Roles[].Organization.Address.Country
  String
  Reliable
  Displays the country where the organization is based.
- Providers[].Roles[].Specialties[]
  Array of Objects
  Probable
  Lists the coded representation of a given specialty associated with the role.
- Providers[].Roles[].Specialties[].Code
  String
  Probable
  Code
- Providers[].Roles[].Specialties[].Codeset
  String
  Probable
  Code set
- Providers[].Roles[].Specialties[].Description
  String
  Probable
  Description
- Providers[].Roles[].Locations[]
  Array of Objects
  Reliable
  Lists the specific facilities where the provider provides care while serving in the given role.
- Providers[].Roles[].Locations[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and types that identify the location/
- Providers[].Roles[].Locations[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given location.
- Providers[].Roles[].Locations[].Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given location.
- Providers[].Roles[].Locations[].Status
  String
  Reliable
  Indicates whether the given location is currently active, suspended, or inactive.
  One of Active, Suspended, Inactive
- Providers[].Roles[].Locations[].Name
  String
  Reliable
  Displays the name of the given location.
- Providers[].Roles[].Locations[].Description
  String
  Reliable
  Contains a human-readable description of the given location.
- Providers[].Roles[].Locations[].Address.StreetAddress
  String
  Reliable
  Displays the street for the given location.
- Providers[].Roles[].Locations[].Address.City
  String
  Reliable
  Displays the city for the current location.
- Providers[].Roles[].Locations[].Address.State
  String
  Reliable
  Displays the state/province for the given location.
- Providers[].Roles[].Locations[].Address.ZIP
  String
  Reliable
  Displays the postal code for the given location.
- Providers[].Roles[].Locations[].Address.County
  String
  Reliable
  Displays the county for the given location.
- Providers[].Roles[].Locations[].Address.Country
  String
  Reliable
  Displays the country for the given location.
- Providers[].Roles[].Locations[].EmailAddresses[]
  Array of Strings
  Reliable
  Contains contact information for the location, specifically the email address(es).
- Providers[].Roles[].Locations[].PhoneNumber.Office
  String
  Reliable
  Contains contact information for the location, specifically the phone number(s).
  In E. 164 Format. (e.g. +16085551234)
- Providers[].Roles[].Services[]
  Array of Objects
  Reliable
  Describes the healthcare services that the provider offers while serving in the given role.
- Providers[].Roles[].Services[].Identifiers[]
  String
  Reliable
  Lists one or more identifiers for the healthcare services associated with the role.
- Providers[].Roles[].Services[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given service.
- Providers[].Roles[].Services[].Identifiers[].IDType
  String
  Reliable
  Defines the type of identifier for the given service
- Providers[].Roles[].Services[].Type
  String
  Reliable
  Describes the type of healthcare service that may be delivered or performed for the given service.
- Providers[].Roles[].Services[].Description
  String
  Reliable
  Contains a human-readable description of the given service.
- Providers[].Roles[].Services[].PhoneNumber.Office
  String
  Reliable
  Displays the office phone number for information on the given service.
  In E. 164 Format. (e.g. +16085551234)
- Providers[].Roles[].Availability[]
  Array of Objects
  Possible
  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 Strings
  Reliable
  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
  Time
  Reliable
  Displays the UTC start time for the provider's availability in the given role.
  ISO 8601 Format
- Providers[].Roles[].Availability[].AvailableEndTime
  Time
  Reliable
  Displays the UTC end time for the provider’s availability in the given role.
  ISO 8601 Format

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Provider",
      "EventType": "Activate",
      "EventDateTime": "2023-05-23T13:49:48.036Z",
      "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"
            }
         ],
         "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": [
               "[email protected]"
            ],
            "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"
                  }
               ]
            }
         ]
      }
   ]
}

Deactivate

BETA

An Deactivate message is used to convey that a provider's status has changed from Active to Inactive.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Provider
- Meta.EventType
  String
  Reliable
  Required
  ProviderQueryResponse
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  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
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  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
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  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
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  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
- Providers[]
  Array of Objects
  Reliable
  The list of providers
- Providers[].Identifiers[]
  Array of Objects
  Reliable
  Lists one or more identifiers associated with the provider.
- Providers[].Identifiers[].ID
  String
  Reliable
  Required
  Displays an identifier used to identify the provider in the EHR system.
- Providers[].Identifiers[].IDType
  String
  Reliable
  Displays the type of identifier used to identify the provider.
  e.g. NPI
- Providers[].Demographics.FirstName
  String
  Reliable
  Displays the provider's first name.
- Providers[].Demographics.LastName
  String
  Reliable
  Displays the provider's last name
- Providers[].Demographics.MiddleName
  String
  Possible
  Displays the provider's middle name
- Providers[].Demographics.Credentials[]
  Array of Strings
  Possible
  Lists the provider’s relevant credentials.
  e.g. MD, PhD
- Providers[].Demographics.Addresses[]
  Array of Objects
  Probable
  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
  Reliable
  The use for this address.
  e.g. Home, Office
- Providers[].Demographics.Addresses[].StreetAddress
  String
  Reliable
  Displays the street for a given address.
- Providers[].Demographics.Addresses[].City
  String
  Reliable
  Displays the city for a given address.
- Providers[].Demographics.Addresses[].State
  String
  Reliable
  Displays the state for a given address.
- Providers[].Demographics.Addresses[].ZIP
  String
  Reliable
  Displays the postal code for a given address.
- Providers[].Demographics.Addresses[].County
  String
  Reliable
  Displays the county for a given address.
- Providers[].Demographics.Addresses[].Country
  String
  Reliable
  Displays the country for a given address.
- Providers[].Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Contains contact information for the provider, specifically any email addresses associated with the provider.
- Providers[].Demographics.PhoneNumber.Home
  String
  Probable
  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
  Reliable
  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
  Probable
  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
  Reliable
  ValueSet
  Displays the provider's sex.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Providers[].Demographics.DOB
  String
  Reliable
  Displays the provider's date of birth.
  In ISO 8601 format
- Providers[].Demographics.Languages[]
  Array of Strings
  Reliable
  Lists one or more languages that the provider can use to communicate with patients.
- Providers[].Qualifications[]
  Array of Objects
  Possible
  Lists one or more qualifications the provider has obtained through professional training and certification.
- Providers[].Qualifications[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and types for a given qualification.
- Providers[].Qualifications[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given qualification.
- Providers[].Qualifications[].Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given qualification.
- Providers[].Qualifications[].Code
  String
  Reliable
  Displays a coded representation of the given qualification.
- Providers[].Qualifications[].Codeset
  String
  Reliable
  Displays the codeset associated with the provided code.
- Providers[].Qualifications[].Description
  String
  Reliable
  Contains a human-readable description of the given qualification.
- Providers[].Qualifications[].StartDate
  String
  Reliable
  Displays the date that the given qualification is valid.
  In ISO 8601 format
- Providers[].Qualifications[].EndDate
  String
  Reliable
  Displays the date that the given qualification expires.
  In ISO 8601 format
- Providers[].Roles[]
  Array of Objects
  Probable
  Contains the role(s) that the provider has served or currently serves in.
- Providers[].Roles[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and and types for the given role.
- Providers[].Roles[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given role.
- Providers[].Roles[].Identifiers[].IDType
  String
  Reliable
  Defines the type of identifier for the given role.
- Providers[].Roles[].Organization
  Object
  Reliable
  Describes the organization where the provider has or currently operates in the given role.
- Providers[].Roles[].Organization.Identifiers[]
  Array of Objects
  Reliable
  Lists one or more identifiers for the organization associated with the role.
- Providers[].Roles[].Organization.Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given organization.
- Providers[].Roles[].Organization.Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given organization.
- Providers[].Roles[].Organization.IsActive
  String
  Reliable
  Indicates whether the given organization is currently active.
- Providers[].Roles[].Organization.Type
  String
  Reliable
  Describes the type of the organization associated with the role.
- Providers[].Roles[].Organization.Name
  String
  Reliable
  Displays the name of the organization associated with the role.
- Providers[].Roles[].Organization.Address.StreetAddress
  String
  Reliable
  Displays the street address where the organization is based.
- Providers[].Roles[].Organization.Address.City
  String
  Reliable
  Displays the city where the organization is based.
- Providers[].Roles[].Organization.Address.State
  String
  Reliable
  Displays the state where the organization is based.
- Providers[].Roles[].Organization.Address.ZIP
  String
  Reliable
  Displays the postal code where the organization is based.
- Providers[].Roles[].Organization.Address.County
  String
  Reliable
  Displays the county where the organization is based.
- Providers[].Roles[].Organization.Address.Country
  String
  Reliable
  Displays the country where the organization is based.
- Providers[].Roles[].Specialties[]
  Array of Objects
  Probable
  Lists the coded representation of a given specialty associated with the role.
- Providers[].Roles[].Specialties[].Code
  String
  Probable
  Code
- Providers[].Roles[].Specialties[].Codeset
  String
  Probable
  Code set
- Providers[].Roles[].Specialties[].Description
  String
  Probable
  Description
- Providers[].Roles[].Locations[]
  Array of Objects
  Reliable
  Lists the specific facilities where the provider provides care while serving in the given role.
- Providers[].Roles[].Locations[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and types that identify the location/
- Providers[].Roles[].Locations[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given location.
- Providers[].Roles[].Locations[].Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given location.
- Providers[].Roles[].Locations[].Status
  String
  Reliable
  Indicates whether the given location is currently active, suspended, or inactive.
  One of Active, Suspended, Inactive
- Providers[].Roles[].Locations[].Name
  String
  Reliable
  Displays the name of the given location.
- Providers[].Roles[].Locations[].Description
  String
  Reliable
  Contains a human-readable description of the given location.
- Providers[].Roles[].Locations[].Address.StreetAddress
  String
  Reliable
  Displays the street for the given location.
- Providers[].Roles[].Locations[].Address.City
  String
  Reliable
  Displays the city for the current location.
- Providers[].Roles[].Locations[].Address.State
  String
  Reliable
  Displays the state/province for the given location.
- Providers[].Roles[].Locations[].Address.ZIP
  String
  Reliable
  Displays the postal code for the given location.
- Providers[].Roles[].Locations[].Address.County
  String
  Reliable
  Displays the county for the given location.
- Providers[].Roles[].Locations[].Address.Country
  String
  Reliable
  Displays the country for the given location.
- Providers[].Roles[].Locations[].EmailAddresses[]
  Array of Strings
  Reliable
  Contains contact information for the location, specifically the email address(es).
- Providers[].Roles[].Locations[].PhoneNumber.Office
  String
  Reliable
  Contains contact information for the location, specifically the phone number(s).
  In E. 164 Format. (e.g. +16085551234)
- Providers[].Roles[].Services[]
  Array of Objects
  Reliable
  Describes the healthcare services that the provider offers while serving in the given role.
- Providers[].Roles[].Services[].Identifiers[]
  String
  Reliable
  Lists one or more identifiers for the healthcare services associated with the role.
- Providers[].Roles[].Services[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given service.
- Providers[].Roles[].Services[].Identifiers[].IDType
  String
  Reliable
  Defines the type of identifier for the given service
- Providers[].Roles[].Services[].Type
  String
  Reliable
  Describes the type of healthcare service that may be delivered or performed for the given service.
- Providers[].Roles[].Services[].Description
  String
  Reliable
  Contains a human-readable description of the given service.
- Providers[].Roles[].Services[].PhoneNumber.Office
  String
  Reliable
  Displays the office phone number for information on the given service.
  In E. 164 Format. (e.g. +16085551234)
- Providers[].Roles[].Availability[]
  Array of Objects
  Possible
  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 Strings
  Reliable
  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
  Time
  Reliable
  Displays the UTC start time for the provider's availability in the given role.
  ISO 8601 Format
- Providers[].Roles[].Availability[].AvailableEndTime
  Time
  Reliable
  Displays the UTC end time for the provider’s availability in the given role.
  ISO 8601 Format

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Provider",
      "EventType": "Deactivate",
      "EventDateTime": "2023-05-23T13:49:48.036Z",
      "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"
            }
         ],
         "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": [
               "[email protected]"
            ],
            "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"
                  }
               ]
            }
         ]
      }
   ]
}

ProviderQuery

BETA

This query finds and returns matching providers given the provided search parameter. The response for this query is the ProviderQueryResponse documented below.

When using this query, the required elements and populated response will be variable depending on the system you are integrating with. Your Redox team will provide details on which elements are required by the EHR during your install process.

Fields

Show Required Fields Only

Show Translation Fields

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

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Provider",
      "EventType": "ProviderQuery",
      "EventDateTime": "2023-05-23T13:49:48.036Z",
      "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
         }
      }
   }
}

ProviderQueryResponse

BETA

A Provider Query Response message is used in response to a Provider Query.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Provider
- Meta.EventType
  String
  Reliable
  Required
  ProviderQueryResponse
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  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
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  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
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  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
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  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
- Providers[]
  Array of Objects
  Reliable
  The list of providers
- Providers[].Identifiers[]
  Array of Objects
  Reliable
  Lists one or more identifiers associated with the provider.
- Providers[].Identifiers[].ID
  String
  Reliable
  Required
  Displays an identifier used to identify the provider in the EHR system.
- Providers[].Identifiers[].IDType
  String
  Reliable
  Displays the type of identifier used to identify the provider.
  e.g. NPI
- Providers[].IsActive
  Boolean
  Reliable
  Required
  Indicates whether the given provider is actively practicing or not.
- Providers[].Demographics.FirstName
  String
  Reliable
  Displays the provider's first name.
- Providers[].Demographics.LastName
  String
  Reliable
  Displays the provider's last name
- Providers[].Demographics.MiddleName
  String
  Possible
  Displays the provider's middle name
- Providers[].Demographics.Credentials[]
  Array of Strings
  Possible
  Lists the provider’s relevant credentials.
  e.g. MD, PhD
- Providers[].Demographics.Addresses[]
  Array of Objects
  Probable
  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
  Reliable
  The use for this address.
  e.g. Home, Office
- Providers[].Demographics.Addresses[].StreetAddress
  String
  Reliable
  Displays the street for a given address.
- Providers[].Demographics.Addresses[].City
  String
  Reliable
  Displays the city for a given address.
- Providers[].Demographics.Addresses[].State
  String
  Reliable
  Displays the state for a given address.
- Providers[].Demographics.Addresses[].ZIP
  String
  Reliable
  Displays the postal code for a given address.
- Providers[].Demographics.Addresses[].County
  String
  Reliable
  Displays the county for a given address.
- Providers[].Demographics.Addresses[].Country
  String
  Reliable
  Displays the country for a given address.
- Providers[].Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Contains contact information for the provider, specifically any email addresses associated with the provider.
- Providers[].Demographics.PhoneNumber.Home
  String
  Probable
  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
  Reliable
  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
  Probable
  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
  Reliable
  ValueSet
  Displays the provider's sex.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Providers[].Demographics.DOB
  String
  Reliable
  Displays the provider's date of birth.
  In ISO 8601 format
- Providers[].Demographics.Languages[]
  Array of Strings
  Reliable
  Lists one or more languages that the provider can use to communicate with patients.
- Providers[].Qualifications[]
  Array of Objects
  Possible
  Lists one or more qualifications the provider has obtained through professional training and certification.
- Providers[].Qualifications[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and types for a given qualification.
- Providers[].Qualifications[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given qualification.
- Providers[].Qualifications[].Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given qualification.
- Providers[].Qualifications[].Code
  String
  Reliable
  Displays a coded representation of the given qualification.
- Providers[].Qualifications[].Codeset
  String
  Reliable
  Displays the codeset associated with the provided code.
- Providers[].Qualifications[].Description
  String
  Reliable
  Contains a human-readable description of the given qualification.
- Providers[].Qualifications[].StartDate
  String
  Reliable
  Displays the date that the given qualification is valid.
  In ISO 8601 format
- Providers[].Qualifications[].EndDate
  String
  Reliable
  Displays the date that the given qualification expires.
  In ISO 8601 format
- Providers[].Roles[]
  Array of Objects
  Probable
  Contains the role(s) that the provider has served or currently serves in.
- Providers[].Roles[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and and types for the given role.
- Providers[].Roles[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given role.
- Providers[].Roles[].Identifiers[].IDType
  String
  Reliable
  Defines the type of identifier for the given role.
- Providers[].Roles[].Organization
  Object
  Reliable
  Describes the organization where the provider has or currently operates in the given role.
- Providers[].Roles[].Organization.Identifiers[]
  Array of Objects
  Reliable
  Lists one or more identifiers for the organization associated with the role.
- Providers[].Roles[].Organization.Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given organization.
- Providers[].Roles[].Organization.Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given organization.
- Providers[].Roles[].Organization.IsActive
  String
  Reliable
  Indicates whether the given organization is currently active.
- Providers[].Roles[].Organization.Type
  String
  Reliable
  Describes the type of the organization associated with the role.
- Providers[].Roles[].Organization.Name
  String
  Reliable
  Displays the name of the organization associated with the role.
- Providers[].Roles[].Organization.Address.StreetAddress
  String
  Reliable
  Displays the street address where the organization is based.
- Providers[].Roles[].Organization.Address.City
  String
  Reliable
  Displays the city where the organization is based.
- Providers[].Roles[].Organization.Address.State
  String
  Reliable
  Displays the state where the organization is based.
- Providers[].Roles[].Organization.Address.ZIP
  String
  Reliable
  Displays the postal code where the organization is based.
- Providers[].Roles[].Organization.Address.County
  String
  Reliable
  Displays the county where the organization is based.
- Providers[].Roles[].Organization.Address.Country
  String
  Reliable
  Displays the country where the organization is based.
- Providers[].Roles[].Specialties[]
  Array of Objects
  Probable
  Lists the coded representation of a given specialty associated with the role.
- Providers[].Roles[].Specialties[].Code
  String
  Probable
  Code
- Providers[].Roles[].Specialties[].Codeset
  String
  Probable
  Code set
- Providers[].Roles[].Specialties[].Description
  String
  Probable
  Description
- Providers[].Roles[].Locations[]
  Array of Objects
  Reliable
  Lists the specific facilities where the provider provides care while serving in the given role.
- Providers[].Roles[].Locations[].Identifiers[]
  Array of Objects
  Reliable
  Displays a list of identifiers and types that identify the location/
- Providers[].Roles[].Locations[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given location.
- Providers[].Roles[].Locations[].Identifiers[].IDType
  String
  Reliable
  Displays the type of the identifier for the given location.
- Providers[].Roles[].Locations[].Status
  String
  Reliable
  Indicates whether the given location is currently active, suspended, or inactive.
  One of Active, Suspended, Inactive
- Providers[].Roles[].Locations[].Name
  String
  Reliable
  Displays the name of the given location.
- Providers[].Roles[].Locations[].Description
  String
  Reliable
  Contains a human-readable description of the given location.
- Providers[].Roles[].Locations[].Address.StreetAddress
  String
  Reliable
  Displays the street for the given location.
- Providers[].Roles[].Locations[].Address.City
  String
  Reliable
  Displays the city for the current location.
- Providers[].Roles[].Locations[].Address.State
  String
  Reliable
  Displays the state/province for the given location.
- Providers[].Roles[].Locations[].Address.ZIP
  String
  Reliable
  Displays the postal code for the given location.
- Providers[].Roles[].Locations[].Address.County
  String
  Reliable
  Displays the county for the given location.
- Providers[].Roles[].Locations[].Address.Country
  String
  Reliable
  Displays the country for the given location.
- Providers[].Roles[].Locations[].EmailAddresses[]
  Array of Strings
  Reliable
  Contains contact information for the location, specifically the email address(es).
- Providers[].Roles[].Locations[].PhoneNumber.Office
  String
  Reliable
  Contains contact information for the location, specifically the phone number(s).
  In E. 164 Format. (e.g. +16085551234)
- Providers[].Roles[].Services[]
  Array of Objects
  Reliable
  Describes the healthcare services that the provider offers while serving in the given role.
- Providers[].Roles[].Services[].Identifiers[]
  String
  Reliable
  Lists one or more identifiers for the healthcare services associated with the role.
- Providers[].Roles[].Services[].Identifiers[].ID
  String
  Reliable
  Displays a string identifier provided by a third-party system for the given service.
- Providers[].Roles[].Services[].Identifiers[].IDType
  String
  Reliable
  Defines the type of identifier for the given service
- Providers[].Roles[].Services[].Type
  String
  Reliable
  Describes the type of healthcare service that may be delivered or performed for the given service.
- Providers[].Roles[].Services[].Description
  String
  Reliable
  Contains a human-readable description of the given service.
- Providers[].Roles[].Services[].PhoneNumber.Office
  String
  Reliable
  Displays the office phone number for information on the given service.
  In E. 164 Format. (e.g. +16085551234)
- Providers[].Roles[].Availability[]
  Array of Objects
  Possible
  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 Strings
  Reliable
  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
  Time
  Reliable
  Displays the UTC start time for the provider's availability in the given role.
  ISO 8601 Format
- Providers[].Roles[].Availability[].AvailableEndTime
  Time
  Reliable
  Displays the UTC end time for the provider’s availability in the given role.
  ISO 8601 Format

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Provider",
      "EventType": "ProviderQueryResponse",
      "EventDateTime": "2023-05-23T13:49:48.036Z",
      "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": [
               "[email protected]"
            ],
            "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"
                  }
               ]
            }
         ]
      }
   ]
}

Provider

Newlink

Fields

Meta

Providers

Updatelink

Fields

Meta

Providers

Activatelink

Fields

Meta

Providers

Deactivatelink

Fields

Meta

Providers

ProviderQuerylink

Fields

Meta

Provider

ProviderQueryResponselink

Fields

Meta

Providers

New

Update

Activate

Deactivate

ProviderQuery

ProviderQueryResponse