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.
Newlink
BETAA New message is used to convey provider instances that have just been created.
Fields
Meta
Meta.DataModel
String
ReliableRequiredProvider
Meta.EventType
String
ReliableRequiredProviderQueryResponse
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies 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
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains 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
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies 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
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode 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
ReliableThe list of providers
Providers[].Identifiers[]
Array of Objects
ReliableLists one or more identifiers associated with the provider.
Providers[].Identifiers[].ID
String
ReliableRequiredDisplays an identifier used to identify the provider in the EHR system.
Providers[].Identifiers[].IDType
String
ReliableDisplays the type of identifier used to identify the provider.
e.g. NPI
Providers[].IsActive
Boolean
ReliableRequiredIndicates whether the given provider is actively practicing or not.
Providers[].Demographics.FirstName
String
ReliableDisplays the provider's first name.
Providers[].Demographics.LastName
String
ReliableDisplays the provider's last name
Providers[].Demographics.MiddleName
String
PossibleDisplays the provider's middle name
Providers[].Demographics.Credentials[]
Array of Strings
PossibleLists the provider’s relevant credentials.
e.g. MD, PhD
Providers[].Demographics.Addresses[]
Array of Objects
ProbableDisplays a list of addresses associated with the provider.
These are addresses where the practitioner performs services, not residential addresses.
Providers[].Demographics.Addresses[].Use
String
ReliableThe use for this address.
e.g. Home, Office
Providers[].Demographics.Addresses[].StreetAddress
String
ReliableDisplays the street for a given address.
Providers[].Demographics.Addresses[].City
String
ReliableDisplays the city for a given address.
Providers[].Demographics.Addresses[].State
String
ReliableDisplays the state for a given address.
Providers[].Demographics.Addresses[].ZIP
String
ReliableDisplays the postal code for a given address.
Providers[].Demographics.Addresses[].County
String
ReliableDisplays the county for a given address.
Providers[].Demographics.Addresses[].Country
String
ReliableDisplays the country for a given address.
Providers[].Demographics.EmailAddresses[]
Array of Strings
ProbableContains contact information for the provider, specifically any email addresses associated with the provider.
Providers[].Demographics.PhoneNumber.Home
String
ProbableContains 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
ReliableContains 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
ProbableContains 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
ReliableValueSetDisplays the provider's sex.
-
Additional values may be added by Redox in the future.
-
Providers[].Demographics.DOB
String
ReliableDisplays the provider's date of birth.
In ISO 8601 format
Providers[].Demographics.Languages[]
Array of Strings
ReliableLists one or more languages that the provider can use to communicate with patients.
Providers[].Qualifications[]
Array of Objects
PossibleLists one or more qualifications the provider has obtained through professional training and certification.
Providers[].Qualifications[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and types for a given qualification.
Providers[].Qualifications[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given qualification.
Providers[].Qualifications[].Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given qualification.
Providers[].Qualifications[].Code
String
ReliableDisplays a coded representation of the given qualification.
Providers[].Qualifications[].Codeset
String
ReliableDisplays the codeset associated with the provided code.
Providers[].Qualifications[].Description
String
ReliableContains a human-readable description of the given qualification.
Providers[].Qualifications[].StartDate
String
ReliableDisplays the date that the given qualification is valid.
In ISO 8601 format
Providers[].Qualifications[].EndDate
String
ReliableDisplays the date that the given qualification expires.
In ISO 8601 format
Providers[].Roles[]
Array of Objects
ProbableContains the role(s) that the provider has served or currently serves in.
Providers[].Roles[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and and types for the given role.
Providers[].Roles[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given role.
Providers[].Roles[].Identifiers[].IDType
String
ReliableDefines the type of identifier for the given role.
Providers[].Roles[].Organization
Object
ReliableDescribes the organization where the provider has or currently operates in the given role.
Providers[].Roles[].Organization.Identifiers[]
Array of Objects
ReliableLists one or more identifiers for the organization associated with the role.
Providers[].Roles[].Organization.Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given organization.
Providers[].Roles[].Organization.Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given organization.
Providers[].Roles[].Organization.IsActive
String
ReliableIndicates whether the given organization is currently active.
Providers[].Roles[].Organization.Type
String
ReliableDescribes the type of the organization associated with the role.
Providers[].Roles[].Organization.Name
String
ReliableDisplays the name of the organization associated with the role.
Providers[].Roles[].Organization.Address.StreetAddress
String
ReliableDisplays the street address where the organization is based.
Providers[].Roles[].Organization.Address.City
String
ReliableDisplays the city where the organization is based.
Providers[].Roles[].Organization.Address.State
String
ReliableDisplays the state where the organization is based.
Providers[].Roles[].Organization.Address.ZIP
String
ReliableDisplays the postal code where the organization is based.
Providers[].Roles[].Organization.Address.County
String
ReliableDisplays the county where the organization is based.
Providers[].Roles[].Organization.Address.Country
String
ReliableDisplays the country where the organization is based.
Providers[].Roles[].Specialties[]
Array of Objects
ProbableLists the coded representation of a given specialty associated with the role.
Providers[].Roles[].Specialties[].Code
String
ProbableCode
Providers[].Roles[].Specialties[].Codeset
String
ProbableCode set
Providers[].Roles[].Specialties[].Description
String
ProbableDescription
Providers[].Roles[].Locations[]
Array of Objects
ReliableLists the specific facilities where the provider provides care while serving in the given role.
Providers[].Roles[].Locations[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and types that identify the location/
Providers[].Roles[].Locations[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given location.
Providers[].Roles[].Locations[].Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given location.
Providers[].Roles[].Locations[].Status
String
ReliableIndicates whether the given location is currently active, suspended, or inactive.
One of Active, Suspended, Inactive
Providers[].Roles[].Locations[].Name
String
ReliableDisplays the name of the given location.
Providers[].Roles[].Locations[].Description
String
ReliableContains a human-readable description of the given location.
Providers[].Roles[].Locations[].Address.StreetAddress
String
ReliableDisplays the street for the given location.
Providers[].Roles[].Locations[].Address.City
String
ReliableDisplays the city for the current location.
Providers[].Roles[].Locations[].Address.State
String
ReliableDisplays the state/province for the given location.
Providers[].Roles[].Locations[].Address.ZIP
String
ReliableDisplays the postal code for the given location.
Providers[].Roles[].Locations[].Address.County
String
ReliableDisplays the county for the given location.
Providers[].Roles[].Locations[].Address.Country
String
ReliableDisplays the country for the given location.
Providers[].Roles[].Locations[].EmailAddresses[]
Array of Strings
ReliableContains contact information for the location, specifically the email address(es).
Providers[].Roles[].Locations[].PhoneNumber.Office
String
ReliableContains contact information for the location, specifically the phone number(s).
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Services[]
Array of Objects
ReliableDescribes the healthcare services that the provider offers while serving in the given role.
Providers[].Roles[].Services[].Identifiers[]
String
ReliableLists one or more identifiers for the healthcare services associated with the role.
Providers[].Roles[].Services[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given service.
Providers[].Roles[].Services[].Identifiers[].IDType
String
ReliableDefines the type of identifier for the given service
Providers[].Roles[].Services[].Type
String
ReliableDescribes the type of healthcare service that may be delivered or performed for the given service.
Providers[].Roles[].Services[].Description
String
ReliableContains a human-readable description of the given service.
Providers[].Roles[].Services[].PhoneNumber.Office
String
ReliableDisplays the office phone number for information on the given service.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Availability[]
Array of Objects
PossibleDefines 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
ReliableDisplays 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
ReliableDisplays the UTC start time for the provider's availability in the given role.
ISO 8601 Format
Providers[].Roles[].Availability[].AvailableEndTime
Time
ReliableDisplays the UTC end time for the provider’s availability in the given role.
ISO 8601 Format
{
"Meta": {
"DataModel": "Provider",
"EventType": "New",
"EventDateTime": "2023-12-05T15:06:15.449Z",
"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"
}
]
}
]
}
]
}
Updatelink
BETAAn Update message is used to convey changes in information for a provider.
Fields
Meta
Meta.DataModel
String
ReliableRequiredProvider
Meta.EventType
String
ReliableRequiredProviderQueryResponse
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies 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
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains 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
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies 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
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode 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
ReliableThe list of providers
Providers[].Identifiers[]
Array of Objects
ReliableLists one or more identifiers associated with the provider.
Providers[].Identifiers[].ID
String
ReliableRequiredDisplays an identifier used to identify the provider in the EHR system.
Providers[].Identifiers[].IDType
String
ReliableDisplays the type of identifier used to identify the provider.
e.g. NPI
Providers[].IsActive
Boolean
ReliableRequiredIndicates whether the given provider is actively practicing or not.
Providers[].Demographics.FirstName
String
ReliableDisplays the provider's first name.
Providers[].Demographics.LastName
String
ReliableDisplays the provider's last name
Providers[].Demographics.MiddleName
String
PossibleDisplays the provider's middle name
Providers[].Demographics.Credentials[]
Array of Strings
PossibleLists the provider’s relevant credentials.
e.g. MD, PhD
Providers[].Demographics.Addresses[]
Array of Objects
ProbableDisplays a list of addresses associated with the provider.
These are addresses where the practitioner performs services, not residential addresses.
Providers[].Demographics.Addresses[].Use
String
ReliableThe use for this address.
e.g. Home, Office
Providers[].Demographics.Addresses[].StreetAddress
String
ReliableDisplays the street for a given address.
Providers[].Demographics.Addresses[].City
String
ReliableDisplays the city for a given address.
Providers[].Demographics.Addresses[].State
String
ReliableDisplays the state for a given address.
Providers[].Demographics.Addresses[].ZIP
String
ReliableDisplays the postal code for a given address.
Providers[].Demographics.Addresses[].County
String
ReliableDisplays the county for a given address.
Providers[].Demographics.Addresses[].Country
String
ReliableDisplays the country for a given address.
Providers[].Demographics.EmailAddresses[]
Array of Strings
ProbableContains contact information for the provider, specifically any email addresses associated with the provider.
Providers[].Demographics.PhoneNumber.Home
String
ProbableContains 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
ReliableContains 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
ProbableContains 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
ReliableValueSetDisplays the provider's sex.
-
Additional values may be added by Redox in the future.
-
Providers[].Demographics.DOB
String
ReliableDisplays the provider's date of birth.
In ISO 8601 format
Providers[].Demographics.Languages[]
Array of Strings
ReliableLists one or more languages that the provider can use to communicate with patients.
Providers[].Qualifications[]
Array of Objects
PossibleLists one or more qualifications the provider has obtained through professional training and certification.
Providers[].Qualifications[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and types for a given qualification.
Providers[].Qualifications[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given qualification.
Providers[].Qualifications[].Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given qualification.
Providers[].Qualifications[].Code
String
ReliableDisplays a coded representation of the given qualification.
Providers[].Qualifications[].Codeset
String
ReliableDisplays the codeset associated with the provided code.
Providers[].Qualifications[].Description
String
ReliableContains a human-readable description of the given qualification.
Providers[].Qualifications[].StartDate
String
ReliableDisplays the date that the given qualification is valid.
In ISO 8601 format
Providers[].Qualifications[].EndDate
String
ReliableDisplays the date that the given qualification expires.
In ISO 8601 format
Providers[].Roles[]
Array of Objects
ProbableContains the role(s) that the provider has served or currently serves in.
Providers[].Roles[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and and types for the given role.
Providers[].Roles[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given role.
Providers[].Roles[].Identifiers[].IDType
String
ReliableDefines the type of identifier for the given role.
Providers[].Roles[].Organization
Object
ReliableDescribes the organization where the provider has or currently operates in the given role.
Providers[].Roles[].Organization.Identifiers[]
Array of Objects
ReliableLists one or more identifiers for the organization associated with the role.
Providers[].Roles[].Organization.Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given organization.
Providers[].Roles[].Organization.Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given organization.
Providers[].Roles[].Organization.IsActive
String
ReliableIndicates whether the given organization is currently active.
Providers[].Roles[].Organization.Type
String
ReliableDescribes the type of the organization associated with the role.
Providers[].Roles[].Organization.Name
String
ReliableDisplays the name of the organization associated with the role.
Providers[].Roles[].Organization.Address.StreetAddress
String
ReliableDisplays the street address where the organization is based.
Providers[].Roles[].Organization.Address.City
String
ReliableDisplays the city where the organization is based.
Providers[].Roles[].Organization.Address.State
String
ReliableDisplays the state where the organization is based.
Providers[].Roles[].Organization.Address.ZIP
String
ReliableDisplays the postal code where the organization is based.
Providers[].Roles[].Organization.Address.County
String
ReliableDisplays the county where the organization is based.
Providers[].Roles[].Organization.Address.Country
String
ReliableDisplays the country where the organization is based.
Providers[].Roles[].Specialties[]
Array of Objects
ProbableLists the coded representation of a given specialty associated with the role.
Providers[].Roles[].Specialties[].Code
String
ProbableCode
Providers[].Roles[].Specialties[].Codeset
String
ProbableCode set
Providers[].Roles[].Specialties[].Description
String
ProbableDescription
Providers[].Roles[].Locations[]
Array of Objects
ReliableLists the specific facilities where the provider provides care while serving in the given role.
Providers[].Roles[].Locations[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and types that identify the location/
Providers[].Roles[].Locations[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given location.
Providers[].Roles[].Locations[].Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given location.
Providers[].Roles[].Locations[].Status
String
ReliableIndicates whether the given location is currently active, suspended, or inactive.
One of Active, Suspended, Inactive
Providers[].Roles[].Locations[].Name
String
ReliableDisplays the name of the given location.
Providers[].Roles[].Locations[].Description
String
ReliableContains a human-readable description of the given location.
Providers[].Roles[].Locations[].Address.StreetAddress
String
ReliableDisplays the street for the given location.
Providers[].Roles[].Locations[].Address.City
String
ReliableDisplays the city for the current location.
Providers[].Roles[].Locations[].Address.State
String
ReliableDisplays the state/province for the given location.
Providers[].Roles[].Locations[].Address.ZIP
String
ReliableDisplays the postal code for the given location.
Providers[].Roles[].Locations[].Address.County
String
ReliableDisplays the county for the given location.
Providers[].Roles[].Locations[].Address.Country
String
ReliableDisplays the country for the given location.
Providers[].Roles[].Locations[].EmailAddresses[]
Array of Strings
ReliableContains contact information for the location, specifically the email address(es).
Providers[].Roles[].Locations[].PhoneNumber.Office
String
ReliableContains contact information for the location, specifically the phone number(s).
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Services[]
Array of Objects
ReliableDescribes the healthcare services that the provider offers while serving in the given role.
Providers[].Roles[].Services[].Identifiers[]
String
ReliableLists one or more identifiers for the healthcare services associated with the role.
Providers[].Roles[].Services[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given service.
Providers[].Roles[].Services[].Identifiers[].IDType
String
ReliableDefines the type of identifier for the given service
Providers[].Roles[].Services[].Type
String
ReliableDescribes the type of healthcare service that may be delivered or performed for the given service.
Providers[].Roles[].Services[].Description
String
ReliableContains a human-readable description of the given service.
Providers[].Roles[].Services[].PhoneNumber.Office
String
ReliableDisplays the office phone number for information on the given service.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Availability[]
Array of Objects
PossibleDefines 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
ReliableDisplays 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
ReliableDisplays the UTC start time for the provider's availability in the given role.
ISO 8601 Format
Providers[].Roles[].Availability[].AvailableEndTime
Time
ReliableDisplays the UTC end time for the provider’s availability in the given role.
ISO 8601 Format
{
"Meta": {
"DataModel": "Provider",
"EventType": "Update",
"EventDateTime": "2023-12-05T15:06:15.449Z",
"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"
}
]
}
]
}
]
}
Activatelink
BETAAn Activate message is used to convey that a provider's status has changed from Inactive to Active.
Fields
Meta
Meta.DataModel
String
ReliableRequiredProvider
Meta.EventType
String
ReliableRequiredProviderQueryResponse
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies 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
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains 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
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies 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
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode 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
ReliableThe list of providers
Providers[].Identifiers[]
Array of Objects
ReliableLists one or more identifiers associated with the provider.
Providers[].Identifiers[].ID
String
ReliableRequiredDisplays an identifier used to identify the provider in the EHR system.
Providers[].Identifiers[].IDType
String
ReliableDisplays the type of identifier used to identify the provider.
e.g. NPI
Providers[].Demographics.FirstName
String
ReliableDisplays the provider's first name.
Providers[].Demographics.LastName
String
ReliableDisplays the provider's last name
Providers[].Demographics.MiddleName
String
PossibleDisplays the provider's middle name
Providers[].Demographics.Credentials[]
Array of Strings
PossibleLists the provider’s relevant credentials.
e.g. MD, PhD
Providers[].Demographics.Addresses[]
Array of Objects
ProbableDisplays a list of addresses associated with the provider.
These are addresses where the practitioner performs services, not residential addresses.
Providers[].Demographics.Addresses[].Use
String
ReliableThe use for this address.
e.g. Home, Office
Providers[].Demographics.Addresses[].StreetAddress
String
ReliableDisplays the street for a given address.
Providers[].Demographics.Addresses[].City
String
ReliableDisplays the city for a given address.
Providers[].Demographics.Addresses[].State
String
ReliableDisplays the state for a given address.
Providers[].Demographics.Addresses[].ZIP
String
ReliableDisplays the postal code for a given address.
Providers[].Demographics.Addresses[].County
String
ReliableDisplays the county for a given address.
Providers[].Demographics.Addresses[].Country
String
ReliableDisplays the country for a given address.
Providers[].Demographics.EmailAddresses[]
Array of Strings
ProbableContains contact information for the provider, specifically any email addresses associated with the provider.
Providers[].Demographics.PhoneNumber.Home
String
ProbableContains 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
ReliableContains 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
ProbableContains 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
ReliableValueSetDisplays the provider's sex.
-
Additional values may be added by Redox in the future.
-
Providers[].Demographics.DOB
String
ReliableDisplays the provider's date of birth.
In ISO 8601 format
Providers[].Demographics.Languages[]
Array of Strings
ReliableLists one or more languages that the provider can use to communicate with patients.
Providers[].Qualifications[]
Array of Objects
PossibleLists one or more qualifications the provider has obtained through professional training and certification.
Providers[].Qualifications[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and types for a given qualification.
Providers[].Qualifications[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given qualification.
Providers[].Qualifications[].Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given qualification.
Providers[].Qualifications[].Code
String
ReliableDisplays a coded representation of the given qualification.
Providers[].Qualifications[].Codeset
String
ReliableDisplays the codeset associated with the provided code.
Providers[].Qualifications[].Description
String
ReliableContains a human-readable description of the given qualification.
Providers[].Qualifications[].StartDate
String
ReliableDisplays the date that the given qualification is valid.
In ISO 8601 format
Providers[].Qualifications[].EndDate
String
ReliableDisplays the date that the given qualification expires.
In ISO 8601 format
Providers[].Roles[]
Array of Objects
ProbableContains the role(s) that the provider has served or currently serves in.
Providers[].Roles[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and and types for the given role.
Providers[].Roles[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given role.
Providers[].Roles[].Identifiers[].IDType
String
ReliableDefines the type of identifier for the given role.
Providers[].Roles[].Organization
Object
ReliableDescribes the organization where the provider has or currently operates in the given role.
Providers[].Roles[].Organization.Identifiers[]
Array of Objects
ReliableLists one or more identifiers for the organization associated with the role.
Providers[].Roles[].Organization.Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given organization.
Providers[].Roles[].Organization.Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given organization.
Providers[].Roles[].Organization.IsActive
String
ReliableIndicates whether the given organization is currently active.
Providers[].Roles[].Organization.Type
String
ReliableDescribes the type of the organization associated with the role.
Providers[].Roles[].Organization.Name
String
ReliableDisplays the name of the organization associated with the role.
Providers[].Roles[].Organization.Address.StreetAddress
String
ReliableDisplays the street address where the organization is based.
Providers[].Roles[].Organization.Address.City
String
ReliableDisplays the city where the organization is based.
Providers[].Roles[].Organization.Address.State
String
ReliableDisplays the state where the organization is based.
Providers[].Roles[].Organization.Address.ZIP
String
ReliableDisplays the postal code where the organization is based.
Providers[].Roles[].Organization.Address.County
String
ReliableDisplays the county where the organization is based.
Providers[].Roles[].Organization.Address.Country
String
ReliableDisplays the country where the organization is based.
Providers[].Roles[].Specialties[]
Array of Objects
ProbableLists the coded representation of a given specialty associated with the role.
Providers[].Roles[].Specialties[].Code
String
ProbableCode
Providers[].Roles[].Specialties[].Codeset
String
ProbableCode set
Providers[].Roles[].Specialties[].Description
String
ProbableDescription
Providers[].Roles[].Locations[]
Array of Objects
ReliableLists the specific facilities where the provider provides care while serving in the given role.
Providers[].Roles[].Locations[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and types that identify the location/
Providers[].Roles[].Locations[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given location.
Providers[].Roles[].Locations[].Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given location.
Providers[].Roles[].Locations[].Status
String
ReliableIndicates whether the given location is currently active, suspended, or inactive.
One of Active, Suspended, Inactive
Providers[].Roles[].Locations[].Name
String
ReliableDisplays the name of the given location.
Providers[].Roles[].Locations[].Description
String
ReliableContains a human-readable description of the given location.
Providers[].Roles[].Locations[].Address.StreetAddress
String
ReliableDisplays the street for the given location.
Providers[].Roles[].Locations[].Address.City
String
ReliableDisplays the city for the current location.
Providers[].Roles[].Locations[].Address.State
String
ReliableDisplays the state/province for the given location.
Providers[].Roles[].Locations[].Address.ZIP
String
ReliableDisplays the postal code for the given location.
Providers[].Roles[].Locations[].Address.County
String
ReliableDisplays the county for the given location.
Providers[].Roles[].Locations[].Address.Country
String
ReliableDisplays the country for the given location.
Providers[].Roles[].Locations[].EmailAddresses[]
Array of Strings
ReliableContains contact information for the location, specifically the email address(es).
Providers[].Roles[].Locations[].PhoneNumber.Office
String
ReliableContains contact information for the location, specifically the phone number(s).
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Services[]
Array of Objects
ReliableDescribes the healthcare services that the provider offers while serving in the given role.
Providers[].Roles[].Services[].Identifiers[]
String
ReliableLists one or more identifiers for the healthcare services associated with the role.
Providers[].Roles[].Services[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given service.
Providers[].Roles[].Services[].Identifiers[].IDType
String
ReliableDefines the type of identifier for the given service
Providers[].Roles[].Services[].Type
String
ReliableDescribes the type of healthcare service that may be delivered or performed for the given service.
Providers[].Roles[].Services[].Description
String
ReliableContains a human-readable description of the given service.
Providers[].Roles[].Services[].PhoneNumber.Office
String
ReliableDisplays the office phone number for information on the given service.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Availability[]
Array of Objects
PossibleDefines 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
ReliableDisplays 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
ReliableDisplays the UTC start time for the provider's availability in the given role.
ISO 8601 Format
Providers[].Roles[].Availability[].AvailableEndTime
Time
ReliableDisplays the UTC end time for the provider’s availability in the given role.
ISO 8601 Format
{
"Meta": {
"DataModel": "Provider",
"EventType": "Activate",
"EventDateTime": "2023-12-05T15:06:15.449Z",
"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"
}
]
}
]
}
]
}
Deactivatelink
BETAAn Deactivate message is used to convey that a provider's status has changed from Active to Inactive.
Fields
Meta
Meta.DataModel
String
ReliableRequiredProvider
Meta.EventType
String
ReliableRequiredProviderQueryResponse
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies 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
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains 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
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies 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
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode 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
ReliableThe list of providers
Providers[].Identifiers[]
Array of Objects
ReliableLists one or more identifiers associated with the provider.
Providers[].Identifiers[].ID
String
ReliableRequiredDisplays an identifier used to identify the provider in the EHR system.
Providers[].Identifiers[].IDType
String
ReliableDisplays the type of identifier used to identify the provider.
e.g. NPI
Providers[].Demographics.FirstName
String
ReliableDisplays the provider's first name.
Providers[].Demographics.LastName
String
ReliableDisplays the provider's last name
Providers[].Demographics.MiddleName
String
PossibleDisplays the provider's middle name
Providers[].Demographics.Credentials[]
Array of Strings
PossibleLists the provider’s relevant credentials.
e.g. MD, PhD
Providers[].Demographics.Addresses[]
Array of Objects
ProbableDisplays a list of addresses associated with the provider.
These are addresses where the practitioner performs services, not residential addresses.
Providers[].Demographics.Addresses[].Use
String
ReliableThe use for this address.
e.g. Home, Office
Providers[].Demographics.Addresses[].StreetAddress
String
ReliableDisplays the street for a given address.
Providers[].Demographics.Addresses[].City
String
ReliableDisplays the city for a given address.
Providers[].Demographics.Addresses[].State
String
ReliableDisplays the state for a given address.
Providers[].Demographics.Addresses[].ZIP
String
ReliableDisplays the postal code for a given address.
Providers[].Demographics.Addresses[].County
String
ReliableDisplays the county for a given address.
Providers[].Demographics.Addresses[].Country
String
ReliableDisplays the country for a given address.
Providers[].Demographics.EmailAddresses[]
Array of Strings
ProbableContains contact information for the provider, specifically any email addresses associated with the provider.
Providers[].Demographics.PhoneNumber.Home
String
ProbableContains 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
ReliableContains 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
ProbableContains 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
ReliableValueSetDisplays the provider's sex.
-
Additional values may be added by Redox in the future.
-
Providers[].Demographics.DOB
String
ReliableDisplays the provider's date of birth.
In ISO 8601 format
Providers[].Demographics.Languages[]
Array of Strings
ReliableLists one or more languages that the provider can use to communicate with patients.
Providers[].Qualifications[]
Array of Objects
PossibleLists one or more qualifications the provider has obtained through professional training and certification.
Providers[].Qualifications[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and types for a given qualification.
Providers[].Qualifications[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given qualification.
Providers[].Qualifications[].Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given qualification.
Providers[].Qualifications[].Code
String
ReliableDisplays a coded representation of the given qualification.
Providers[].Qualifications[].Codeset
String
ReliableDisplays the codeset associated with the provided code.
Providers[].Qualifications[].Description
String
ReliableContains a human-readable description of the given qualification.
Providers[].Qualifications[].StartDate
String
ReliableDisplays the date that the given qualification is valid.
In ISO 8601 format
Providers[].Qualifications[].EndDate
String
ReliableDisplays the date that the given qualification expires.
In ISO 8601 format
Providers[].Roles[]
Array of Objects
ProbableContains the role(s) that the provider has served or currently serves in.
Providers[].Roles[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and and types for the given role.
Providers[].Roles[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given role.
Providers[].Roles[].Identifiers[].IDType
String
ReliableDefines the type of identifier for the given role.
Providers[].Roles[].Organization
Object
ReliableDescribes the organization where the provider has or currently operates in the given role.
Providers[].Roles[].Organization.Identifiers[]
Array of Objects
ReliableLists one or more identifiers for the organization associated with the role.
Providers[].Roles[].Organization.Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given organization.
Providers[].Roles[].Organization.Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given organization.
Providers[].Roles[].Organization.IsActive
String
ReliableIndicates whether the given organization is currently active.
Providers[].Roles[].Organization.Type
String
ReliableDescribes the type of the organization associated with the role.
Providers[].Roles[].Organization.Name
String
ReliableDisplays the name of the organization associated with the role.
Providers[].Roles[].Organization.Address.StreetAddress
String
ReliableDisplays the street address where the organization is based.
Providers[].Roles[].Organization.Address.City
String
ReliableDisplays the city where the organization is based.
Providers[].Roles[].Organization.Address.State
String
ReliableDisplays the state where the organization is based.
Providers[].Roles[].Organization.Address.ZIP
String
ReliableDisplays the postal code where the organization is based.
Providers[].Roles[].Organization.Address.County
String
ReliableDisplays the county where the organization is based.
Providers[].Roles[].Organization.Address.Country
String
ReliableDisplays the country where the organization is based.
Providers[].Roles[].Specialties[]
Array of Objects
ProbableLists the coded representation of a given specialty associated with the role.
Providers[].Roles[].Specialties[].Code
String
ProbableCode
Providers[].Roles[].Specialties[].Codeset
String
ProbableCode set
Providers[].Roles[].Specialties[].Description
String
ProbableDescription
Providers[].Roles[].Locations[]
Array of Objects
ReliableLists the specific facilities where the provider provides care while serving in the given role.
Providers[].Roles[].Locations[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and types that identify the location/
Providers[].Roles[].Locations[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given location.
Providers[].Roles[].Locations[].Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given location.
Providers[].Roles[].Locations[].Status
String
ReliableIndicates whether the given location is currently active, suspended, or inactive.
One of Active, Suspended, Inactive
Providers[].Roles[].Locations[].Name
String
ReliableDisplays the name of the given location.
Providers[].Roles[].Locations[].Description
String
ReliableContains a human-readable description of the given location.
Providers[].Roles[].Locations[].Address.StreetAddress
String
ReliableDisplays the street for the given location.
Providers[].Roles[].Locations[].Address.City
String
ReliableDisplays the city for the current location.
Providers[].Roles[].Locations[].Address.State
String
ReliableDisplays the state/province for the given location.
Providers[].Roles[].Locations[].Address.ZIP
String
ReliableDisplays the postal code for the given location.
Providers[].Roles[].Locations[].Address.County
String
ReliableDisplays the county for the given location.
Providers[].Roles[].Locations[].Address.Country
String
ReliableDisplays the country for the given location.
Providers[].Roles[].Locations[].EmailAddresses[]
Array of Strings
ReliableContains contact information for the location, specifically the email address(es).
Providers[].Roles[].Locations[].PhoneNumber.Office
String
ReliableContains contact information for the location, specifically the phone number(s).
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Services[]
Array of Objects
ReliableDescribes the healthcare services that the provider offers while serving in the given role.
Providers[].Roles[].Services[].Identifiers[]
String
ReliableLists one or more identifiers for the healthcare services associated with the role.
Providers[].Roles[].Services[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given service.
Providers[].Roles[].Services[].Identifiers[].IDType
String
ReliableDefines the type of identifier for the given service
Providers[].Roles[].Services[].Type
String
ReliableDescribes the type of healthcare service that may be delivered or performed for the given service.
Providers[].Roles[].Services[].Description
String
ReliableContains a human-readable description of the given service.
Providers[].Roles[].Services[].PhoneNumber.Office
String
ReliableDisplays the office phone number for information on the given service.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Availability[]
Array of Objects
PossibleDefines 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
ReliableDisplays 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
ReliableDisplays the UTC start time for the provider's availability in the given role.
ISO 8601 Format
Providers[].Roles[].Availability[].AvailableEndTime
Time
ReliableDisplays the UTC end time for the provider’s availability in the given role.
ISO 8601 Format
{
"Meta": {
"DataModel": "Provider",
"EventType": "Deactivate",
"EventDateTime": "2023-12-05T15:06:15.449Z",
"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"
}
]
}
]
}
]
}
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
Meta
Meta.DataModel
String
ReliableRequiredProvider
Meta.EventType
String
ReliableRequiredProviderQuery
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies 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
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains 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
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies 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
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode 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
ReliableList of IDs and ID types that identify the provider
Provider.Identifiers[].ID
String
ReliableID for the provider
Provider.Identifiers[].IDType
String
ReliableType of ID for the provider
Provider.Demographics.FirstName
String
ReliableProvider's first name
Provider.Demographics.LastName
String
ReliableProvider's last name
Provider.Demographics.MiddleName
String
PossibleProvider's middle name
Provider.Demographics.Address
Object
PossibleProvider's address
Provider.Demographics.Address.City
String
PossibleCity
Provider.Demographics.Address.State
String
PossibleState
Provider.Demographics.Address.ZIP
String
PossibleZIP
{
"Meta": {
"DataModel": "Provider",
"EventType": "ProviderQuery",
"EventDateTime": "2023-12-05T15:06:15.449Z",
"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
}
}
}
}
A Provider Query Response message is used in response to a Provider Query.
Fields
Meta
Meta.DataModel
String
ReliableRequiredProvider
Meta.EventType
String
ReliableRequiredProviderQueryResponse
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies 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
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains 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
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies 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
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode 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
ReliableThe list of providers
Providers[].Identifiers[]
Array of Objects
ReliableLists one or more identifiers associated with the provider.
Providers[].Identifiers[].ID
String
ReliableRequiredDisplays an identifier used to identify the provider in the EHR system.
Providers[].Identifiers[].IDType
String
ReliableDisplays the type of identifier used to identify the provider.
e.g. NPI
Providers[].IsActive
Boolean
ReliableRequiredIndicates whether the given provider is actively practicing or not.
Providers[].Demographics.FirstName
String
ReliableDisplays the provider's first name.
Providers[].Demographics.LastName
String
ReliableDisplays the provider's last name
Providers[].Demographics.MiddleName
String
PossibleDisplays the provider's middle name
Providers[].Demographics.Credentials[]
Array of Strings
PossibleLists the provider’s relevant credentials.
e.g. MD, PhD
Providers[].Demographics.Addresses[]
Array of Objects
ProbableDisplays a list of addresses associated with the provider.
These are addresses where the practitioner performs services, not residential addresses.
Providers[].Demographics.Addresses[].Use
String
ReliableThe use for this address.
e.g. Home, Office
Providers[].Demographics.Addresses[].StreetAddress
String
ReliableDisplays the street for a given address.
Providers[].Demographics.Addresses[].City
String
ReliableDisplays the city for a given address.
Providers[].Demographics.Addresses[].State
String
ReliableDisplays the state for a given address.
Providers[].Demographics.Addresses[].ZIP
String
ReliableDisplays the postal code for a given address.
Providers[].Demographics.Addresses[].County
String
ReliableDisplays the county for a given address.
Providers[].Demographics.Addresses[].Country
String
ReliableDisplays the country for a given address.
Providers[].Demographics.EmailAddresses[]
Array of Strings
ProbableContains contact information for the provider, specifically any email addresses associated with the provider.
Providers[].Demographics.PhoneNumber.Home
String
ProbableContains 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
ReliableContains 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
ProbableContains 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
ReliableValueSetDisplays the provider's sex.
-
Additional values may be added by Redox in the future.
-
Providers[].Demographics.DOB
String
ReliableDisplays the provider's date of birth.
In ISO 8601 format
Providers[].Demographics.Languages[]
Array of Strings
ReliableLists one or more languages that the provider can use to communicate with patients.
Providers[].Qualifications[]
Array of Objects
PossibleLists one or more qualifications the provider has obtained through professional training and certification.
Providers[].Qualifications[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and types for a given qualification.
Providers[].Qualifications[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given qualification.
Providers[].Qualifications[].Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given qualification.
Providers[].Qualifications[].Code
String
ReliableDisplays a coded representation of the given qualification.
Providers[].Qualifications[].Codeset
String
ReliableDisplays the codeset associated with the provided code.
Providers[].Qualifications[].Description
String
ReliableContains a human-readable description of the given qualification.
Providers[].Qualifications[].StartDate
String
ReliableDisplays the date that the given qualification is valid.
In ISO 8601 format
Providers[].Qualifications[].EndDate
String
ReliableDisplays the date that the given qualification expires.
In ISO 8601 format
Providers[].Roles[]
Array of Objects
ProbableContains the role(s) that the provider has served or currently serves in.
Providers[].Roles[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and and types for the given role.
Providers[].Roles[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given role.
Providers[].Roles[].Identifiers[].IDType
String
ReliableDefines the type of identifier for the given role.
Providers[].Roles[].Organization
Object
ReliableDescribes the organization where the provider has or currently operates in the given role.
Providers[].Roles[].Organization.Identifiers[]
Array of Objects
ReliableLists one or more identifiers for the organization associated with the role.
Providers[].Roles[].Organization.Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given organization.
Providers[].Roles[].Organization.Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given organization.
Providers[].Roles[].Organization.IsActive
String
ReliableIndicates whether the given organization is currently active.
Providers[].Roles[].Organization.Type
String
ReliableDescribes the type of the organization associated with the role.
Providers[].Roles[].Organization.Name
String
ReliableDisplays the name of the organization associated with the role.
Providers[].Roles[].Organization.Address.StreetAddress
String
ReliableDisplays the street address where the organization is based.
Providers[].Roles[].Organization.Address.City
String
ReliableDisplays the city where the organization is based.
Providers[].Roles[].Organization.Address.State
String
ReliableDisplays the state where the organization is based.
Providers[].Roles[].Organization.Address.ZIP
String
ReliableDisplays the postal code where the organization is based.
Providers[].Roles[].Organization.Address.County
String
ReliableDisplays the county where the organization is based.
Providers[].Roles[].Organization.Address.Country
String
ReliableDisplays the country where the organization is based.
Providers[].Roles[].Specialties[]
Array of Objects
ProbableLists the coded representation of a given specialty associated with the role.
Providers[].Roles[].Specialties[].Code
String
ProbableCode
Providers[].Roles[].Specialties[].Codeset
String
ProbableCode set
Providers[].Roles[].Specialties[].Description
String
ProbableDescription
Providers[].Roles[].Locations[]
Array of Objects
ReliableLists the specific facilities where the provider provides care while serving in the given role.
Providers[].Roles[].Locations[].Identifiers[]
Array of Objects
ReliableDisplays a list of identifiers and types that identify the location/
Providers[].Roles[].Locations[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given location.
Providers[].Roles[].Locations[].Identifiers[].IDType
String
ReliableDisplays the type of the identifier for the given location.
Providers[].Roles[].Locations[].Status
String
ReliableIndicates whether the given location is currently active, suspended, or inactive.
One of Active, Suspended, Inactive
Providers[].Roles[].Locations[].Name
String
ReliableDisplays the name of the given location.
Providers[].Roles[].Locations[].Description
String
ReliableContains a human-readable description of the given location.
Providers[].Roles[].Locations[].Address.StreetAddress
String
ReliableDisplays the street for the given location.
Providers[].Roles[].Locations[].Address.City
String
ReliableDisplays the city for the current location.
Providers[].Roles[].Locations[].Address.State
String
ReliableDisplays the state/province for the given location.
Providers[].Roles[].Locations[].Address.ZIP
String
ReliableDisplays the postal code for the given location.
Providers[].Roles[].Locations[].Address.County
String
ReliableDisplays the county for the given location.
Providers[].Roles[].Locations[].Address.Country
String
ReliableDisplays the country for the given location.
Providers[].Roles[].Locations[].EmailAddresses[]
Array of Strings
ReliableContains contact information for the location, specifically the email address(es).
Providers[].Roles[].Locations[].PhoneNumber.Office
String
ReliableContains contact information for the location, specifically the phone number(s).
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Services[]
Array of Objects
ReliableDescribes the healthcare services that the provider offers while serving in the given role.
Providers[].Roles[].Services[].Identifiers[]
String
ReliableLists one or more identifiers for the healthcare services associated with the role.
Providers[].Roles[].Services[].Identifiers[].ID
String
ReliableDisplays a string identifier provided by a third-party system for the given service.
Providers[].Roles[].Services[].Identifiers[].IDType
String
ReliableDefines the type of identifier for the given service
Providers[].Roles[].Services[].Type
String
ReliableDescribes the type of healthcare service that may be delivered or performed for the given service.
Providers[].Roles[].Services[].Description
String
ReliableContains a human-readable description of the given service.
Providers[].Roles[].Services[].PhoneNumber.Office
String
ReliableDisplays the office phone number for information on the given service.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Availability[]
Array of Objects
PossibleDefines 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
ReliableDisplays 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
ReliableDisplays the UTC start time for the provider's availability in the given role.
ISO 8601 Format
Providers[].Roles[].Availability[].AvailableEndTime
Time
ReliableDisplays the UTC end time for the provider’s availability in the given role.
ISO 8601 Format
{
"Meta": {
"DataModel": "Provider",
"EventType": "ProviderQueryResponse",
"EventDateTime": "2023-12-05T15:06:15.449Z",
"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"
}
]
}
]
}
]
}