Scheduling
The Scheduling data model is used for communicating information about a patient’s office or non-surgical appointments. EHR systems can send Scheduling messages to update your system with the appointment status, date/time, scheduled providers, and scheduled resources.
Every appointment gets assigned a visit number and patient ID. Any changes to the appointment are made with the relevant visit number. If the appointment is canceled and later rescheduled, however, a new visit number is created. Also keep in mind that Scheduling Holds and Blocks don’t have an associated patient ID.
EHR systems typically make scheduling information available through either a standard SIU HL7v2 feed or a proprietary API. SIU messages follow a push notification model while a proprietary API and web service rely on queries. You may also have the option to use data on demand if you prefer to query but your connection only supports push notifications for scheduling data. For example, if you primarily want information about a booked appointment, you can use the Booked event type to get the information you need with data on demand. Learn more about data on demand.
If you want information about surgical appointments, check out the SurgicalScheduling data model. Or if you’re looking for insurance information for appointments, check out the PatientAdmin data model instead.
A New message is generated and sent outbound from an EHR when an appointment is booked. Similarly, an application can generate and post a New message inbound to the EHR to schedule an appointment.
Fields
Meta
Meta.DataModel
String
ReliableRequiredScheduling
Meta.EventType
String
ReliableRequiredNew
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.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableID for the patient
Patient.Identifiers[].IDType
String
ReliableType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
AppointmentInfo
AppointmentInfo[]
Array of Objects
ProbableContains a list of supplementary clinical information associated with the appointment.
AppointmentInfo[].Code
String
ProbableCode for the information element
AppointmentInfo[].Codeset
String
ProbableCode set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC or other codesets may be used where appropriate.
AppointmentInfo[].Description
String
ProbableDescription of the information element.
Additional information that may come from patient-completed forms or other sources
AppointmentInfo[].Value
String
ReliableDisplays the value of the corresponding appointment info code. For example, the code identifies the question being answered, and this property contains the answer.
Visit
Visit.VisitNumber
String
ReliableRequiredDisplays the unique identifier for the related patient visit.
Visit.AccountNumber
String
PossibleContains an identifier that can span several visits often related to the same patient condition (e.g., surgeries, research study, pregnancy). In other words, the account number can be used to link related visits.
Not supported with data on demand.
Visit.VisitDateTime
String
ReliableRequiredContains the scheduled date and time of the appointment.
ISO 8601 Format
Visit.PatientClass
String
ProbableClassifies the department or type of patient care. Patient class is used in many EHR systems to determine where to put the patient (e.g., inpatient, outpatient, emergency).
Visit.Status
String
ProbableValueSetIndicates the status of the visit.
-
Additional values may be added by Redox in the future.
-
Visit.Duration
Numeric
ReliableRequiredDefines the length of the appointment in minutes.
Visit.Reason
String
ProbableContains is a patient-friendly value that provides context for the purpose of the appointment (e.g., knee pain). This differs from the Visit Type since it can include a clinical component.
Visit.Type
String
ProbableDisplays an administrative value used primarily for bidirectional exchange to update EHR system schedules.
Not supported with data on demand.
Visit.Instructions[]
Array of Strings
ProbableContains any relevant instructions for the patient visit.
Not supported with data on demand.
Visit.AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ConsultingProvider.ID
String
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDType
String
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstName
String
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastName
String
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.Address
Object
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ConsultingProvider.Address.City
String
PossibleCity
Visit.ConsultingProvider.Address.State
String
PossibleState
Visit.ConsultingProvider.Address.ZIP
String
PossibleZIP
Visit.ConsultingProvider.Address.County
String
PossibleCounty
Visit.ConsultingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ConsultingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ConsultingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.Location
Object
PossibleProvider's location
Visit.ConsultingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ConsultingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ConsultingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ConsultingProvider.Location.Department
String
PossibleDepartment
Visit.ConsultingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ConsultingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ConsultingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ConsultingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.VisitProvider.ID
String
PossibleID of the visit provider.
This ID is often required for Inpatient Visits.
Visit.VisitProvider.IDType
String
PossibleID type of the ID for the visit provider
Visit.VisitProvider.FirstName
String
PossibleFirst name of the visit provider
Visit.VisitProvider.LastName
String
PossibleLast name of the visit provider
Visit.VisitProvider.Credentials[]
Array of Strings
PossibleList of credentials for the visit provider.
e.g. MD, PhD
Visit.VisitProvider.Address
Object
PossibleProvider's address
Visit.VisitProvider.Address.StreetAddress
String
PossibleStreet address
Visit.VisitProvider.Address.City
String
PossibleCity
Visit.VisitProvider.Address.State
String
PossibleState
Visit.VisitProvider.Address.ZIP
String
PossibleZIP
Visit.VisitProvider.Address.County
String
PossibleCounty
Visit.VisitProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.VisitProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.VisitProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.VisitProvider.Location
Object
PossibleProvider's location
Visit.VisitProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.VisitProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.VisitProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.VisitProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.VisitProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.VisitProvider.Location.Department
String
PossibleDepartment
Visit.VisitProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.VisitProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.VisitProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.VisitProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location
Object
ReliableDisplays the location of the patient appointment.
Visit.Location.Type
String
ReliableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ReliableFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]
Array of Objects
ReliableList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].ID
String
ReliableAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Department
String
ReliableRequiredDepartment
Visit.Location.DepartmentIdentifiers[]
Array of Objects
ReliableList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].ID
String
ReliableAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Room
String
ReliableRoom.
Example: 136
Visit.AdditionalStaff[]
PossibleContains information about any other staff assigned to the assist with the patient visit. Each may be scheduled individually.
Visit.AdditionalStaff[].ID
String
ProbableID of the Additional staff member.
This ID is often required for Inpatient Visits.
Visit.AdditionalStaff[].IDType
String
ProbableID type of the ID for the Additional staff member
Visit.AdditionalStaff[].FirstName
String
PossibleFirst name of the Additional staff member
Visit.AdditionalStaff[].LastName
String
PossibleLast name of the Additional staff member
Visit.AdditionalStaff[].Credentials[]
Array of Strings
PossibleList of credentials for the Additional staff member.
e.g. MD, PhD
Visit.AdditionalStaff[].Address
Object
PossibleProvider's address
Visit.AdditionalStaff[].Address.StreetAddress
String
PossibleStreet address
Visit.AdditionalStaff[].Address.City
String
PossibleCity
Visit.AdditionalStaff[].Address.State
String
PossibleState
Visit.AdditionalStaff[].Address.ZIP
String
PossibleZIP
Visit.AdditionalStaff[].Address.County
String
PossibleCounty
Visit.AdditionalStaff[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AdditionalStaff[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AdditionalStaff[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AdditionalStaff[].Location
Object
PossibleProvider's location
Visit.AdditionalStaff[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AdditionalStaff[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AdditionalStaff[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Department
String
PossibleDepartment
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Room
String
PossibleRoom.
Example: 136
Visit.AdditionalStaff[].Role
Object
ProbableDefines the role of this person in the patient visit.
Visit.AdditionalStaff[].Role.Code
String
ProbableCode for the service
Visit.AdditionalStaff[].Role.Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Visit.AdditionalStaff[].Role.Description
String
ProbableDescription of the service.
Example: Primary Physician, Technologist, etc.
Visit.AdditionalStaff[].StartDateTime
DateTime
ProbableIf this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.
Visit.AdditionalStaff[].Duration
Numeric
ProbableSpecifies the length of time that the staff member is scheduled for.
In minutes
Visit.Diagnoses[]
Array of Objects
ProbableContains a list of diagnoses associated with the patient visit.
Visit.Diagnoses[].Code
String
ProbableCode for the diagnosis
Visit.Diagnoses[].Codeset
String
ProbableValueSetCode set used to identify the diagnosis
-
Additional values may be added by Redox in the future.
-
Visit.Diagnoses[].Name
String
ProbableName of the diagnosis
Visit.Diagnoses[].Type
String
PossibleValueSetType of the diagnosis
-
Additional values may be added by Redox in the future.
-
Visit.Diagnoses[].DocumentedDateTime
String
PossibleDateTime the diagnosis was documented.
ISO 8601 Format
Visit.Equipment[]
Array of Objects
ProbableSpecifies the equipment or resources assigned to this appointment. Each may be scheduled individually.
Visit.Equipment[].Code
String
ProbableCode for the equipment
Visit.Equipment[].Codeset
String
ProbableCode set used to identify the equipment.
Codeset will be blank for system-defined codes.
Visit.Equipment[].Description
String
ProbableDescription of the equipment.
Example: X-Ray, Therapy Ball, etc.
Visit.Equipment[].StartDateTime
DateTime
ProbableIf the equipment's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.
Not supported with data on demand.
Visit.Equipment[].Duration
Numeric
ProbableDefines the length of time (in minutes) that the equipment is scheduled for.
Not supported with data on demand.
{
"Meta": {
"DataModel": "Scheduling",
"EventType": "New",
"EventDateTime": "2023-08-29T18:36:49.023Z",
"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
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": []
},
"AppointmentInfo": [
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Priority",
"Value": "Normal"
},
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Form",
"Value": "Lumbar"
}
],
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"VisitDateTime": "2023-08-29T18:36:50.068Z",
"PatientClass": null,
"Status": null,
"Duration": 15,
"Reason": "Check up",
"Type": null,
"Instructions": [],
"AttendingProvider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ConsultingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"VisitProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136"
},
"AdditionalStaff": [],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Equipment": []
}
}
A Reschedule message is generated when the date or time of an appointment is changed. Generally, you can expect one of the following fields to be updated along with the appointment date and time: Visit.VisitNumber, Visit.VisitDateTime and Visit.OldDateTime entries.
Fields
Meta
Meta.DataModel
String
ReliableRequiredScheduling
Meta.EventType
String
ReliableRequiredReschedule
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.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableID for the patient
Patient.Identifiers[].IDType
String
ReliableType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
AppointmentInfo
AppointmentInfo[]
Array of Objects
ProbableContains a list of supplementary clinical information associated with the appointment.
AppointmentInfo[].Code
String
ProbableCode for the information element
AppointmentInfo[].Codeset
String
ProbableCode set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC or other codesets may be used where appropriate.
AppointmentInfo[].Description
String
ProbableDescription of the information element.
Additional information that may come from patient-completed forms or other sources
AppointmentInfo[].Value
String
ReliableDisplays the value of the corresponding appointment info code. For example, the code identifies the question being answered, and this property contains the answer.
Visit
Visit.VisitNumber
String
ReliableRequiredDisplays the unique identifier for the related patient visit.
Visit.OldVisitNumber
String
PossibleVisit Number of the appointment being rescheduled.
This is only needed by some systems, such as athenahealth. For systems that do not need this for rescheduling, it will be the likely same as the Visit.VisitNumber.
Visit.AccountNumber
String
PossibleContains an identifier that can span several visits often related to the same patient condition (e.g., surgeries, research study, pregnancy). In other words, the account number can be used to link related visits.
Not supported with data on demand.
Visit.VisitDateTime
String
ReliableRequiredNew DateTime of the appointment.
ISO 8601 Format
Visit.OldDateTime
String
PossibleOld DateTime of the appointment.
ISO 8601 Format
Visit.PatientClass
String
ProbableClassifies the department or type of patient care. Patient class is used in many EHR systems to determine where to put the patient (e.g., inpatient, outpatient, emergency).
Visit.Status
String
ProbableValueSetIndicates the status of the visit.
-
Additional values may be added by Redox in the future.
-
Visit.Duration
Numeric
ReliableRequiredDefines the length of the appointment in minutes.
Visit.Reason
String
ProbableContains is a patient-friendly value that provides context for the purpose of the appointment (e.g., knee pain). This differs from the Visit Type since it can include a clinical component.
Visit.Type
String
ProbableDisplays an administrative value used primarily for bidirectional exchange to update EHR system schedules.
Not supported with data on demand.
Visit.Instructions[]
Array of Strings
ProbableContains any relevant instructions for the patient visit.
Not supported with data on demand.
Visit.AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ConsultingProvider.ID
String
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDType
String
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstName
String
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastName
String
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.Address
Object
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ConsultingProvider.Address.City
String
PossibleCity
Visit.ConsultingProvider.Address.State
String
PossibleState
Visit.ConsultingProvider.Address.ZIP
String
PossibleZIP
Visit.ConsultingProvider.Address.County
String
PossibleCounty
Visit.ConsultingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ConsultingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ConsultingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.Location
Object
PossibleProvider's location
Visit.ConsultingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ConsultingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ConsultingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ConsultingProvider.Location.Department
String
PossibleDepartment
Visit.ConsultingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ConsultingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ConsultingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ConsultingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.VisitProvider.ID
String
PossibleID of the visit provider.
This ID is often required for Inpatient Visits.
Visit.VisitProvider.IDType
String
PossibleID type of the ID for the visit provider
Visit.VisitProvider.FirstName
String
PossibleFirst name of the visit provider
Visit.VisitProvider.LastName
String
PossibleLast name of the visit provider
Visit.VisitProvider.Credentials[]
Array of Strings
PossibleList of credentials for the visit provider.
e.g. MD, PhD
Visit.VisitProvider.Address
Object
PossibleProvider's address
Visit.VisitProvider.Address.StreetAddress
String
PossibleStreet address
Visit.VisitProvider.Address.City
String
PossibleCity
Visit.VisitProvider.Address.State
String
PossibleState
Visit.VisitProvider.Address.ZIP
String
PossibleZIP
Visit.VisitProvider.Address.County
String
PossibleCounty
Visit.VisitProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.VisitProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.VisitProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.VisitProvider.Location
Object
PossibleProvider's location
Visit.VisitProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.VisitProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.VisitProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.VisitProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.VisitProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.VisitProvider.Location.Department
String
PossibleDepartment
Visit.VisitProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.VisitProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.VisitProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.VisitProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location
Object
ReliableDisplays the location of the patient appointment.
Visit.Location.Type
String
ReliableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ReliableFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]
Array of Objects
ReliableList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].ID
String
ReliableAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Department
String
ReliableRequiredDepartment
Visit.Location.DepartmentIdentifiers[]
Array of Objects
ReliableList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].ID
String
ReliableAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Room
String
ReliableRoom.
Example: 136
Visit.AdditionalStaff[]
PossibleContains information about any other staff assigned to the assist with the patient visit. Each may be scheduled individually.
Visit.AdditionalStaff[].ID
String
ProbableID of the Additional staff member.
This ID is often required for Inpatient Visits.
Visit.AdditionalStaff[].IDType
String
ProbableID type of the ID for the Additional staff member
Visit.AdditionalStaff[].FirstName
String
PossibleFirst name of the Additional staff member
Visit.AdditionalStaff[].LastName
String
PossibleLast name of the Additional staff member
Visit.AdditionalStaff[].Credentials[]
Array of Strings
PossibleList of credentials for the Additional staff member.
e.g. MD, PhD
Visit.AdditionalStaff[].Address
Object
PossibleProvider's address
Visit.AdditionalStaff[].Address.StreetAddress
String
PossibleStreet address
Visit.AdditionalStaff[].Address.City
String
PossibleCity
Visit.AdditionalStaff[].Address.State
String
PossibleState
Visit.AdditionalStaff[].Address.ZIP
String
PossibleZIP
Visit.AdditionalStaff[].Address.County
String
PossibleCounty
Visit.AdditionalStaff[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AdditionalStaff[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AdditionalStaff[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AdditionalStaff[].Location
Object
PossibleProvider's location
Visit.AdditionalStaff[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AdditionalStaff[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AdditionalStaff[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Department
String
PossibleDepartment
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Room
String
PossibleRoom.
Example: 136
Visit.AdditionalStaff[].Role
Object
ProbableDefines the role of this person in the patient visit.
Visit.AdditionalStaff[].Role.Code
String
ProbableCode for the service
Visit.AdditionalStaff[].Role.Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Visit.AdditionalStaff[].Role.Description
String
ProbableDescription of the service.
Example: Primary Physician, Technologist, etc.
Visit.AdditionalStaff[].StartDateTime
DateTime
ProbableIf this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.
Visit.AdditionalStaff[].Duration
Numeric
ProbableSpecifies the length of time that the staff member is scheduled for.
In minutes
Visit.Diagnoses[]
Array of Objects
ProbableContains a list of diagnoses associated with the patient visit.
Visit.Diagnoses[].Code
String
ProbableCode for the diagnosis
Visit.Diagnoses[].Codeset
String
ProbableValueSetCode set used to identify the diagnosis
-
Additional values may be added by Redox in the future.
-
Visit.Diagnoses[].Name
String
ProbableName of the diagnosis
Visit.Diagnoses[].Type
String
PossibleValueSetType of the diagnosis
-
Additional values may be added by Redox in the future.
-
Visit.Diagnoses[].DocumentedDateTime
String
PossibleDateTime the diagnosis was documented.
ISO 8601 Format
Visit.Equipment[]
Array of Objects
ProbableSpecifies the equipment or resources assigned to this appointment. Each may be scheduled individually.
Visit.Equipment[].Code
String
ProbableCode for the equipment
Visit.Equipment[].Codeset
String
ProbableCode set used to identify the equipment.
Codeset will be blank for system-defined codes.
Visit.Equipment[].Description
String
ProbableDescription of the equipment.
Example: X-Ray, Therapy Ball, etc.
Visit.Equipment[].StartDateTime
DateTime
ProbableIf the equipment's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.
Not supported with data on demand.
Visit.Equipment[].Duration
Numeric
ProbableDefines the length of time (in minutes) that the equipment is scheduled for.
Not supported with data on demand.
{
"Meta": {
"DataModel": "Scheduling",
"EventType": "Reschedule",
"EventDateTime": "2023-08-29T18:36:49.023Z",
"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
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": []
},
"AppointmentInfo": [
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Priority",
"Value": "Normal"
},
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Form",
"Value": "Lumbar"
}
],
"Visit": {
"VisitNumber": "1234",
"OldVisitNumber": "1234",
"AccountNumber": null,
"VisitDateTime": "2023-09-05T18:36:50.076Z",
"OldDateTime": "2023-08-29T18:36:50.076Z",
"PatientClass": null,
"Status": null,
"Duration": 15,
"Reason": "Check up",
"Type": null,
"Instructions": [],
"AttendingProvider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ConsultingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"VisitProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136"
},
"AdditionalStaff": [],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Equipment": []
}
}
A Modification message is generated when something about the scheduled appointment is changed. This could be a change in provider, change in appointment duration, etc. Note that if the time of an appointment is changed you will receive a Reschedule message, rather than a Modification.
Fields
Meta
Meta.DataModel
String
ReliableRequiredScheduling
Meta.EventType
String
ReliableRequiredModification
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.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableID for the patient
Patient.Identifiers[].IDType
String
ReliableType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
AppointmentInfo
AppointmentInfo[]
Array of Objects
ProbableContains a list of supplementary clinical information associated with the appointment.
AppointmentInfo[].Code
String
ProbableCode for the information element
AppointmentInfo[].Codeset
String
ProbableCode set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC or other codesets may be used where appropriate.
AppointmentInfo[].Description
String
ProbableDescription of the information element.
Additional information that may come from patient-completed forms or other sources
AppointmentInfo[].Value
String
ReliableDisplays the value of the corresponding appointment info code. For example, the code identifies the question being answered, and this property contains the answer.
Visit
Visit.VisitNumber
String
ReliableRequiredDisplays the unique identifier for the related patient visit.
Visit.AccountNumber
String
PossibleContains an identifier that can span several visits often related to the same patient condition (e.g., surgeries, research study, pregnancy). In other words, the account number can be used to link related visits.
Not supported with data on demand.
Visit.VisitDateTime
String
ReliableRequiredContains the scheduled date and time of the appointment.
ISO 8601 Format
Visit.PatientClass
String
ProbableClassifies the department or type of patient care. Patient class is used in many EHR systems to determine where to put the patient (e.g., inpatient, outpatient, emergency).
Visit.Status
String
ProbableValueSetIndicates the status of the visit.
-
Additional values may be added by Redox in the future.
-
Visit.Duration
Numeric
ReliableRequiredDefines the length of the appointment in minutes.
Visit.Reason
String
ProbableContains is a patient-friendly value that provides context for the purpose of the appointment (e.g., knee pain). This differs from the Visit Type since it can include a clinical component.
Visit.Type
String
ProbableDisplays an administrative value used primarily for bidirectional exchange to update EHR system schedules.
Not supported with data on demand.
Visit.Instructions[]
Array of Strings
ProbableContains any relevant instructions for the patient visit.
Not supported with data on demand.
Visit.AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ConsultingProvider.ID
String
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDType
String
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstName
String
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastName
String
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.Address
Object
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ConsultingProvider.Address.City
String
PossibleCity
Visit.ConsultingProvider.Address.State
String
PossibleState
Visit.ConsultingProvider.Address.ZIP
String
PossibleZIP
Visit.ConsultingProvider.Address.County
String
PossibleCounty
Visit.ConsultingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ConsultingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ConsultingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.Location
Object
PossibleProvider's location
Visit.ConsultingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ConsultingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ConsultingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ConsultingProvider.Location.Department
String
PossibleDepartment
Visit.ConsultingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ConsultingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ConsultingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ConsultingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.VisitProvider.ID
String
PossibleID of the visit provider.
This ID is often required for Inpatient Visits.
Visit.VisitProvider.IDType
String
PossibleID type of the ID for the visit provider
Visit.VisitProvider.FirstName
String
PossibleFirst name of the visit provider
Visit.VisitProvider.LastName
String
PossibleLast name of the visit provider
Visit.VisitProvider.Credentials[]
Array of Strings
PossibleList of credentials for the visit provider.
e.g. MD, PhD
Visit.VisitProvider.Address
Object
PossibleProvider's address
Visit.VisitProvider.Address.StreetAddress
String
PossibleStreet address
Visit.VisitProvider.Address.City
String
PossibleCity
Visit.VisitProvider.Address.State
String
PossibleState
Visit.VisitProvider.Address.ZIP
String
PossibleZIP
Visit.VisitProvider.Address.County
String
PossibleCounty
Visit.VisitProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.VisitProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.VisitProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.VisitProvider.Location
Object
PossibleProvider's location
Visit.VisitProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.VisitProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.VisitProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.VisitProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.VisitProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.VisitProvider.Location.Department
String
PossibleDepartment
Visit.VisitProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.VisitProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.VisitProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.VisitProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location
Object
ReliableDisplays the location of the patient appointment.
Visit.Location.Type
String
ReliableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ReliableFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]
Array of Objects
ReliableList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].ID
String
ReliableAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Department
String
ReliableRequiredDepartment
Visit.Location.DepartmentIdentifiers[]
Array of Objects
ReliableList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].ID
String
ReliableAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Room
String
ReliableRoom.
Example: 136
Visit.AdditionalStaff[]
PossibleContains information about any other staff assigned to the assist with the patient visit. Each may be scheduled individually.
Visit.AdditionalStaff[].ID
String
ProbableID of the Additional staff member.
This ID is often required for Inpatient Visits.
Visit.AdditionalStaff[].IDType
String
ProbableID type of the ID for the Additional staff member
Visit.AdditionalStaff[].FirstName
String
PossibleFirst name of the Additional staff member
Visit.AdditionalStaff[].LastName
String
PossibleLast name of the Additional staff member
Visit.AdditionalStaff[].Credentials[]
Array of Strings
PossibleList of credentials for the Additional staff member.
e.g. MD, PhD
Visit.AdditionalStaff[].Address
Object
PossibleProvider's address
Visit.AdditionalStaff[].Address.StreetAddress
String
PossibleStreet address
Visit.AdditionalStaff[].Address.City
String
PossibleCity
Visit.AdditionalStaff[].Address.State
String
PossibleState
Visit.AdditionalStaff[].Address.ZIP
String
PossibleZIP
Visit.AdditionalStaff[].Address.County
String
PossibleCounty
Visit.AdditionalStaff[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AdditionalStaff[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AdditionalStaff[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AdditionalStaff[].Location
Object
PossibleProvider's location
Visit.AdditionalStaff[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AdditionalStaff[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AdditionalStaff[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Department
String
PossibleDepartment
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Room
String
PossibleRoom.
Example: 136
Visit.AdditionalStaff[].Role
Object
ProbableDefines the role of this person in the patient visit.
Visit.AdditionalStaff[].Role.Code
String
ProbableCode for the service
Visit.AdditionalStaff[].Role.Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Visit.AdditionalStaff[].Role.Description
String
ProbableDescription of the service.
Example: Primary Physician, Technologist, etc.
Visit.AdditionalStaff[].StartDateTime
DateTime
ProbableIf this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.
Visit.AdditionalStaff[].Duration
Numeric
ProbableSpecifies the length of time that the staff member is scheduled for.
In minutes
Visit.Diagnoses[]
Array of Objects
ProbableContains a list of diagnoses associated with the patient visit.
Visit.Diagnoses[].Code
String
ProbableCode for the diagnosis
Visit.Diagnoses[].Codeset
String
ProbableValueSetCode set used to identify the diagnosis
-
Additional values may be added by Redox in the future.
-
Visit.Diagnoses[].Name
String
ProbableName of the diagnosis
Visit.Diagnoses[].Type
String
PossibleValueSetType of the diagnosis
-
Additional values may be added by Redox in the future.
-
Visit.Diagnoses[].DocumentedDateTime
String
PossibleDateTime the diagnosis was documented.
ISO 8601 Format
Visit.Equipment[]
Array of Objects
ProbableSpecifies the equipment or resources assigned to this appointment. Each may be scheduled individually.
Visit.Equipment[].Code
String
ProbableCode for the equipment
Visit.Equipment[].Codeset
String
ProbableCode set used to identify the equipment.
Codeset will be blank for system-defined codes.
Visit.Equipment[].Description
String
ProbableDescription of the equipment.
Example: X-Ray, Therapy Ball, etc.
Visit.Equipment[].StartDateTime
DateTime
ProbableIf the equipment's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.
Not supported with data on demand.
Visit.Equipment[].Duration
Numeric
ProbableDefines the length of time (in minutes) that the equipment is scheduled for.
Not supported with data on demand.
{
"Meta": {
"DataModel": "Scheduling",
"EventType": "Modification",
"EventDateTime": "2023-08-29T18:36:49.023Z",
"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
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": []
},
"AppointmentInfo": [
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Priority",
"Value": "Normal"
},
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Form",
"Value": "Lumbar"
}
],
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"VisitDateTime": "2023-08-29T18:36:50.085Z",
"PatientClass": null,
"Status": null,
"Duration": 30,
"Reason": "Check up",
"Type": null,
"Instructions": [],
"AttendingProvider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ConsultingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"VisitProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136"
},
"AdditionalStaff": [],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Equipment": []
}
}
A Cancel message is generated when an appointment is canceled. Visit.VisitNumber identifies the appointment being canceled.
Fields
Meta
Meta.DataModel
String
ReliableRequiredScheduling
Meta.EventType
String
ReliableRequiredCancel
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.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableID for the patient
Patient.Identifiers[].IDType
String
ReliableType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
AppointmentInfo
AppointmentInfo[]
Array of Objects
ProbableContains a list of supplementary clinical information associated with the appointment.
AppointmentInfo[].Code
String
ProbableCode for the information element
AppointmentInfo[].Codeset
String
ProbableCode set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC or other codesets may be used where appropriate.
AppointmentInfo[].Description
String
ProbableDescription of the information element.
Additional information that may come from patient-completed forms or other sources
AppointmentInfo[].Value
String
ReliableDisplays the value of the corresponding appointment info code. For example, the code identifies the question being answered, and this property contains the answer.
Visit
Visit.VisitNumber
String
ReliableRequiredDisplays the unique identifier for the related patient visit.
Visit.AccountNumber
String
PossibleContains an identifier that can span several visits often related to the same patient condition (e.g., surgeries, research study, pregnancy). In other words, the account number can be used to link related visits.
Not supported with data on demand.
Visit.VisitDateTime
String
ReliableRequiredContains the scheduled date and time of the appointment.
ISO 8601 Format
Visit.PatientClass
String
ProbableClassifies the department or type of patient care. Patient class is used in many EHR systems to determine where to put the patient (e.g., inpatient, outpatient, emergency).
Visit.Status
String
ProbableValueSetIndicates the status of the visit.
-
Additional values may be added by Redox in the future.
-
Visit.Duration
Numeric
ReliableDefines the length of the appointment in minutes.
Visit.Reason
String
ProbableContains is a patient-friendly value that provides context for the purpose of the appointment (e.g., knee pain). This differs from the Visit Type since it can include a clinical component.
Visit.CancelReason
String
PossibleReason the visit was canceled
Visit.Type
String
ProbableDisplays an administrative value used primarily for bidirectional exchange to update EHR system schedules.
Not supported with data on demand.
Visit.Instructions[]
Array of Strings
ProbableContains any relevant instructions for the patient visit.
Not supported with data on demand.
Visit.AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ConsultingProvider.ID
String
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDType
String
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstName
String
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastName
String
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.Address
Object
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ConsultingProvider.Address.City
String
PossibleCity
Visit.ConsultingProvider.Address.State
String
PossibleState
Visit.ConsultingProvider.Address.ZIP
String
PossibleZIP
Visit.ConsultingProvider.Address.County
String
PossibleCounty
Visit.ConsultingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ConsultingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ConsultingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.Location
Object
PossibleProvider's location
Visit.ConsultingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ConsultingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ConsultingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ConsultingProvider.Location.Department
String
PossibleDepartment
Visit.ConsultingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ConsultingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ConsultingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ConsultingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.VisitProvider.ID
String
PossibleID of the visit provider.
This ID is often required for Inpatient Visits.
Visit.VisitProvider.IDType
String
PossibleID type of the ID for the visit provider
Visit.VisitProvider.FirstName
String
PossibleFirst name of the visit provider
Visit.VisitProvider.LastName
String
PossibleLast name of the visit provider
Visit.VisitProvider.Credentials[]
Array of Strings
PossibleList of credentials for the visit provider.
e.g. MD, PhD
Visit.VisitProvider.Address
Object
PossibleProvider's address
Visit.VisitProvider.Address.StreetAddress
String
PossibleStreet address
Visit.VisitProvider.Address.City
String
PossibleCity
Visit.VisitProvider.Address.State
String
PossibleState
Visit.VisitProvider.Address.ZIP
String
PossibleZIP
Visit.VisitProvider.Address.County
String
PossibleCounty
Visit.VisitProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.VisitProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.VisitProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.VisitProvider.Location
Object
PossibleProvider's location
Visit.VisitProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.VisitProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.VisitProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.VisitProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.VisitProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.VisitProvider.Location.Department
String
PossibleDepartment
Visit.VisitProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.VisitProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.VisitProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.VisitProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location
Object
ReliableDisplays the location of the patient appointment.
Visit.Location.Type
String
ReliableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ReliableFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]
Array of Objects
ReliableList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].ID
String
ReliableAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Department
String
ReliableRequiredDepartment
Visit.Location.DepartmentIdentifiers[]
Array of Objects
ReliableList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].ID
String
ReliableAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Room
String
ReliableRoom.
Example: 136
Visit.AdditionalStaff[]
PossibleContains information about any other staff assigned to the assist with the patient visit. Each may be scheduled individually.
Visit.AdditionalStaff[].ID
String
ProbableID of the Additional staff member.
This ID is often required for Inpatient Visits.
Visit.AdditionalStaff[].IDType
String
ProbableID type of the ID for the Additional staff member
Visit.AdditionalStaff[].FirstName
String
PossibleFirst name of the Additional staff member
Visit.AdditionalStaff[].LastName
String
PossibleLast name of the Additional staff member
Visit.AdditionalStaff[].Credentials[]
Array of Strings
PossibleList of credentials for the Additional staff member.
e.g. MD, PhD
Visit.AdditionalStaff[].Address
Object
PossibleProvider's address
Visit.AdditionalStaff[].Address.StreetAddress
String
PossibleStreet address
Visit.AdditionalStaff[].Address.City
String
PossibleCity
Visit.AdditionalStaff[].Address.State
String
PossibleState
Visit.AdditionalStaff[].Address.ZIP
String
PossibleZIP
Visit.AdditionalStaff[].Address.County
String
PossibleCounty
Visit.AdditionalStaff[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AdditionalStaff[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AdditionalStaff[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AdditionalStaff[].Location
Object
PossibleProvider's location
Visit.AdditionalStaff[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AdditionalStaff[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AdditionalStaff[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Department
String
PossibleDepartment
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Room
String
PossibleRoom.
Example: 136
Visit.AdditionalStaff[].Role
Object
ProbableDefines the role of this person in the patient visit.
Visit.AdditionalStaff[].Role.Code
String
ProbableCode for the service
Visit.AdditionalStaff[].Role.Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Visit.AdditionalStaff[].Role.Description
String
ProbableDescription of the service.
Example: Primary Physician, Technologist, etc.
Visit.AdditionalStaff[].StartDateTime
DateTime
ProbableIf this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.
Visit.AdditionalStaff[].Duration
Numeric
ProbableSpecifies the length of time that the staff member is scheduled for.
In minutes
Visit.Diagnoses[]
Array of Objects
ProbableContains a list of diagnoses associated with the patient visit.
Visit.Diagnoses[].Code
String
ProbableCode for the diagnosis
Visit.Diagnoses[].Codeset
String
ProbableValueSetCode set used to identify the diagnosis
-
Additional values may be added by Redox in the future.
-
Visit.Diagnoses[].Name
String
ProbableName of the diagnosis
Visit.Diagnoses[].Type
String
PossibleValueSetType of the diagnosis
-
Additional values may be added by Redox in the future.
-
Visit.Diagnoses[].DocumentedDateTime
String
PossibleDateTime the diagnosis was documented.
ISO 8601 Format
Visit.Equipment[]
Array of Objects
ProbableSpecifies the equipment or resources assigned to this appointment. Each may be scheduled individually.
Visit.Equipment[].Code
String
ProbableCode for the equipment
Visit.Equipment[].Codeset
String
ProbableCode set used to identify the equipment.
Codeset will be blank for system-defined codes.
Visit.Equipment[].Description
String
ProbableDescription of the equipment.
Example: X-Ray, Therapy Ball, etc.
Visit.Equipment[].StartDateTime
DateTime
ProbableIf the equipment's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.
Not supported with data on demand.
Visit.Equipment[].Duration
Numeric
ProbableDefines the length of time (in minutes) that the equipment is scheduled for.
Not supported with data on demand.
{
"Meta": {
"DataModel": "Scheduling",
"EventType": "Cancel",
"EventDateTime": "2023-08-29T18:36:49.023Z",
"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
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": []
},
"AppointmentInfo": [
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Priority",
"Value": "Normal"
},
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Form",
"Value": "Lumbar"
}
],
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"VisitDateTime": "2023-08-29T18:36:50.093Z",
"PatientClass": null,
"Status": null,
"Duration": 15,
"Reason": "Check up",
"CancelReason": "Conflicting appointment",
"Type": null,
"Instructions": [],
"AttendingProvider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ConsultingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"VisitProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136"
},
"AdditionalStaff": [],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Equipment": []
}
}
A NoShow message is generated when a patient does not show up for the scheduled appointment.
Fields
Meta
Meta.DataModel
String
ReliableRequiredScheduling
Meta.EventType
String
ReliableRequiredNoShow
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.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableID for the patient
Patient.Identifiers[].IDType
String
ReliableType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
AppointmentInfo
AppointmentInfo[]
Array of Objects
ProbableContains a list of supplementary clinical information associated with the appointment.
AppointmentInfo[].Code
String
ProbableCode for the information element
AppointmentInfo[].Codeset
String
ProbableCode set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC or other codesets may be used where appropriate.
AppointmentInfo[].Description
String
ProbableDescription of the information element.
Additional information that may come from patient-completed forms or other sources
AppointmentInfo[].Value
String
ReliableDisplays the value of the corresponding appointment info code. For example, the code identifies the question being answered, and this property contains the answer.
Visit
Visit.VisitNumber
String
ReliableRequiredDisplays the unique identifier for the related patient visit.
Visit.AccountNumber
String
PossibleContains an identifier that can span several visits often related to the same patient condition (e.g., surgeries, research study, pregnancy). In other words, the account number can be used to link related visits.
Not supported with data on demand.
Visit.VisitDateTime
String
ReliableRequiredContains the scheduled date and time of the appointment.
ISO 8601 Format
Visit.PatientClass
String
ProbableClassifies the department or type of patient care. Patient class is used in many EHR systems to determine where to put the patient (e.g., inpatient, outpatient, emergency).
Visit.Status
String
ProbableValueSetIndicates the status of the visit.
-
Additional values may be added by Redox in the future.
-
Visit.Duration
Numeric
ReliableDefines the length of the appointment in minutes.
Visit.Reason
String
ProbableContains is a patient-friendly value that provides context for the purpose of the appointment (e.g., knee pain). This differs from the Visit Type since it can include a clinical component.
Visit.NoShowReason
String
PossibleReason the patient did not show for the appointment
Visit.Type
String
ProbableDisplays an administrative value used primarily for bidirectional exchange to update EHR system schedules.
Not supported with data on demand.
Visit.Instructions[]
Array of Strings
ProbableContains any relevant instructions for the patient visit.
Not supported with data on demand.
Visit.AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ConsultingProvider.ID
String
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visit.ConsultingProvider.IDType
String
PossibleID type of the ID for the consulting provider
Visit.ConsultingProvider.FirstName
String
PossibleFirst name of the consulting provider
Visit.ConsultingProvider.LastName
String
PossibleLast name of the consulting provider
Visit.ConsultingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visit.ConsultingProvider.Address
Object
PossibleProvider's address
Visit.ConsultingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ConsultingProvider.Address.City
String
PossibleCity
Visit.ConsultingProvider.Address.State
String
PossibleState
Visit.ConsultingProvider.Address.ZIP
String
PossibleZIP
Visit.ConsultingProvider.Address.County
String
PossibleCounty
Visit.ConsultingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ConsultingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ConsultingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ConsultingProvider.Location
Object
PossibleProvider's location
Visit.ConsultingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ConsultingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ConsultingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ConsultingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ConsultingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ConsultingProvider.Location.Department
String
PossibleDepartment
Visit.ConsultingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ConsultingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ConsultingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ConsultingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.VisitProvider.ID
String
PossibleID of the visit provider.
This ID is often required for Inpatient Visits.
Visit.VisitProvider.IDType
String
PossibleID type of the ID for the visit provider
Visit.VisitProvider.FirstName
String
PossibleFirst name of the visit provider
Visit.VisitProvider.LastName
String
PossibleLast name of the visit provider
Visit.VisitProvider.Credentials[]
Array of Strings
PossibleList of credentials for the visit provider.
e.g. MD, PhD
Visit.VisitProvider.Address
Object
PossibleProvider's address
Visit.VisitProvider.Address.StreetAddress
String
PossibleStreet address
Visit.VisitProvider.Address.City
String
PossibleCity
Visit.VisitProvider.Address.State
String
PossibleState
Visit.VisitProvider.Address.ZIP
String
PossibleZIP
Visit.VisitProvider.Address.County
String
PossibleCounty
Visit.VisitProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.VisitProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.VisitProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.VisitProvider.Location
Object
PossibleProvider's location
Visit.VisitProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.VisitProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.VisitProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.VisitProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.VisitProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.VisitProvider.Location.Department
String
PossibleDepartment
Visit.VisitProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.VisitProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.VisitProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.VisitProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location
Object
ReliableDisplays the location of the patient appointment.
Visit.Location.Type
String
ReliableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ReliableFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]
Array of Objects
ReliableList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].ID
String
ReliableAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Department
String
ReliableRequiredDepartment
Visit.Location.DepartmentIdentifiers[]
Array of Objects
ReliableList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].ID
String
ReliableAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Room
String
ReliableRoom.
Example: 136
Visit.AdditionalStaff[]
PossibleContains information about any other staff assigned to the assist with the patient visit. Each may be scheduled individually.
Visit.AdditionalStaff[].ID
String
ProbableID of the Additional staff member.
This ID is often required for Inpatient Visits.
Visit.AdditionalStaff[].IDType
String
ProbableID type of the ID for the Additional staff member
Visit.AdditionalStaff[].FirstName
String
PossibleFirst name of the Additional staff member
Visit.AdditionalStaff[].LastName
String
PossibleLast name of the Additional staff member
Visit.AdditionalStaff[].Credentials[]
Array of Strings
PossibleList of credentials for the Additional staff member.
e.g. MD, PhD
Visit.AdditionalStaff[].Address
Object
PossibleProvider's address
Visit.AdditionalStaff[].Address.StreetAddress
String
PossibleStreet address
Visit.AdditionalStaff[].Address.City
String
PossibleCity
Visit.AdditionalStaff[].Address.State
String
PossibleState
Visit.AdditionalStaff[].Address.ZIP
String
PossibleZIP
Visit.AdditionalStaff[].Address.County
String
PossibleCounty
Visit.AdditionalStaff[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AdditionalStaff[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AdditionalStaff[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AdditionalStaff[].Location
Object
PossibleProvider's location
Visit.AdditionalStaff[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AdditionalStaff[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AdditionalStaff[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Department
String
PossibleDepartment
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Room
String
PossibleRoom.
Example: 136
Visit.AdditionalStaff[].Role
Object
ProbableDefines the role of this person in the patient visit.
Visit.AdditionalStaff[].Role.Code
String
ProbableCode for the service
Visit.AdditionalStaff[].Role.Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Visit.AdditionalStaff[].Role.Description
String
ProbableDescription of the service.
Example: Primary Physician, Technologist, etc.
Visit.AdditionalStaff[].StartDateTime
DateTime
ProbableIf this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.
Visit.AdditionalStaff[].Duration
Numeric
ProbableSpecifies the length of time that the staff member is scheduled for.
In minutes
Visit.Diagnoses[]
Array of Objects
ProbableContains a list of diagnoses associated with the patient visit.
Visit.Diagnoses[].Code
String
ProbableCode for the diagnosis
Visit.Diagnoses[].Codeset
String
ProbableValueSetCode set used to identify the diagnosis
-
Additional values may be added by Redox in the future.
-
Visit.Diagnoses[].Name
String
ProbableName of the diagnosis
Visit.Diagnoses[].Type
String
PossibleValueSetType of the diagnosis
-
Additional values may be added by Redox in the future.
-
Visit.Diagnoses[].DocumentedDateTime
String
PossibleDateTime the diagnosis was documented.
ISO 8601 Format
Visit.Equipment[]
Array of Objects
ProbableSpecifies the equipment or resources assigned to this appointment. Each may be scheduled individually.
Visit.Equipment[].Code
String
ProbableCode for the equipment
Visit.Equipment[].Codeset
String
ProbableCode set used to identify the equipment.
Codeset will be blank for system-defined codes.
Visit.Equipment[].Description
String
ProbableDescription of the equipment.
Example: X-Ray, Therapy Ball, etc.
Visit.Equipment[].StartDateTime
DateTime
ProbableIf the equipment's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.
Not supported with data on demand.
Visit.Equipment[].Duration
Numeric
ProbableDefines the length of time (in minutes) that the equipment is scheduled for.
Not supported with data on demand.
{
"Meta": {
"DataModel": "Scheduling",
"EventType": "NoShow",
"EventDateTime": "2023-08-29T18:36:49.023Z",
"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
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": []
},
"AppointmentInfo": [
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Priority",
"Value": "Normal"
},
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Form",
"Value": "Lumbar"
}
],
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"VisitDateTime": "2023-08-29T18:36:50.102Z",
"PatientClass": null,
"Status": null,
"Duration": 15,
"Reason": "Check up",
"NoShowReason": "Car broke down.",
"Type": null,
"Instructions": [],
"AttendingProvider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ConsultingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"VisitProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136"
},
"AdditionalStaff": [],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Equipment": []
}
}
PushSlotslink
BETAA PushSlots message contains a list of Slots from another system, to be used for scheduling appointments.
The Slots[].Reason field can be used to determine whether individual slots are available for scheduling.
Fields
Meta
Meta.DataModel
String
ReliableRequiredScheduling
Meta.EventType
String
ReliableRequiredPushSlots
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.
Meta.BatchID
String
PossibleIdentifier corresponding to a particular batch of messages.
Meta.CurrentBatch
Integer
PossibleAn integer representing the current batch.
Meta.TotalBatches
Integer
PossibleAn integer representing the total number of batches being sent.
Slots
Slots[]
Object
ProbableIndividual slot object
Slots[].ID
String
ProbableThe ID of the slot
Slots[].DateTime
String
ReliableRequiredThe DateTime of the appointment slot.
ISO 8601 Format
Slots[].Reason
String
ReliableThe visit reason of the appointment slot
Slots[].Duration
Numeric
ReliableRequiredLength of appointment.
In minutes
Slots[].Provider.ID
String
ReliableID of the provider.
This ID is often required for Inpatient Visits.
Slots[].Provider.IDType
String
ReliableID type of the ID for the provider
Slots[].Provider.FirstName
String
PossibleFirst name of the provider
Slots[].Provider.LastName
String
PossibleLast name of the provider
Slots[].Provider.Credentials[]
Array of Strings
PossibleList of credentials for the provider.
e.g. MD, PhD
Slots[].Provider.Address
Object
PossibleProvider's address
Slots[].Provider.Address.StreetAddress
String
PossibleStreet address
Slots[].Provider.Address.City
String
PossibleCity
Slots[].Provider.Address.State
String
PossibleState
Slots[].Provider.Address.ZIP
String
PossibleZIP
Slots[].Provider.Address.County
String
PossibleCounty
Slots[].Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Slots[].Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Slots[].Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Slots[].Location
Object
ReliableLocation of the appointment
Slots[].Location.Type
String
ReliableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Slots[].Location.Facility
String
ReliableFacility.
Example: Community Hospital
Slots[].Location.FacilityIdentifiers[]
Array of Objects
ReliableList of IDs specific to this facility
Slots[].Location.FacilityIdentifiers[].ID
String
ReliableAn ID specific to this facility
Slots[].Location.FacilityIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Slots[].Location.Department
String
ReliableDepartment
Slots[].Location.DepartmentIdentifiers[]
Array of Objects
ReliableList of IDs specific to this department
Slots[].Location.DepartmentIdentifiers[].ID
String
ReliableAn ID specific to this department
Slots[].Location.DepartmentIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Slots[].Location.Room
String
ReliableRoom.
Example: 136
{
"Meta": {
"DataModel": "Scheduling",
"EventType": "PushSlots",
"EventDateTime": "2023-08-29T18:36:49.023Z",
"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,
"BatchID": null,
"CurrentBatch": null,
"TotalBatches": null
},
"Slots": [
{
"ID": "1",
"DateTime": "2016-08-01 14:00:00Z",
"Reason": "Office Visit",
"Duration": 15,
"Provider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136"
}
},
{
"ID": "2",
"DateTime": "2016-08-01 14:15:00Z",
"Reason": "Office Visit",
"Duration": 15,
"Provider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136"
}
},
{
"ID": "3",
"DateTime": "2016-08-01 14:30:00Z",
"Reason": "Office Visit",
"Duration": 15,
"Provider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136"
}
},
{
"ID": "4",
"DateTime": "2016-08-01 14:45:00Z",
"Reason": "Office Visit",
"Duration": 15,
"Provider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136"
}
}
]
}
This query finds and returns times available for booking an appointment within a given time range. The response for this query is the AvailableSlotsResponse 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
ReliableRequiredScheduling
Meta.EventType
String
ReliableRequiredAvailableSlots
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.
Patient
Patient.Identifiers[]
Array of Objects
PossibleContains a list of identifiers and identifier types that correlate to the patient.
Patient.Identifiers[].ID
String
PossibleContains an identifier for the patient.
Patient.Identifiers[].IDType
String
PossibleDefines the type of identifier used to identify the patient (e.g., MRN, EPI).
Patient.Demographics.FirstName
String
PossibleDisplays the patient's first name.
Patient.Demographics.MiddleName
String
PossibleDisplays the patient's middle name or initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
PossibleDisplays the patient's last name.
Patient.Demographics.DOB
String
PossibleSpecifies the patient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
PossibleContains the patient's social security number.
Patient.Demographics.Sex
String
PossibleValueSetSpecifies the patient's sex.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetSpecifies the patient's race.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates whether the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetIndicates the patient's religious affiliation.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetSpecifies the patient's marital status.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased.
Patient.Demographics.DeathDateTime
DateTime
PossibleSpecifies the date and time that the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
PossibleDisplays the patient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
PossibleDisplays the patient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
PossibleDisplays the patient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
PossibleDisplays the patient's email address(es).
Patient.Demographics.Language
String
PossibleValueSetIndicates the patient's primary spoken language.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetSpecifies the patient's nation(s) of citizenship.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossibleContains any patient-level notes.
Not supported with data on demand.
Patient.Diagnoses[]
Array of Objects
ProbableContains a list of diagnoses associated with the visit.
Patient.Diagnoses[].Code
String
ProbableCode for the diagnosis
Patient.Diagnoses[].Codeset
String
ProbableValueSetCode set used to identify the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].Name
String
ProbableName of the diagnosis
Patient.Diagnoses[].Type
String
PossibleValueSetType of the diagnosis
-
Additional values may be added by Redox in the future.
-
Patient.Diagnoses[].DocumentedDateTime
String
PossibleDateTime the diagnosis was documented.
ISO 8601 Format
StartDateTime
StartDateTime
String
ReliableRequiredDefines the start of the time range to search for appointments.
ISO 8601 Format
EndDateTime
EndDateTime
String
PossibleDefines the end of the time range to search for appointments.
ISO 8601 Format
Visit
Visit.Reasons[]
Array of Strings
ReliableContains is a patient-friendly value that provides context for the purpose of the appointment (e.g., knee pain). This differs from the Visit Type since it can include a clinical component.
Visit.AttendingProviders[].ID
String
ProbableID of the provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProviders[].IDType
String
ProbableID type of the ID for the provider
Visit.AttendingProviders[].FirstName
String
PossibleFirst name of the provider
Visit.AttendingProviders[].LastName
String
PossibleLast name of the provider
Visit.AttendingProviders[].Credentials[]
Array of Strings
PossibleList of credentials for the provider.
e.g. MD, PhD
Visit.AttendingProviders[].Address
Object
PossibleProvider's address
Visit.AttendingProviders[].Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProviders[].Address.City
String
PossibleCity
Visit.AttendingProviders[].Address.State
String
PossibleState
Visit.AttendingProviders[].Address.ZIP
String
PossibleZIP
Visit.AttendingProviders[].Address.County
String
PossibleCounty
Visit.AttendingProviders[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProviders[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProviders[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProviders[].Location
Object
PossibleProvider's location
Visit.AttendingProviders[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProviders[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProviders[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProviders[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AttendingProviders[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProviders[].Location.Department
String
PossibleDepartment
Visit.AttendingProviders[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProviders[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AttendingProviders[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProviders[].Location.Room
String
PossibleRoom.
Example: 136
Visit.Locations[]
Array
ProbableSpecifies the location of the appointment.
Visit.Locations[].Type
String
ProbableSpecifies the type of location (e.g., clinic, department, home, nursing unit, provider office, phone).
Not supported with data on demand.
Visit.Locations[].Facility
String
ProbableSpecifies the kind of facility (e.g., community hospital).
Not supported with data on demand.
Visit.Locations[].Department
String
ProbableSpecifies the department where the patient appointment takes place.
Visit.Locations[].SpecialtyDepartment
Object
PossibleIndicates the departments specialty.
Visit.Locations[].SpecialtyDepartment.Code
String
PossibleCode for the specialty of the department
Visit.Locations[].SpecialtyDepartment.Codeset
String
PossibleCode set used to identify the specialty of the department
Visit.Locations[].SpecialtyDepartment.Description
String
PossibleDescription of the specialty of the department
Visit.Locations[].Room
String
ProbableDisplays the room number for the visit (e.g., 136).
Not supported with data on demand.
Visit.Locations[].ID
String
PossibleContains the unique identifier of the visit location.
Visit.VisitType[]
Array of Objects
PossibleDefines the type of patient visit.
Visit.VisitType[].Code
String
PossibleCode for the visit type
Visit.VisitType[].Codeset
String
PossibleCode set used to identify the visit type
Visit.VisitType[].Description
String
PossibleDescription of the visit type
Visit.VisitPreference[]
Array of Objects
PossibleContains the details for the appointment scheduling preferences.
Visit.VisitPreference[].Duration
String
PossibleDefines the preferred length of time for the patient visit.
Visit.VisitPreference[].DurationUnit
String
PossibleSpecifies the unit of measurement for the duration field.
Visit.VisitPreference[].Day[]
Array of Strings
PossibleSpecifies the preferred day of week for scheduling the appointment.
Visit.VisitPreference[].Time[]
Array of Strings
PossibleSpecifies the preferred time of day for the appointment.
{
"Meta": {
"DataModel": "Scheduling",
"EventType": "AvailableSlots",
"EventDateTime": "2023-08-29T18:36:49.023Z",
"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
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": [],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
]
},
"StartDateTime": "2023-08-29T18:36:50.118Z",
"EndDateTime": null,
"Visit": {
"Reasons": [
"Check up"
],
"AttendingProviders": [],
"Locations": [
{
"Type": "Inpatient",
"Facility": "RES General Hospital",
"Department": "3N",
"SpecialtyDepartment": {
"Code": null,
"Codeset": null,
"Description": null
},
"Room": "136",
"ID": null
}
],
"VisitType": [
{
"Code": "210",
"Codeset": "DNER15",
"Description": "Office Visit"
}
],
"VisitPreference": [
{
"Duration": "30",
"DurationUnit": "minutes",
"Day": [
"Tues",
"Fri"
],
"Time": [
"1000"
]
}
]
}
}
This is the format of the response you will receive for a AvailableSlots query.
Fields
Meta
Meta.DataModel
String
ReliableRequiredScheduling
Meta.EventType
String
ReliableRequiredAvailableSlotsResponse
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.
Meta.IsIncomplete
Boolean
ReliableIndicates that a limit was reached, and not all data was returned. If true, the sender may want to restrict the parameters of the request in order to match fewer results.
AvailableSlots
AvailableSlots[]
Object
ProbableIndividual slots that are available for booking
AvailableSlots[].ID
String
ProbableThe ID of the slot
AvailableSlots[].DateTime
String
ReliableRequiredThe DateTime of the appointment slot.
ISO 8601 Format
AvailableSlots[].Reason
String
ReliableThe visit reason of the appointment slot
AvailableSlots[].Duration
Numeric
ReliableRequiredLength of appointment.
In minutes
AvailableSlots[].Provider.ID
String
ReliableID of the provider.
This ID is often required for Inpatient Visits.
AvailableSlots[].Provider.IDType
String
ReliableID type of the ID for the provider
AvailableSlots[].Provider.FirstName
String
PossibleFirst name of the provider
AvailableSlots[].Provider.LastName
String
PossibleLast name of the provider
AvailableSlots[].Provider.Credentials[]
Array of Strings
PossibleList of credentials for the provider.
e.g. MD, PhD
AvailableSlots[].Provider.Address
Object
PossibleProvider's address
AvailableSlots[].Provider.Address.StreetAddress
String
PossibleStreet address
AvailableSlots[].Provider.Address.City
String
PossibleCity
AvailableSlots[].Provider.Address.State
String
PossibleState
AvailableSlots[].Provider.Address.ZIP
String
PossibleZIP
AvailableSlots[].Provider.Address.County
String
PossibleCounty
AvailableSlots[].Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
AvailableSlots[].Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
AvailableSlots[].Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
AvailableSlots[].Provider.Location
Object
PossibleProvider's location
AvailableSlots[].Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
AvailableSlots[].Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
AvailableSlots[].Provider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
AvailableSlots[].Provider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
AvailableSlots[].Provider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
AvailableSlots[].Provider.Location.Department
String
PossibleDepartment
AvailableSlots[].Provider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
AvailableSlots[].Provider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
AvailableSlots[].Provider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
AvailableSlots[].Provider.Location.Room
String
PossibleRoom.
Example: 136
AvailableSlots[].Location
Object
ReliableLocation of the appointment
AvailableSlots[].Location.Type
String
ReliableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
AvailableSlots[].Location.Facility
String
ReliableFacility.
Example: Community Hospital
AvailableSlots[].Location.FacilityIdentifiers[]
Array of Objects
ReliableList of IDs specific to this facility
AvailableSlots[].Location.FacilityIdentifiers[].ID
String
ReliableAn ID specific to this facility
AvailableSlots[].Location.FacilityIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
AvailableSlots[].Location.Department
String
ReliableDepartment
AvailableSlots[].Location.DepartmentIdentifiers[]
Array of Objects
ReliableList of IDs specific to this department
AvailableSlots[].Location.DepartmentIdentifiers[].ID
String
ReliableAn ID specific to this department
AvailableSlots[].Location.DepartmentIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
AvailableSlots[].Location.Room
String
ReliableRoom.
Example: 136
AvailableSlots[].Notes[]
Array of strings
PossibleAdditional notes about this slot
{
"Meta": {
"DataModel": "Scheduling",
"EventType": "AvailableSlotsResponse",
"EventDateTime": "2023-08-29T18:36:49.023Z",
"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,
"IsIncomplete": false
},
"AvailableSlots": [
{
"ID": null,
"DateTime": "2016-08-01T10:00:00Z",
"Reason": "Follow Up",
"Duration": 15,
"Provider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": "Clinic A",
"DepartmentIdentifiers": [],
"Room": null
},
"Notes": []
},
{
"ID": null,
"DateTime": "2016-08-01T11:00:00Z",
"Reason": "Follow Up",
"Duration": 15,
"Provider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": "Clinic A",
"DepartmentIdentifiers": [],
"Room": null
},
"Notes": []
},
{
"ID": null,
"DateTime": "2016-08-01T12:00:00Z",
"Reason": "Follow Up",
"Duration": 15,
"Provider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": "Clinic A",
"DepartmentIdentifiers": [],
"Room": null
},
"Notes": []
},
{
"ID": null,
"DateTime": "2016-08-01T13:00:00Z",
"Reason": "Follow Up",
"Duration": 15,
"Provider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": "Clinic A",
"DepartmentIdentifiers": [],
"Room": null
},
"Notes": []
}
]
}
This query finds and returns booked appointments within a given time range. The response when querying Data On Demand is the BookedResponse 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
ReliableRequiredScheduling
Meta.EventType
String
ReliableRequiredBooked
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.
StartDateTime
StartDateTime
String
ReliableRequiredDefines the start of the time range to search for appointments.
ISO 8601 Format
EndDateTime
EndDateTime
String
PossibleDefines the end of the time range to search for appointments.
ISO 8601 Format
Visit
Visit.Reason
Array of Strings
ReliableIndicates the appointment reason to search for.
Visit.VisitNumber
String
PossibleDisplays the unique identifier for the patient visit. You must query for a specific booked appointment by a known VisitNumber.
Visit.AttendingProviders[].ID
String
ProbableID of the provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProviders[].IDType
String
ProbableID type of the ID for the provider
Visit.AttendingProviders[].FirstName
String
PossibleFirst name of the provider
Visit.AttendingProviders[].LastName
String
PossibleLast name of the provider
Visit.AttendingProviders[].Credentials[]
Array of Strings
PossibleList of credentials for the provider.
e.g. MD, PhD
Visit.AttendingProviders[].Address
Object
PossibleProvider's address
Visit.AttendingProviders[].Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProviders[].Address.City
String
PossibleCity
Visit.AttendingProviders[].Address.State
String
PossibleState
Visit.AttendingProviders[].Address.ZIP
String
PossibleZIP
Visit.AttendingProviders[].Address.County
String
PossibleCounty
Visit.AttendingProviders[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProviders[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProviders[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProviders[].Location
Object
PossibleProvider's location
Visit.AttendingProviders[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProviders[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProviders[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProviders[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AttendingProviders[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProviders[].Location.Department
String
PossibleDepartment
Visit.AttendingProviders[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProviders[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AttendingProviders[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProviders[].Location.Room
String
PossibleRoom.
Example: 136
Visit.VisitProvider.ID
String
PossibleID of the visit provider.
This ID is often required for Inpatient Visits.
Visit.VisitProvider.IDType
String
PossibleID type of the ID for the visit provider
Visit.VisitProvider.FirstName
String
PossibleFirst name of the visit provider
Visit.VisitProvider.LastName
String
PossibleLast name of the visit provider
Visit.VisitProvider.Credentials[]
Array of Strings
PossibleList of credentials for the visit provider.
e.g. MD, PhD
Visit.VisitProvider.Address
Object
PossibleProvider's address
Visit.VisitProvider.Address.StreetAddress
String
PossibleStreet address
Visit.VisitProvider.Address.City
String
PossibleCity
Visit.VisitProvider.Address.State
String
PossibleState
Visit.VisitProvider.Address.ZIP
String
PossibleZIP
Visit.VisitProvider.Address.County
String
PossibleCounty
Visit.VisitProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.VisitProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.VisitProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.VisitProvider.Location
Object
PossibleProvider's location
Visit.VisitProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.VisitProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.VisitProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.VisitProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.VisitProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.VisitProvider.Location.Department
String
PossibleDepartment
Visit.VisitProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.VisitProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.VisitProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.VisitProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location
Object
ProbableDefines the location of the appointment.
Visit.Location.Type
String
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
ProbableFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]
Array of Objects
ProbableList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].ID
String
ProbableAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDType
String
ProbableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Department
String
ProbableDepartment
Visit.Location.DepartmentIdentifiers[]
Array of Objects
ProbableList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].ID
String
ProbableAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDType
String
ProbableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Room
String
ProbableRoom.
Example: 136
Visit.Patients[]
Array of Objects
ProbableIdentifies the patient(s) for the appointment.
Visit.Patients[].Identifiers[]
Array of Objects
ProbableContains a list of identifiers and identifiers types that correlate to the patient.
Visit.Patients[].Identifiers[].ID
String
ProbableContains an identifier for the patient.
Visit.Patients[].Identifiers[].IDType
String
ProbableDefines the type of the identifier used for the patient.
E.g. MRN, EPI
{
"Meta": {
"DataModel": "Scheduling",
"EventType": "Booked",
"EventDateTime": "2023-08-29T18:36:49.023Z",
"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
},
"StartDateTime": "2023-08-29T18:36:50.129Z",
"EndDateTime": null,
"Visit": {
"Reason": null,
"VisitNumber": null,
"AttendingProviders": [
{
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
}
],
"VisitProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
},
"Patients": [
{
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
]
}
]
}
}
This is the format of the response you will receive for a Booked query.
Fields
Meta
Meta.DataModel
String
ReliableRequiredScheduling
Meta.EventType
String
ReliableRequiredBookedResponse
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.
Meta.IsIncomplete
Boolean
ReliableIndicates that a limit was reached, and not all data was returned. If true, the sender may want to restrict the parameters of the request in order to match fewer results.
Visits
Visits[].VisitNumber
String
ReliableRequiredDisplays the unique identifier for the related patient visit.
Visits[].AccountNumber
String
PossibleContains an identifier that can span several visits often related to the same patient condition (e.g., surgeries, research study, pregnancy). In other words, the account number can be used to link related visits.
Not supported with data on demand.
Visits[].VisitDateTime
String
ReliableRequiredContains the scheduled date and time of the appointment.
ISO 8601 Format
Visits[].PatientClass
String
ProbableClassifies the department or type of patient care. Patient class is used in many EHR systems to determine where to put the patient (e.g., inpatient, outpatient, emergency).
Visits[].Status
String
ProbableValueSetIndicates the status of the visit.
-
Additional values may be added by Redox in the future.
-
Visits[].Duration
Numeric
ReliableRequiredDefines the length of the appointment in minutes.
Visits[].Reason
String
ProbableContains is a patient-friendly value that provides context for the purpose of the appointment (e.g., knee pain). This differs from the Visit Type since it can include a clinical component.
Visits[].CancelReason
String
PossibleReason the visit was canceled
Visits[].LastUpdated
DateTime
ProbableDateTime when the appointment was last modified.
ISO 8601 Format
Visits[].ScheduledDateTime
DateTime
PossibleDateTime when the visit was scheduled.
ISO 8601 Format
Visits[].CancelDateTime
DateTime
PossibleDateTime when the visit was canceled.
ISO 8601 Format
Visits[].Type
String
ProbableDisplays an administrative value used primarily for bidirectional exchange to update EHR system schedules.
Not supported with data on demand.
Visits[].Instructions[]
Array of Strings
ProbableContains any relevant instructions for the patient visit.
Not supported with data on demand.
Visits[].AttendingProvider.ID
String
ProbableID of the attending provider.
This ID is often required for Inpatient Visits.
Visits[].AttendingProvider.IDType
String
ProbableID type of the ID for the attending provider
Visits[].AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visits[].AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visits[].AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visits[].AttendingProvider.Address
Object
PossibleProvider's address
Visits[].AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visits[].AttendingProvider.Address.City
String
PossibleCity
Visits[].AttendingProvider.Address.State
String
PossibleState
Visits[].AttendingProvider.Address.ZIP
String
PossibleZIP
Visits[].AttendingProvider.Address.County
String
PossibleCounty
Visits[].AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visits[].AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visits[].AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visits[].AttendingProvider.Location
Object
PossibleProvider's location
Visits[].AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visits[].AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visits[].AttendingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visits[].AttendingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visits[].AttendingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visits[].AttendingProvider.Location.Department
String
PossibleDepartment
Visits[].AttendingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visits[].AttendingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visits[].AttendingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visits[].AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visits[].ConsultingProvider.ID
String
PossibleID of the consulting provider.
This ID is often required for Inpatient Visits.
Visits[].ConsultingProvider.IDType
String
PossibleID type of the ID for the consulting provider
Visits[].ConsultingProvider.FirstName
String
PossibleFirst name of the consulting provider
Visits[].ConsultingProvider.LastName
String
PossibleLast name of the consulting provider
Visits[].ConsultingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the consulting provider.
e.g. MD, PhD
Visits[].ConsultingProvider.Address
Object
PossibleProvider's address
Visits[].ConsultingProvider.Address.StreetAddress
String
PossibleStreet address
Visits[].ConsultingProvider.Address.City
String
PossibleCity
Visits[].ConsultingProvider.Address.State
String
PossibleState
Visits[].ConsultingProvider.Address.ZIP
String
PossibleZIP
Visits[].ConsultingProvider.Address.County
String
PossibleCounty
Visits[].ConsultingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visits[].ConsultingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visits[].ConsultingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visits[].ConsultingProvider.Location
Object
PossibleProvider's location
Visits[].ConsultingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visits[].ConsultingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visits[].ConsultingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visits[].ConsultingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visits[].ConsultingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visits[].ConsultingProvider.Location.Department
String
PossibleDepartment
Visits[].ConsultingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visits[].ConsultingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visits[].ConsultingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visits[].ConsultingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visits[].ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visits[].ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visits[].ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visits[].ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visits[].ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visits[].ReferringProvider.Address
Object
PossibleProvider's address
Visits[].ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visits[].ReferringProvider.Address.City
String
PossibleCity
Visits[].ReferringProvider.Address.State
String
PossibleState
Visits[].ReferringProvider.Address.ZIP
String
PossibleZIP
Visits[].ReferringProvider.Address.County
String
PossibleCounty
Visits[].ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visits[].ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visits[].ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visits[].ReferringProvider.Location
Object
PossibleProvider's location
Visits[].ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visits[].ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visits[].ReferringProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visits[].ReferringProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visits[].ReferringProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visits[].ReferringProvider.Location.Department
String
PossibleDepartment
Visits[].ReferringProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visits[].ReferringProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visits[].ReferringProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visits[].ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visits[].VisitProvider.ID
String
PossibleID of the visit provider.
This ID is often required for Inpatient Visits.
Visits[].VisitProvider.IDType
String
PossibleID type of the ID for the visit provider
Visits[].VisitProvider.FirstName
String
PossibleFirst name of the visit provider
Visits[].VisitProvider.LastName
String
PossibleLast name of the visit provider
Visits[].VisitProvider.Credentials[]
Array of Strings
PossibleList of credentials for the visit provider.
e.g. MD, PhD
Visits[].VisitProvider.Address
Object
PossibleProvider's address
Visits[].VisitProvider.Address.StreetAddress
String
PossibleStreet address
Visits[].VisitProvider.Address.City
String
PossibleCity
Visits[].VisitProvider.Address.State
String
PossibleState
Visits[].VisitProvider.Address.ZIP
String
PossibleZIP
Visits[].VisitProvider.Address.County
String
PossibleCounty
Visits[].VisitProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visits[].VisitProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visits[].VisitProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visits[].VisitProvider.Location
Object
PossibleProvider's location
Visits[].VisitProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visits[].VisitProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visits[].VisitProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visits[].VisitProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visits[].VisitProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visits[].VisitProvider.Location.Department
String
PossibleDepartment
Visits[].VisitProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visits[].VisitProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visits[].VisitProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visits[].VisitProvider.Location.Room
String
PossibleRoom.
Example: 136
Visits[].Location
Object
ReliableDisplays the location of the patient appointment.
Visits[].Location.Type
String
ReliableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visits[].Location.Facility
String
ReliableFacility.
Example: Community Hospital
Visits[].Location.FacilityIdentifiers[]
Array of Objects
ReliableList of IDs specific to this facility
Visits[].Location.FacilityIdentifiers[].ID
String
ReliableAn ID specific to this facility
Visits[].Location.FacilityIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visits[].Location.Department
String
ReliableRequiredDepartment
Visits[].Location.DepartmentIdentifiers[]
Array of Objects
ReliableList of IDs specific to this department
Visits[].Location.DepartmentIdentifiers[].ID
String
ReliableAn ID specific to this department
Visits[].Location.DepartmentIdentifiers[].IDType
String
ReliableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visits[].Location.Room
String
ReliableRoom.
Example: 136
Visits[].AdditionalStaff[]
PossibleContains information about any other staff assigned to the assist with the patient visit. Each may be scheduled individually.
Visits[].AdditionalStaff[].ID
String
ProbableID of the Additional staff member.
This ID is often required for Inpatient Visits.
Visits[].AdditionalStaff[].IDType
String
ProbableID type of the ID for the Additional staff member
Visits[].AdditionalStaff[].FirstName
String
PossibleFirst name of the Additional staff member
Visits[].AdditionalStaff[].LastName
String
PossibleLast name of the Additional staff member
Visits[].AdditionalStaff[].Credentials[]
Array of Strings
PossibleList of credentials for the Additional staff member.
e.g. MD, PhD
Visits[].AdditionalStaff[].Address
Object
PossibleProvider's address
Visits[].AdditionalStaff[].Address.StreetAddress
String
PossibleStreet address
Visits[].AdditionalStaff[].Address.City
String
PossibleCity
Visits[].AdditionalStaff[].Address.State
String
PossibleState
Visits[].AdditionalStaff[].Address.ZIP
String
PossibleZIP
Visits[].AdditionalStaff[].Address.County
String
PossibleCounty
Visits[].AdditionalStaff[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visits[].AdditionalStaff[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visits[].AdditionalStaff[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visits[].AdditionalStaff[].Location
Object
PossibleProvider's location
Visits[].AdditionalStaff[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visits[].AdditionalStaff[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visits[].AdditionalStaff[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visits[].AdditionalStaff[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visits[].AdditionalStaff[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visits[].AdditionalStaff[].Location.Department
String
PossibleDepartment
Visits[].AdditionalStaff[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visits[].AdditionalStaff[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visits[].AdditionalStaff[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visits[].AdditionalStaff[].Location.Room
String
PossibleRoom.
Example: 136
Visits[].AdditionalStaff[].Role
Object
ProbableDefines the role of this person in the patient visit.
Visits[].AdditionalStaff[].Role.Code
String
ProbableCode for the service
Visits[].AdditionalStaff[].Role.Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Visits[].AdditionalStaff[].Role.Description
String
ProbableDescription of the service.
Example: Primary Physician, Technologist, etc.
Visits[].AdditionalStaff[].StartDateTime
DateTime
ProbableIf this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.
Visits[].AdditionalStaff[].Duration
Numeric
ProbableSpecifies the length of time that the staff member is scheduled for.
In minutes
Visits[].Diagnoses[]
Array of Objects
ProbableContains a list of diagnoses associated with the patient visit.
Visits[].Diagnoses[].Code
String
ProbableCode for the diagnosis
Visits[].Diagnoses[].Codeset
String
ProbableValueSetCode set used to identify the diagnosis
-
Additional values may be added by Redox in the future.
-
Visits[].Diagnoses[].Name
String
ProbableName of the diagnosis
Visits[].Diagnoses[].Type
String
PossibleValueSetType of the diagnosis
-
Additional values may be added by Redox in the future.
-
Visits[].Diagnoses[].DocumentedDateTime
String
PossibleDateTime the diagnosis was documented.
ISO 8601 Format
Visits[].Equipment[]
Array of Objects
ProbableSpecifies the equipment or resources assigned to this appointment. Each may be scheduled individually.
Visits[].Equipment[].Code
String
ProbableCode for the equipment
Visits[].Equipment[].Codeset
String
ProbableCode set used to identify the equipment.
Codeset will be blank for system-defined codes.
Visits[].Equipment[].Description
String
ProbableDescription of the equipment.
Example: X-Ray, Therapy Ball, etc.
Visits[].Equipment[].StartDateTime
DateTime
ProbableIf the equipment's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.
Not supported with data on demand.
Visits[].Equipment[].Duration
Numeric
ProbableDefines the length of time (in minutes) that the equipment is scheduled for.
Not supported with data on demand.
Visits[].Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Visits[].Patient.Identifiers[].ID
String
ReliableRequiredID for the patient
Visits[].Patient.Identifiers[].IDType
String
ReliableRequiredType of ID.
E.g. MRN, EPI
Visits[].Patient.Demographics.FirstName
String
ReliablePatient's first name
Visits[].Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Visits[].Patient.Demographics.LastName
String
ReliablePatient's last name
Visits[].Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Visits[].Patient.Demographics.SSN
String
ProbablePatient's social security number
Visits[].Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Visits[].Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Visits[].Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Visits[].Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Visits[].Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Visits[].Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Visits[].Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Visits[].Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Visits[].Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visits[].Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Visits[].Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Visits[].Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Visits[].Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Visits[].Patient.Demographics.Address
Object
ProbablePatient's home address
Visits[].Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Visits[].Patient.Demographics.Address.City
String
ProbableCity
Visits[].Patient.Demographics.Address.State
String
ProbableState
Visits[].Patient.Demographics.Address.ZIP
String
ProbableZIP
Visits[].Patient.Demographics.Address.County
String
PossibleCounty
Visits[].Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visits[].Patient.Notes[]
Array of strings
PossiblePatient-level notes
Visits[].AppointmentInfo[]
Array of Objects
PossibleContains a list of supplementary clinical information associated with the appointment.
Visits[].AppointmentInfo[].Code
String
PossibleCode for the information element
Visits[].AppointmentInfo[].Codeset
String
PossibleCode set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC or other codesets may be used where appropriate.
Visits[].AppointmentInfo[].Description
String
PossibleDescription of the information element.
Additional information that may come from patient-completed forms or other sources
Visits[].AppointmentInfo[].Value
String
PossibleDisplays the value of the corresponding appointment info code. For example, the code identifies the question being answered, and this property contains the answer.
{
"Meta": {
"DataModel": "Scheduling",
"EventType": "BookedResponse",
"EventDateTime": "2023-08-29T18:36:49.023Z",
"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,
"IsIncomplete": false
},
"Visits": [
{
"VisitNumber": "1234",
"AccountNumber": null,
"VisitDateTime": "2016-08-01T10:00:00Z",
"PatientClass": null,
"Status": null,
"Duration": "15",
"Reason": "Follow Up",
"CancelReason": "Conflicting appointment",
"LastUpdated": null,
"ScheduledDateTime": null,
"CancelDateTime": null,
"Type": null,
"Instructions": [],
"AttendingProvider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ConsultingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"VisitProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": "Clinic A",
"DepartmentIdentifiers": [],
"Room": null
},
"AdditionalStaff": [],
"Diagnoses": [],
"Equipment": [],
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": []
},
"AppointmentInfo": []
},
{
"VisitNumber": "1235",
"AccountNumber": null,
"VisitDateTime": "2016-08-01T11:00:00Z",
"PatientClass": null,
"Status": null,
"Duration": "15",
"Reason": "Follow Up",
"CancelReason": null,
"LastUpdated": null,
"ScheduledDateTime": null,
"CancelDateTime": null,
"Type": null,
"Instructions": [],
"AttendingProvider": {
"ID": "4236464757",
"IDType": "NPI",
"FirstName": "John",
"LastName": "Slate",
"Credentials": [
"DO"
],
"Address": {
"StreetAddress": "500 First St.",
"City": "Clayton",
"State": "MO",
"ZIP": "63105",
"County": "Saint Louis",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+13145554321"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ConsultingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"VisitProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": "Clinic A",
"DepartmentIdentifiers": [],
"Room": null
},
"AdditionalStaff": [],
"Diagnoses": [],
"Equipment": [],
"Patient": {
"Identifiers": [
{
"ID": "0000000002",
"IDType": "MR"
},
{
"ID": "81ac9647-3a07-46b7-85b4-c5d09099fb3b",
"IDType": "EHRID"
},
{
"ID": "ffc486eff2b04b8^^^&1.3.6.1.4.1.21367.2005.13.20.1000&ISO",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Barbara",
"MiddleName": null,
"LastName": "Bixby",
"DOB": "1982-07-24",
"SSN": "202-02-0002",
"Sex": "Female",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Married",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675303",
"Office": "+17077543758",
"Mobile": "+19189368865"
},
"EmailAddresses": [
"[email protected]"
],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": []
},
"AppointmentInfo": []
},
{
"VisitNumber": "1236",
"AccountNumber": null,
"VisitDateTime": "2016-08-01T12:00:00Z",
"PatientClass": null,
"Status": null,
"Duration": "15",
"Reason": "Follow Up",
"CancelReason": null,
"LastUpdated": null,
"ScheduledDateTime": null,
"CancelDateTime": null,
"Type": null,
"Instructions": [],
"AttendingProvider": {
"ID": "2434534567",
"IDType": "NPI",
"FirstName": "Sharon",
"LastName": "Chalk",
"Credentials": [
"MD",
"PhD"
],
"Address": {
"StreetAddress": "312 Maple Dr. Suite 400",
"City": "Verona",
"State": "WI",
"ZIP": "53593",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085559999"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ConsultingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"VisitProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": "Clinic A",
"DepartmentIdentifiers": [],
"Room": null
},
"AdditionalStaff": [],
"Diagnoses": [],
"Equipment": [],
"Patient": {
"Identifiers": [
{
"ID": "0000000003",
"IDType": "MR"
},
{
"ID": "e3fedf48-c8bf-4728-845f-cb810001b571",
"IDType": "EHRID"
},
{
"ID": "ef05d4068ee144f^^^&1.3.6.1.4.1.21367.2005.13.20.1000&ISO",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Walter",
"MiddleName": null,
"LastName": "Carthwright",
"DOB": "1945-03-04",
"SSN": "303-03-0003",
"Sex": "Male",
"Race": "Black",
"IsHispanic": true,
"Religion": null,
"MaritalStatus": "Widowed",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675310",
"Office": null,
"Mobile": null
},
"EmailAddresses": [
"[email protected]"
],
"Language": "es",
"Citizenship": [],
"Address": {
"StreetAddress": "648 Ethan Terrace",
"City": "Agoura Hills",
"State": "CA",
"ZIP": "91301",
"County": "Los Angelas",
"Country": "US"
}
},
"Notes": []
},
"AppointmentInfo": []
}
]
}