Provider
The Provider data model contains New, Update, Activate, Deactivate, and Query events. Provider information such as demographics, qualifications, and roles can be sent with each of these events.
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
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Logs[]
Array of Objects
ReliableRequest log identifiers.
Meta.Logs[].ID
String
ReliableID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID
Meta.Logs[].AttemptID
String
ReliableID of request log attempt. Useful in cases where retries are possible.
UUID
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
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
ReliableList of IDs and ID types that identify the provider
Providers[].Identifiers[].ID
String
ReliableRequiredID for the provider
Providers[].Identifiers[].IDType
String
ReliableType of ID for the provider
Providers[].IsActive
Boolean
ReliableRequiredWhether the entry for this provider is active or inactive
Providers[].Demographics.FirstName
String
ReliableProvider's first name
Providers[].Demographics.LastName
String
ReliableProvider's last name
Providers[].Demographics.MiddleName
String
PossibleProvider's middle name
Providers[].Demographics.Credentials[]
Array of Strings
PossibleList of credentials for the provider.
e.g. MD, PhD
Providers[].Demographics.Addresses[]
Array of Objects
ProbableProvider's addresses
Providers[].Demographics.Addresses[].Use
String
ReliableThe use for this address.
e.g. Home, Office
Providers[].Demographics.Addresses[].StreetAddress
String
ReliableStreet address
Providers[].Demographics.Addresses[].City
String
ReliableCity
Providers[].Demographics.Addresses[].State
String
ReliableState
Providers[].Demographics.Addresses[].ZIP
String
ReliableZip code
Providers[].Demographics.Addresses[].County
String
ReliableCounty
Providers[].Demographics.Addresses[].Country
String
ReliableCountry
Providers[].Demographics.EmailAddresses[]
Array of Strings
ProbableEmail addresses for the provider
Providers[].Demographics.PhoneNumber.Home
String
ProbableProvider's home phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.PhoneNumber.Office
String
ReliableProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.PhoneNumber.Mobile
String
ProbableProvider's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.Sex
String
ReliableValueSetProvider's sex.
-
Additional values may be added by Redox in the future.
-
Providers[].Demographics.DOB
String
ReliableProvider's date of birth.
In ISO 8601 format
Providers[].Demographics.Languages[]
Array of Strings
ReliableLanguages the provider is able to use in patient communication
Providers[].Qualifications[]
Array of Objects
PossibleProvider's qualifications obtained by training and certification
Providers[].Qualifications[].Identifiers[]
Array of Objects
ReliableList of IDs and ID Types that identify the qualification
Providers[].Qualifications[].Identifiers[].ID
String
ReliableIdentifier for the qualification
Providers[].Qualifications[].Identifiers[].IDType
String
ReliableType of ID for the qualification
Providers[].Qualifications[]
Array of Objects
ProbableCoded representation of the qualification
Providers[].Qualifications[].Code
String
ProbableCode
Providers[].Qualifications[].Codeset
String
ProbableCode set
Providers[].Qualifications[].Description
String
ProbableDescription
Providers[].Qualifications[].StartDate
String
ReliableStart date of the qualification.
In ISO 8601 format
Providers[].Qualifications[].EndDate
String
ReliableEnd date of the qualification.
In ISO 8601 format
Providers[].Roles[]
Array of Objects
ProbableRoles that the provider is associated with
Providers[].Roles[].Identifiers[]
Array of Objects
ReliableList of IDs and ID Types that identify the role
Providers[].Roles[].Identifiers[].ID
String
ReliableIdentifier for the role
Providers[].Roles[].Identifiers[].IDType
String
ReliableType of ID for the role
Providers[].Roles[].Organization
Object
ReliableOrganization where the role is available
Providers[].Roles[].Organization.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the organization
Providers[].Roles[].Organization.Identifiers[].ID
String
ReliableID for the organization
Providers[].Roles[].Organization.Identifiers[].IDType
String
ReliableType of ID for the organization
Providers[].Roles[].Organization.IsActive
String
ReliableWhether this role is in active use
Providers[].Roles[].Organization.Type
String
ReliableKind of organization
Providers[].Roles[].Organization.Name
String
ReliableName of the organization
Providers[].Roles[].Organization.Address.StreetAddress
String
ReliableStreet address
Providers[].Roles[].Organization.Address.City
String
ReliableCity
Providers[].Roles[].Organization.Address.State
String
ReliableState
Providers[].Roles[].Organization.Address.ZIP
String
ReliableZip code
Providers[].Roles[].Organization.Address.County
String
ReliableCounty
Providers[].Roles[].Organization.Address.Country
String
ReliableCountry
Providers[].Roles[].Specialties[]
Array of Objects
ProbableCoded representation of the specialty
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
ReliableThe location(s) at which the provider provides care
Providers[].Roles[].Locations[].Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the location
Providers[].Roles[].Locations[].Identifiers[].ID
String
ReliableID for the location
Providers[].Roles[].Locations[].Identifiers[].IDType
String
ReliableType of ID for the location
Providers[].Roles[].Locations[].Status
String
ReliableStatus of the location.
One of Active, Suspended, Inactive
Providers[].Roles[].Locations[].Name
String
ReliableName of the location
Providers[].Roles[].Locations[].Description
String
ReliableAdditional details about the location
Providers[].Roles[].Locations[].Address.StreetAddress
String
ReliableStreet address
Providers[].Roles[].Locations[].Address.City
String
ReliableCity
Providers[].Roles[].Locations[].Address.State
String
ReliableState
Providers[].Roles[].Locations[].Address.ZIP
String
ReliableZip code
Providers[].Roles[].Locations[].Address.County
String
ReliableCounty
Providers[].Roles[].Locations[].Address.Country
String
ReliableCountry
Providers[].Roles[].Locations[].EmailAddresses[]
Array of Strings
ReliableList of email addresses for the location
Providers[].Roles[].Locations[].PhoneNumber.Office
String
ReliableOffice phone number for the location.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Services[]
Array of Objects
ReliableThe list of healthcare services that this worker provides for this role's Organization/Location(s)
Providers[].Roles[].Services[].Identifiers[]
String
ReliableList of IDs and ID types that identify the service
Providers[].Roles[].Services[].Identifiers[].ID
String
ReliableID for the service
Providers[].Roles[].Services[].Identifiers[].IDType
String
ReliableType of ID for the service
Providers[].Roles[].Services[].Type
String
ReliableType of service that may be delivered or performed
Providers[].Roles[].Services[].Description
String
ReliableDescription of the service
Providers[].Roles[].Services[].PhoneNumber.Office
String
ReliableOffice phone number for information on the service.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Availability[]
Array of Objects
PossibleTimes the service location is available
Providers[].Roles[].Availability[].Days[]
Array of Strings
ReliableList of days that this availability schedule applies to.
One of the following: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
Providers[].Roles[].Availability[].AvailableStartTime
Time
ReliableOpening time of day.
ISO 8601 Format
Providers[].Roles[].Availability[].AvailableEndTime
Time
ReliableClosing time of day.
ISO 8601 Format
{
"Meta": {
"DataModel": "Provider",
"EventType": "New",
"EventDateTime": "2022-07-01T17:19:28.573Z",
"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"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"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
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Logs[]
Array of Objects
ReliableRequest log identifiers.
Meta.Logs[].ID
String
ReliableID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID
Meta.Logs[].AttemptID
String
ReliableID of request log attempt. Useful in cases where retries are possible.
UUID
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
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
ReliableList of IDs and ID types that identify the provider
Providers[].Identifiers[].ID
String
ReliableRequiredID for the provider
Providers[].Identifiers[].IDType
String
ReliableType of ID for the provider
Providers[].IsActive
Boolean
ReliableRequiredWhether the entry for this provider is active or inactive
Providers[].Demographics.FirstName
String
ReliableProvider's first name
Providers[].Demographics.LastName
String
ReliableProvider's last name
Providers[].Demographics.MiddleName
String
PossibleProvider's middle name
Providers[].Demographics.Credentials[]
Array of Strings
PossibleList of credentials for the provider.
e.g. MD, PhD
Providers[].Demographics.Addresses[]
Array of Objects
ProbableProvider's addresses
Providers[].Demographics.Addresses[].Use
String
ReliableThe use for this address.
e.g. Home, Office
Providers[].Demographics.Addresses[].StreetAddress
String
ReliableStreet address
Providers[].Demographics.Addresses[].City
String
ReliableCity
Providers[].Demographics.Addresses[].State
String
ReliableState
Providers[].Demographics.Addresses[].ZIP
String
ReliableZip code
Providers[].Demographics.Addresses[].County
String
ReliableCounty
Providers[].Demographics.Addresses[].Country
String
ReliableCountry
Providers[].Demographics.EmailAddresses[]
Array of Strings
ProbableEmail addresses for the provider
Providers[].Demographics.PhoneNumber.Home
String
ProbableProvider's home phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.PhoneNumber.Office
String
ReliableProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.PhoneNumber.Mobile
String
ProbableProvider's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.Sex
String
ReliableValueSetProvider's sex.
-
Additional values may be added by Redox in the future.
-
Providers[].Demographics.DOB
String
ReliableProvider's date of birth.
In ISO 8601 format
Providers[].Demographics.Languages[]
Array of Strings
ReliableLanguages the provider is able to use in patient communication
Providers[].Qualifications[]
Array of Objects
PossibleProvider's qualifications obtained by training and certification
Providers[].Qualifications[].Identifiers[]
Array of Objects
ReliableList of IDs and ID Types that identify the qualification
Providers[].Qualifications[].Identifiers[].ID
String
ReliableIdentifier for the qualification
Providers[].Qualifications[].Identifiers[].IDType
String
ReliableType of ID for the qualification
Providers[].Qualifications[]
Array of Objects
ProbableCoded representation of the qualification
Providers[].Qualifications[].Code
String
ProbableCode
Providers[].Qualifications[].Codeset
String
ProbableCode set
Providers[].Qualifications[].Description
String
ProbableDescription
Providers[].Qualifications[].StartDate
String
ReliableStart date of the qualification.
In ISO 8601 format
Providers[].Qualifications[].EndDate
String
ReliableEnd date of the qualification.
In ISO 8601 format
Providers[].Roles[]
Array of Objects
ProbableRoles that the provider is associated with
Providers[].Roles[].Identifiers[]
Array of Objects
ReliableList of IDs and ID Types that identify the role
Providers[].Roles[].Identifiers[].ID
String
ReliableIdentifier for the role
Providers[].Roles[].Identifiers[].IDType
String
ReliableType of ID for the role
Providers[].Roles[].Organization
Object
ReliableOrganization where the role is available
Providers[].Roles[].Organization.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the organization
Providers[].Roles[].Organization.Identifiers[].ID
String
ReliableID for the organization
Providers[].Roles[].Organization.Identifiers[].IDType
String
ReliableType of ID for the organization
Providers[].Roles[].Organization.IsActive
String
ReliableWhether this role is in active use
Providers[].Roles[].Organization.Type
String
ReliableKind of organization
Providers[].Roles[].Organization.Name
String
ReliableName of the organization
Providers[].Roles[].Organization.Address.StreetAddress
String
ReliableStreet address
Providers[].Roles[].Organization.Address.City
String
ReliableCity
Providers[].Roles[].Organization.Address.State
String
ReliableState
Providers[].Roles[].Organization.Address.ZIP
String
ReliableZip code
Providers[].Roles[].Organization.Address.County
String
ReliableCounty
Providers[].Roles[].Organization.Address.Country
String
ReliableCountry
Providers[].Roles[].Specialties[]
Array of Objects
ProbableCoded representation of the specialty
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
ReliableThe location(s) at which the provider provides care
Providers[].Roles[].Locations[].Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the location
Providers[].Roles[].Locations[].Identifiers[].ID
String
ReliableID for the location
Providers[].Roles[].Locations[].Identifiers[].IDType
String
ReliableType of ID for the location
Providers[].Roles[].Locations[].Status
String
ReliableStatus of the location.
One of Active, Suspended, Inactive
Providers[].Roles[].Locations[].Name
String
ReliableName of the location
Providers[].Roles[].Locations[].Description
String
ReliableAdditional details about the location
Providers[].Roles[].Locations[].Address.StreetAddress
String
ReliableStreet address
Providers[].Roles[].Locations[].Address.City
String
ReliableCity
Providers[].Roles[].Locations[].Address.State
String
ReliableState
Providers[].Roles[].Locations[].Address.ZIP
String
ReliableZip code
Providers[].Roles[].Locations[].Address.County
String
ReliableCounty
Providers[].Roles[].Locations[].Address.Country
String
ReliableCountry
Providers[].Roles[].Locations[].EmailAddresses[]
Array of Strings
ReliableList of email addresses for the location
Providers[].Roles[].Locations[].PhoneNumber.Office
String
ReliableOffice phone number for the location.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Services[]
Array of Objects
ReliableThe list of healthcare services that this worker provides for this role's Organization/Location(s)
Providers[].Roles[].Services[].Identifiers[]
String
ReliableList of IDs and ID types that identify the service
Providers[].Roles[].Services[].Identifiers[].ID
String
ReliableID for the service
Providers[].Roles[].Services[].Identifiers[].IDType
String
ReliableType of ID for the service
Providers[].Roles[].Services[].Type
String
ReliableType of service that may be delivered or performed
Providers[].Roles[].Services[].Description
String
ReliableDescription of the service
Providers[].Roles[].Services[].PhoneNumber.Office
String
ReliableOffice phone number for information on the service.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Availability[]
Array of Objects
PossibleTimes the service location is available
Providers[].Roles[].Availability[].Days[]
Array of Strings
ReliableList of days that this availability schedule applies to.
One of the following: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
Providers[].Roles[].Availability[].AvailableStartTime
Time
ReliableOpening time of day.
ISO 8601 Format
Providers[].Roles[].Availability[].AvailableEndTime
Time
ReliableClosing time of day.
ISO 8601 Format
{
"Meta": {
"DataModel": "Provider",
"EventType": "Update",
"EventDateTime": "2022-07-01T17:19:28.573Z",
"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"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"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
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Logs[]
Array of Objects
ReliableRequest log identifiers.
Meta.Logs[].ID
String
ReliableID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID
Meta.Logs[].AttemptID
String
ReliableID of request log attempt. Useful in cases where retries are possible.
UUID
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
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
ReliableList of IDs and ID types that identify the provider
Providers[].Identifiers[].ID
String
ReliableRequiredID for the provider
Providers[].Identifiers[].IDType
String
ReliableType of ID for the provider
Providers[].Demographics.FirstName
String
ReliableProvider's first name
Providers[].Demographics.LastName
String
ReliableProvider's last name
Providers[].Demographics.MiddleName
String
PossibleProvider's middle name
Providers[].Demographics.Credentials[]
Array of Strings
PossibleList of credentials for the provider.
e.g. MD, PhD
Providers[].Demographics.Addresses[]
Array of Objects
ProbableProvider's addresses
Providers[].Demographics.Addresses[].Use
String
ReliableThe use for this address.
e.g. Home, Office
Providers[].Demographics.Addresses[].StreetAddress
String
ReliableStreet address
Providers[].Demographics.Addresses[].City
String
ReliableCity
Providers[].Demographics.Addresses[].State
String
ReliableState
Providers[].Demographics.Addresses[].ZIP
String
ReliableZip code
Providers[].Demographics.Addresses[].County
String
ReliableCounty
Providers[].Demographics.Addresses[].Country
String
ReliableCountry
Providers[].Demographics.EmailAddresses[]
Array of Strings
ProbableEmail addresses for the provider
Providers[].Demographics.PhoneNumber.Home
String
ProbableProvider's home phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.PhoneNumber.Office
String
ReliableProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.PhoneNumber.Mobile
String
ProbableProvider's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.Sex
String
ReliableValueSetProvider's sex.
-
Additional values may be added by Redox in the future.
-
Providers[].Demographics.DOB
String
ReliableProvider's date of birth.
In ISO 8601 format
Providers[].Demographics.Languages[]
Array of Strings
ReliableLanguages the provider is able to use in patient communication
Providers[].Qualifications[]
Array of Objects
PossibleProvider's qualifications obtained by training and certification
Providers[].Qualifications[].Identifiers[]
Array of Objects
ReliableList of IDs and ID Types that identify the qualification
Providers[].Qualifications[].Identifiers[].ID
String
ReliableIdentifier for the qualification
Providers[].Qualifications[].Identifiers[].IDType
String
ReliableType of ID for the qualification
Providers[].Qualifications[]
Array of Objects
ProbableCoded representation of the qualification
Providers[].Qualifications[].Code
String
ProbableCode
Providers[].Qualifications[].Codeset
String
ProbableCode set
Providers[].Qualifications[].Description
String
ProbableDescription
Providers[].Qualifications[].StartDate
String
ReliableStart date of the qualification.
In ISO 8601 format
Providers[].Qualifications[].EndDate
String
ReliableEnd date of the qualification.
In ISO 8601 format
Providers[].Roles[]
Array of Objects
ProbableRoles that the provider is associated with
Providers[].Roles[].Identifiers[]
Array of Objects
ReliableList of IDs and ID Types that identify the role
Providers[].Roles[].Identifiers[].ID
String
ReliableIdentifier for the role
Providers[].Roles[].Identifiers[].IDType
String
ReliableType of ID for the role
Providers[].Roles[].Organization
Object
ReliableOrganization where the role is available
Providers[].Roles[].Organization.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the organization
Providers[].Roles[].Organization.Identifiers[].ID
String
ReliableID for the organization
Providers[].Roles[].Organization.Identifiers[].IDType
String
ReliableType of ID for the organization
Providers[].Roles[].Organization.IsActive
String
ReliableWhether this role is in active use
Providers[].Roles[].Organization.Type
String
ReliableKind of organization
Providers[].Roles[].Organization.Name
String
ReliableName of the organization
Providers[].Roles[].Organization.Address.StreetAddress
String
ReliableStreet address
Providers[].Roles[].Organization.Address.City
String
ReliableCity
Providers[].Roles[].Organization.Address.State
String
ReliableState
Providers[].Roles[].Organization.Address.ZIP
String
ReliableZip code
Providers[].Roles[].Organization.Address.County
String
ReliableCounty
Providers[].Roles[].Organization.Address.Country
String
ReliableCountry
Providers[].Roles[].Specialties[]
Array of Objects
ProbableCoded representation of the specialty
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
ReliableThe location(s) at which the provider provides care
Providers[].Roles[].Locations[].Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the location
Providers[].Roles[].Locations[].Identifiers[].ID
String
ReliableID for the location
Providers[].Roles[].Locations[].Identifiers[].IDType
String
ReliableType of ID for the location
Providers[].Roles[].Locations[].Status
String
ReliableStatus of the location.
One of Active, Suspended, Inactive
Providers[].Roles[].Locations[].Name
String
ReliableName of the location
Providers[].Roles[].Locations[].Description
String
ReliableAdditional details about the location
Providers[].Roles[].Locations[].Address.StreetAddress
String
ReliableStreet address
Providers[].Roles[].Locations[].Address.City
String
ReliableCity
Providers[].Roles[].Locations[].Address.State
String
ReliableState
Providers[].Roles[].Locations[].Address.ZIP
String
ReliableZip code
Providers[].Roles[].Locations[].Address.County
String
ReliableCounty
Providers[].Roles[].Locations[].Address.Country
String
ReliableCountry
Providers[].Roles[].Locations[].EmailAddresses[]
Array of Strings
ReliableList of email addresses for the location
Providers[].Roles[].Locations[].PhoneNumber.Office
String
ReliableOffice phone number for the location.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Services[]
Array of Objects
ReliableThe list of healthcare services that this worker provides for this role's Organization/Location(s)
Providers[].Roles[].Services[].Identifiers[]
String
ReliableList of IDs and ID types that identify the service
Providers[].Roles[].Services[].Identifiers[].ID
String
ReliableID for the service
Providers[].Roles[].Services[].Identifiers[].IDType
String
ReliableType of ID for the service
Providers[].Roles[].Services[].Type
String
ReliableType of service that may be delivered or performed
Providers[].Roles[].Services[].Description
String
ReliableDescription of the service
Providers[].Roles[].Services[].PhoneNumber.Office
String
ReliableOffice phone number for information on the service.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Availability[]
Array of Objects
PossibleTimes the service location is available
Providers[].Roles[].Availability[].Days[]
Array of Strings
ReliableList of days that this availability schedule applies to.
One of the following: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
Providers[].Roles[].Availability[].AvailableStartTime
Time
ReliableOpening time of day.
ISO 8601 Format
Providers[].Roles[].Availability[].AvailableEndTime
Time
ReliableClosing time of day.
ISO 8601 Format
{
"Meta": {
"DataModel": "Provider",
"EventType": "Activate",
"EventDateTime": "2022-07-01T17:19:28.573Z",
"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"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"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
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Logs[]
Array of Objects
ReliableRequest log identifiers.
Meta.Logs[].ID
String
ReliableID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID
Meta.Logs[].AttemptID
String
ReliableID of request log attempt. Useful in cases where retries are possible.
UUID
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
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
ReliableList of IDs and ID types that identify the provider
Providers[].Identifiers[].ID
String
ReliableRequiredID for the provider
Providers[].Identifiers[].IDType
String
ReliableType of ID for the provider
Providers[].Demographics.FirstName
String
ReliableProvider's first name
Providers[].Demographics.LastName
String
ReliableProvider's last name
Providers[].Demographics.MiddleName
String
PossibleProvider's middle name
Providers[].Demographics.Credentials[]
Array of Strings
PossibleList of credentials for the provider.
e.g. MD, PhD
Providers[].Demographics.Addresses[]
Array of Objects
ProbableProvider's addresses
Providers[].Demographics.Addresses[].Use
String
ReliableThe use for this address.
e.g. Home, Office
Providers[].Demographics.Addresses[].StreetAddress
String
ReliableStreet address
Providers[].Demographics.Addresses[].City
String
ReliableCity
Providers[].Demographics.Addresses[].State
String
ReliableState
Providers[].Demographics.Addresses[].ZIP
String
ReliableZip code
Providers[].Demographics.Addresses[].County
String
ReliableCounty
Providers[].Demographics.Addresses[].Country
String
ReliableCountry
Providers[].Demographics.EmailAddresses[]
Array of Strings
ProbableEmail addresses for the provider
Providers[].Demographics.PhoneNumber.Home
String
ProbableProvider's home phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.PhoneNumber.Office
String
ReliableProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.PhoneNumber.Mobile
String
ProbableProvider's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.Sex
String
ReliableValueSetProvider's sex.
-
Additional values may be added by Redox in the future.
-
Providers[].Demographics.DOB
String
ReliableProvider's date of birth.
In ISO 8601 format
Providers[].Demographics.Languages[]
Array of Strings
ReliableLanguages the provider is able to use in patient communication
Providers[].Qualifications[]
Array of Objects
PossibleProvider's qualifications obtained by training and certification
Providers[].Qualifications[].Identifiers[]
Array of Objects
ReliableList of IDs and ID Types that identify the qualification
Providers[].Qualifications[].Identifiers[].ID
String
ReliableIdentifier for the qualification
Providers[].Qualifications[].Identifiers[].IDType
String
ReliableType of ID for the qualification
Providers[].Qualifications[]
Array of Objects
ProbableCoded representation of the qualification
Providers[].Qualifications[].Code
String
ProbableCode
Providers[].Qualifications[].Codeset
String
ProbableCode set
Providers[].Qualifications[].Description
String
ProbableDescription
Providers[].Qualifications[].StartDate
String
ReliableStart date of the qualification.
In ISO 8601 format
Providers[].Qualifications[].EndDate
String
ReliableEnd date of the qualification.
In ISO 8601 format
Providers[].Roles[]
Array of Objects
ProbableRoles that the provider is associated with
Providers[].Roles[].Identifiers[]
Array of Objects
ReliableList of IDs and ID Types that identify the role
Providers[].Roles[].Identifiers[].ID
String
ReliableIdentifier for the role
Providers[].Roles[].Identifiers[].IDType
String
ReliableType of ID for the role
Providers[].Roles[].Organization
Object
ReliableOrganization where the role is available
Providers[].Roles[].Organization.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the organization
Providers[].Roles[].Organization.Identifiers[].ID
String
ReliableID for the organization
Providers[].Roles[].Organization.Identifiers[].IDType
String
ReliableType of ID for the organization
Providers[].Roles[].Organization.IsActive
String
ReliableWhether this role is in active use
Providers[].Roles[].Organization.Type
String
ReliableKind of organization
Providers[].Roles[].Organization.Name
String
ReliableName of the organization
Providers[].Roles[].Organization.Address.StreetAddress
String
ReliableStreet address
Providers[].Roles[].Organization.Address.City
String
ReliableCity
Providers[].Roles[].Organization.Address.State
String
ReliableState
Providers[].Roles[].Organization.Address.ZIP
String
ReliableZip code
Providers[].Roles[].Organization.Address.County
String
ReliableCounty
Providers[].Roles[].Organization.Address.Country
String
ReliableCountry
Providers[].Roles[].Specialties[]
Array of Objects
ProbableCoded representation of the specialty
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
ReliableThe location(s) at which the provider provides care
Providers[].Roles[].Locations[].Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the location
Providers[].Roles[].Locations[].Identifiers[].ID
String
ReliableID for the location
Providers[].Roles[].Locations[].Identifiers[].IDType
String
ReliableType of ID for the location
Providers[].Roles[].Locations[].Status
String
ReliableStatus of the location.
One of Active, Suspended, Inactive
Providers[].Roles[].Locations[].Name
String
ReliableName of the location
Providers[].Roles[].Locations[].Description
String
ReliableAdditional details about the location
Providers[].Roles[].Locations[].Address.StreetAddress
String
ReliableStreet address
Providers[].Roles[].Locations[].Address.City
String
ReliableCity
Providers[].Roles[].Locations[].Address.State
String
ReliableState
Providers[].Roles[].Locations[].Address.ZIP
String
ReliableZip code
Providers[].Roles[].Locations[].Address.County
String
ReliableCounty
Providers[].Roles[].Locations[].Address.Country
String
ReliableCountry
Providers[].Roles[].Locations[].EmailAddresses[]
Array of Strings
ReliableList of email addresses for the location
Providers[].Roles[].Locations[].PhoneNumber.Office
String
ReliableOffice phone number for the location.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Services[]
Array of Objects
ReliableThe list of healthcare services that this worker provides for this role's Organization/Location(s)
Providers[].Roles[].Services[].Identifiers[]
String
ReliableList of IDs and ID types that identify the service
Providers[].Roles[].Services[].Identifiers[].ID
String
ReliableID for the service
Providers[].Roles[].Services[].Identifiers[].IDType
String
ReliableType of ID for the service
Providers[].Roles[].Services[].Type
String
ReliableType of service that may be delivered or performed
Providers[].Roles[].Services[].Description
String
ReliableDescription of the service
Providers[].Roles[].Services[].PhoneNumber.Office
String
ReliableOffice phone number for information on the service.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Availability[]
Array of Objects
PossibleTimes the service location is available
Providers[].Roles[].Availability[].Days[]
Array of Strings
ReliableList of days that this availability schedule applies to.
One of the following: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
Providers[].Roles[].Availability[].AvailableStartTime
Time
ReliableOpening time of day.
ISO 8601 Format
Providers[].Roles[].Availability[].AvailableEndTime
Time
ReliableClosing time of day.
ISO 8601 Format
{
"Meta": {
"DataModel": "Provider",
"EventType": "Deactivate",
"EventDateTime": "2022-07-01T17:19:28.573Z",
"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"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"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
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Logs[]
Array of Objects
ReliableRequest log identifiers.
Meta.Logs[].ID
String
ReliableID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID
Meta.Logs[].AttemptID
String
ReliableID of request log attempt. Useful in cases where retries are possible.
UUID
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
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": "2022-07-01T17:19:28.573Z",
"Test": true,
"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
ReliableDateTime of the event.
ISO 8601 Format
Meta.Test
Boolean
ReliableFlag as a test message
Meta.Source
String
ReliableWhere the message originated.
Included in messages from Redox
Meta.Source.ID
String
ReliableID of the source.
UUID
Meta.Source.Name
String
ReliableName of the source
Meta.Destinations[]
Array of Objects
ReliableList of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox
Meta.Destinations[].ID
String
ReliableID of the destination.
UUID
Meta.Destinations[].Name
String
ReliableName of the destination
Meta.Logs[]
Array of Objects
ReliableRequest log identifiers.
Meta.Logs[].ID
String
ReliableID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID
Meta.Logs[].AttemptID
String
ReliableID of request log attempt. Useful in cases where retries are possible.
UUID
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source to Redox.
Included in messages from Redox
Meta.Message.ID
Numeric
ReliableID of the message created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to your destination.
Included in messages from Redox
Meta.Transmission.ID
Numeric
ReliableID of the transmission created in Redox.
(Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
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
ReliableList of IDs and ID types that identify the provider
Providers[].Identifiers[].ID
String
ReliableRequiredID for the provider
Providers[].Identifiers[].IDType
String
ReliableType of ID for the provider
Providers[].IsActive
Boolean
ReliableRequiredWhether the entry for this provider is active or inactive
Providers[].Demographics.FirstName
String
ReliableProvider's first name
Providers[].Demographics.LastName
String
ReliableProvider's last name
Providers[].Demographics.MiddleName
String
PossibleProvider's middle name
Providers[].Demographics.Credentials[]
Array of Strings
PossibleList of credentials for the provider.
e.g. MD, PhD
Providers[].Demographics.Addresses[]
Array of Objects
ProbableProvider's addresses
Providers[].Demographics.Addresses[].Use
String
ReliableThe use for this address.
e.g. Home, Office
Providers[].Demographics.Addresses[].StreetAddress
String
ReliableStreet address
Providers[].Demographics.Addresses[].City
String
ReliableCity
Providers[].Demographics.Addresses[].State
String
ReliableState
Providers[].Demographics.Addresses[].ZIP
String
ReliableZip code
Providers[].Demographics.Addresses[].County
String
ReliableCounty
Providers[].Demographics.Addresses[].Country
String
ReliableCountry
Providers[].Demographics.EmailAddresses[]
Array of Strings
ProbableEmail addresses for the provider
Providers[].Demographics.PhoneNumber.Home
String
ProbableProvider's home phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.PhoneNumber.Office
String
ReliableProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.PhoneNumber.Mobile
String
ProbableProvider's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Providers[].Demographics.Sex
String
ReliableValueSetProvider's sex.
-
Additional values may be added by Redox in the future.
-
Providers[].Demographics.DOB
String
ReliableProvider's date of birth.
In ISO 8601 format
Providers[].Demographics.Languages[]
Array of Strings
ReliableLanguages the provider is able to use in patient communication
Providers[].Qualifications[]
Array of Objects
PossibleProvider's qualifications obtained by training and certification
Providers[].Qualifications[].Identifiers[]
Array of Objects
ReliableList of IDs and ID Types that identify the qualification
Providers[].Qualifications[].Identifiers[].ID
String
ReliableIdentifier for the qualification
Providers[].Qualifications[].Identifiers[].IDType
String
ReliableType of ID for the qualification
Providers[].Qualifications[]
Array of Objects
ProbableCoded representation of the qualification
Providers[].Qualifications[].Code
String
ProbableCode
Providers[].Qualifications[].Codeset
String
ProbableCode set
Providers[].Qualifications[].Description
String
ProbableDescription
Providers[].Qualifications[].StartDate
String
ReliableStart date of the qualification.
In ISO 8601 format
Providers[].Qualifications[].EndDate
String
ReliableEnd date of the qualification.
In ISO 8601 format
Providers[].Roles[]
Array of Objects
ProbableRoles that the provider is associated with
Providers[].Roles[].Identifiers[]
Array of Objects
ReliableList of IDs and ID Types that identify the role
Providers[].Roles[].Identifiers[].ID
String
ReliableIdentifier for the role
Providers[].Roles[].Identifiers[].IDType
String
ReliableType of ID for the role
Providers[].Roles[].Organization
Object
ReliableOrganization where the role is available
Providers[].Roles[].Organization.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the organization
Providers[].Roles[].Organization.Identifiers[].ID
String
ReliableID for the organization
Providers[].Roles[].Organization.Identifiers[].IDType
String
ReliableType of ID for the organization
Providers[].Roles[].Organization.IsActive
String
ReliableWhether this role is in active use
Providers[].Roles[].Organization.Type
String
ReliableKind of organization
Providers[].Roles[].Organization.Name
String
ReliableName of the organization
Providers[].Roles[].Organization.Address.StreetAddress
String
ReliableStreet address
Providers[].Roles[].Organization.Address.City
String
ReliableCity
Providers[].Roles[].Organization.Address.State
String
ReliableState
Providers[].Roles[].Organization.Address.ZIP
String
ReliableZip code
Providers[].Roles[].Organization.Address.County
String
ReliableCounty
Providers[].Roles[].Organization.Address.Country
String
ReliableCountry
Providers[].Roles[].Specialties[]
Array of Objects
ProbableCoded representation of the specialty
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
ReliableThe location(s) at which the provider provides care
Providers[].Roles[].Locations[].Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the location
Providers[].Roles[].Locations[].Identifiers[].ID
String
ReliableID for the location
Providers[].Roles[].Locations[].Identifiers[].IDType
String
ReliableType of ID for the location
Providers[].Roles[].Locations[].Status
String
ReliableStatus of the location.
One of Active, Suspended, Inactive
Providers[].Roles[].Locations[].Name
String
ReliableName of the location
Providers[].Roles[].Locations[].Description
String
ReliableAdditional details about the location
Providers[].Roles[].Locations[].Address.StreetAddress
String
ReliableStreet address
Providers[].Roles[].Locations[].Address.City
String
ReliableCity
Providers[].Roles[].Locations[].Address.State
String
ReliableState
Providers[].Roles[].Locations[].Address.ZIP
String
ReliableZip code
Providers[].Roles[].Locations[].Address.County
String
ReliableCounty
Providers[].Roles[].Locations[].Address.Country
String
ReliableCountry
Providers[].Roles[].Locations[].EmailAddresses[]
Array of Strings
ReliableList of email addresses for the location
Providers[].Roles[].Locations[].PhoneNumber.Office
String
ReliableOffice phone number for the location.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Services[]
Array of Objects
ReliableThe list of healthcare services that this worker provides for this role's Organization/Location(s)
Providers[].Roles[].Services[].Identifiers[]
String
ReliableList of IDs and ID types that identify the service
Providers[].Roles[].Services[].Identifiers[].ID
String
ReliableID for the service
Providers[].Roles[].Services[].Identifiers[].IDType
String
ReliableType of ID for the service
Providers[].Roles[].Services[].Type
String
ReliableType of service that may be delivered or performed
Providers[].Roles[].Services[].Description
String
ReliableDescription of the service
Providers[].Roles[].Services[].PhoneNumber.Office
String
ReliableOffice phone number for information on the service.
In E. 164 Format. (e.g. +16085551234)
Providers[].Roles[].Availability[]
Array of Objects
PossibleTimes the service location is available
Providers[].Roles[].Availability[].Days[]
Array of Strings
ReliableList of days that this availability schedule applies to.
One of the following: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
Providers[].Roles[].Availability[].AvailableStartTime
Time
ReliableOpening time of day.
ISO 8601 Format
Providers[].Roles[].Availability[].AvailableEndTime
Time
ReliableClosing time of day.
ISO 8601 Format
{
"Meta": {
"DataModel": "Provider",
"EventType": "ProviderQueryResponse",
"EventDateTime": "2022-07-01T17:19:28.573Z",
"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"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"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"
}
]
}
]
}
]
}