SurgicalScheduling
The SurgicalScheduling data model is used to receive surgical case information like staff assigned to the surgery, case and procedure details, location, and more. Details like this may come from an OR-specific system or from the same scheduling system as non-surgical appointments.
Some EHR systems may also support sending coded diagnoses or surgical case tracking data. However, not every EHR system requires a coded diagnosis for the procedure to be scheduled, and not every EHR system supports surgical case tracking, which are events about case progress (e.g., when a patient is in the OR, when the surgery has started, or when anesthesia has been administered). Case tracking can help the OR staff better manage utilization by viewing real-time updates.
While the event types are similar to the Scheduling data model, there's additional information such as questionnaire answers from the patient, specific equipment requirements for the procedure, or in-progress notes about the surgery. If you want to receive pre- and post-op office appointments, check out the Scheduling data model.
Just like with the Scheduling data model, though, a surgical appointment gets assigned a case number and patient ID. If the surgical appointment is rescheduled, the case number is usually retained. If the surgical appointment is canceled and later rescheduled, however, a new case number is created.
What you don't get from SurgicalScheduling is insurance information or preference card data (i.e., a surgeon's list of preferred supplies). For insurance information, check out the PatientAdmin data model. Preference card data, on the other hand, isn't currently exchanged via a known standard, but you can use the Inventory data model to track used or wasted supplies.
A New message is generated when an appointment is booked in the EHR.
Fields
Meta
Meta.DataModel
String
ReliableRequiredSurgicalScheduling
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
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType 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
Procedures
Procedures[]
Array of Objects
ProbableArray of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.
Procedures[].Code
String
ProbableCode for the service
Procedures[].Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Procedures[].Description
String
ProbableDescription of the service
Procedures[].DateTime
String
ReliableRequiredDateTime of appointment.
ISO 8601 Format
Procedures[].Duration
Numeric
ReliableRequiredLength of appointment.
In minutes
Procedures[].ProcedureInfo[]
PossibleAdditional information about the procedure being scheduled, such as body site.
Procedures[].ProcedureInfo[].Description
String
PossibleProcedureInfo description, such as 'Laterality'.
Procedures[].ProcedureInfo[].Value
String
PossibleProcedureInfo value, such as 'unilateral left'.
SurgeryStaff
SurgeryStaff[]
PossibleAll of the staff assigned to this appointment. Each may be scheduled individually.
SurgeryStaff[].ID
String
ProbableID of the Surgery staff member.
This ID is often required for Inpatient Visits.
SurgeryStaff[].IDType
String
ProbableID type of the ID for the Surgery staff member
SurgeryStaff[].FirstName
String
PossibleFirst name of the Surgery staff member
SurgeryStaff[].LastName
String
PossibleLast name of the Surgery staff member
SurgeryStaff[].Credentials[]
Array of Strings
PossibleList of credentials for the Surgery staff member.
e.g. MD, PhD
SurgeryStaff[].Address
Object
PossibleProvider's address
SurgeryStaff[].Address.StreetAddress
String
PossibleStreet address
SurgeryStaff[].Address.City
String
PossibleCity
SurgeryStaff[].Address.State
String
PossibleState
SurgeryStaff[].Address.ZIP
String
PossibleZIP
SurgeryStaff[].Address.County
String
PossibleCounty
SurgeryStaff[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
SurgeryStaff[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
SurgeryStaff[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
SurgeryStaff[].Location
Object
PossibleProvider's location
SurgeryStaff[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
SurgeryStaff[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
SurgeryStaff[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
SurgeryStaff[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
SurgeryStaff[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
SurgeryStaff[].Location.Department
String
PossibleDepartment
SurgeryStaff[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
SurgeryStaff[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
SurgeryStaff[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
SurgeryStaff[].Location.Room
String
PossibleRoom.
Example: 136
SurgeryStaff[].Role
Object
ProbableThe role of this person in the surgery.
SurgeryStaff[].Role.Code
String
ProbableCode for the service
SurgeryStaff[].Role.Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
SurgeryStaff[].Role.Description
String
ProbableDescription of the service.
Example: Primary Surgeon, Anesthesiologist, etc.
SurgeryStaff[].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.
SurgeryStaff[].Duration
Numeric
ReliableLength of time that the staff member is scheduled for.
In minutes
SurgicalInfo
SurgicalInfo[]
Array of Objects
ProbableList of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.
SurgicalInfo[].Code
String
ProbableCode for the information element
SurgicalInfo[].Codeset
String
ProbableCode set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.
SurgicalInfo[].Description
String
ProbableDescription of the information element.
For AOEs, this is typically the text of the AOE question
SurgicalInfo[].Value
String
ReliableThe value of the corresponding Surgical Info code.
For example, the code will identify the question being answered, and this property will contain the answer.
Visit
Visit.VisitNumber
String
ReliableRequiredVisit Number used by the EHR to track this appointment.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.VisitDateTime
String
PossibleDateTime of appointment.
ISO 8601 Format
Visit.Status
String
ProbableStatus of the visit.
One of the following: Scheduled, Arrived, Completed, Pending, Canceled, Left without being seen, No show
Visit.Duration
Numeric
PossibleLength of appointment.
In minutes
Visit.PatientClass
String
ReliablePatient class will indicate the state of the patient at the time of scheduling.
Examples: Inpatient, Outpatient, Emergency
Visit.Notes[]
Array of Strings
PossibleNotes about the visit
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.Location
Object
ReliableLocation of the procedure
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.Location.Bed
String
ReliableBed.
Example: B
Visit.Diagnoses[]
Array of Objects
ProbableList of diagnoses associated with this 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
ProbableEquipment 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.
Visit.Equipment[].Duration
Numeric
ProbableLength of time that the equipment is scheduled for.
In minutes
SurgicalCase
SurgicalCase.Number
String
PossibleSurgery specific identifier
SurgicalCase.Status
String
PossibleStatus of the surgical case.
This is most often an EHR-specific value, such as 'Procedure started' or 'In Room'.
{
"Meta": {
"DataModel": "SurgicalScheduling",
"EventType": "New",
"EventDateTime": "2024-09-26T13:09:20.653Z",
"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": []
},
"Procedures": [
{
"Code": "6391",
"Codeset": null,
"Description": "Appendectomy",
"DateTime": "2015-12-13T21:08:57.581Z",
"Duration": 120,
"ProcedureInfo": [
{
"Description": "Laterality",
"Value": "unilateral left"
}
]
}
],
"SurgeryStaff": [
{
"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
},
"Role": {
"Code": "1.1",
"Codeset": null,
"Description": "Primary Surgeon"
},
"StartDateTime": "2015-12-13T21:08:57.581Z",
"Duration": 120
}
],
"SurgicalInfo": [
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Priority",
"Value": "Normal"
},
{
"Code": "1535135",
"Codeset": "Redox EHR Codes",
"Description": "Use Preference Cards",
"Value": "Y"
}
],
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"VisitDateTime": null,
"Status": null,
"Duration": null,
"PatientClass": null,
"Notes": [],
"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
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136",
"Bed": "B"
},
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Equipment": []
},
"SurgicalCase": {
"Number": null,
"Status": null
}
}
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: Procedures[], SurgeryStaff[] entries.
Fields
Meta
Meta.DataModel
String
ReliableRequiredSurgicalScheduling
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
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType 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
Procedures
Procedures[]
Array of Objects
ProbableArray of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.
Procedures[].Code
String
ProbableCode for the service
Procedures[].Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Procedures[].Description
String
ProbableDescription of the service
Procedures[].DateTime
String
ReliableRequiredDateTime of appointment.
ISO 8601 Format
Procedures[].Duration
Numeric
ReliableRequiredLength of appointment.
In minutes
Procedures[].ProcedureInfo[]
PossibleAdditional information about the procedure being scheduled, such as body site.
Procedures[].ProcedureInfo[].Description
String
PossibleProcedureInfo description, such as 'Laterality'.
Procedures[].ProcedureInfo[].Value
String
PossibleProcedureInfo value, such as 'unilateral left'.
SurgeryStaff
SurgeryStaff[]
PossibleAll of the staff assigned to this appointment. Each may be scheduled individually.
SurgeryStaff[].ID
String
ProbableID of the Surgery staff member.
This ID is often required for Inpatient Visits.
SurgeryStaff[].IDType
String
ProbableID type of the ID for the Surgery staff member
SurgeryStaff[].FirstName
String
PossibleFirst name of the Surgery staff member
SurgeryStaff[].LastName
String
PossibleLast name of the Surgery staff member
SurgeryStaff[].Credentials[]
Array of Strings
PossibleList of credentials for the Surgery staff member.
e.g. MD, PhD
SurgeryStaff[].Address
Object
PossibleProvider's address
SurgeryStaff[].Address.StreetAddress
String
PossibleStreet address
SurgeryStaff[].Address.City
String
PossibleCity
SurgeryStaff[].Address.State
String
PossibleState
SurgeryStaff[].Address.ZIP
String
PossibleZIP
SurgeryStaff[].Address.County
String
PossibleCounty
SurgeryStaff[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
SurgeryStaff[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
SurgeryStaff[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
SurgeryStaff[].Location
Object
PossibleProvider's location
SurgeryStaff[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
SurgeryStaff[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
SurgeryStaff[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
SurgeryStaff[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
SurgeryStaff[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
SurgeryStaff[].Location.Department
String
PossibleDepartment
SurgeryStaff[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
SurgeryStaff[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
SurgeryStaff[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
SurgeryStaff[].Location.Room
String
PossibleRoom.
Example: 136
SurgeryStaff[].Role
Object
ProbableThe role of this person in the surgery.
SurgeryStaff[].Role.Code
String
ProbableCode for the service
SurgeryStaff[].Role.Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
SurgeryStaff[].Role.Description
String
ProbableDescription of the service.
Example: Primary Surgeon, Anesthesiologist, etc.
SurgeryStaff[].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.
SurgeryStaff[].Duration
Numeric
ReliableLength of time that the staff member is scheduled for.
In minutes
SurgicalInfo
SurgicalInfo[]
Array of Objects
ProbableList of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.
SurgicalInfo[].Code
String
ProbableCode for the information element
SurgicalInfo[].Codeset
String
ProbableCode set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.
SurgicalInfo[].Description
String
ProbableDescription of the information element.
For AOEs, this is typically the text of the AOE question
SurgicalInfo[].Value
String
ReliableThe value of the corresponding Surgical Info code.
For example, the code will identify the question being answered, and this property will contain the answer.
Visit
Visit.VisitNumber
String
ReliableRequiredVisit Number used by the EHR to track this appointment.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.VisitDateTime
String
PossibleDateTime of appointment.
ISO 8601 Format
Visit.Status
String
ProbableStatus of the visit.
One of the following: Scheduled, Arrived, Completed, Pending, Canceled, Left without being seen, No show
Visit.Duration
Numeric
PossibleLength of appointment.
In minutes
Visit.PatientClass
String
ReliablePatient class will indicate the state of the patient at the time of scheduling.
Examples: Inpatient, Outpatient, Emergency
Visit.Notes[]
Array of Strings
PossibleNotes about the visit
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.Location
Object
ReliableLocation of the procedure
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.Location.Bed
String
ReliableBed.
Example: B
Visit.Diagnoses[]
Array of Objects
ProbableList of diagnoses associated with this 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
ProbableEquipment 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.
Visit.Equipment[].Duration
Numeric
ProbableLength of time that the equipment is scheduled for.
In minutes
SurgicalCase
SurgicalCase.Number
String
PossibleSurgery specific identifier
SurgicalCase.Status
String
PossibleStatus of the surgical case.
This is most often an EHR-specific value, such as 'Procedure started' or 'In Room'.
{
"Meta": {
"DataModel": "SurgicalScheduling",
"EventType": "Reschedule",
"EventDateTime": "2024-09-26T13:09:20.653Z",
"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": []
},
"Procedures": [
{
"Code": "6391",
"Codeset": null,
"Description": "Appendectomy",
"DateTime": "2015-12-13T21:08:57.581Z",
"Duration": 120,
"ProcedureInfo": [
{
"Description": "Laterality",
"Value": "unilateral left"
}
]
}
],
"SurgeryStaff": [
{
"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
},
"Role": {
"Code": "1.1",
"Codeset": null,
"Description": "Primary Surgeon"
},
"StartDateTime": "2015-12-13T21:08:57.581Z",
"Duration": 120
}
],
"SurgicalInfo": [
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Priority",
"Value": "Normal"
},
{
"Code": "1535135",
"Codeset": "Redox EHR Codes",
"Description": "Use Preference Cards",
"Value": "Y"
}
],
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"VisitDateTime": "2024-10-03T13:09:21.575Z",
"Status": null,
"Duration": null,
"PatientClass": null,
"Notes": [],
"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
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136",
"Bed": "B"
},
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Equipment": []
},
"SurgicalCase": {
"Number": null,
"Status": null
}
}
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
ReliableRequiredSurgicalScheduling
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
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType 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
Procedures
Procedures[]
Array of Objects
ProbableArray of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.
Procedures[].Code
String
ProbableCode for the service
Procedures[].Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Procedures[].Description
String
ProbableDescription of the service
Procedures[].DateTime
String
ReliableRequiredDateTime of appointment.
ISO 8601 Format
Procedures[].Duration
Numeric
ReliableRequiredLength of appointment.
In minutes
Procedures[].ProcedureInfo[]
PossibleAdditional information about the procedure being scheduled, such as body site.
Procedures[].ProcedureInfo[].Description
String
PossibleProcedureInfo description, such as 'Laterality'.
Procedures[].ProcedureInfo[].Value
String
PossibleProcedureInfo value, such as 'unilateral left'.
SurgeryStaff
SurgeryStaff[]
PossibleAll of the staff assigned to this appointment. Each may be scheduled individually.
SurgeryStaff[].ID
String
ProbableID of the Surgery staff member.
This ID is often required for Inpatient Visits.
SurgeryStaff[].IDType
String
ProbableID type of the ID for the Surgery staff member
SurgeryStaff[].FirstName
String
PossibleFirst name of the Surgery staff member
SurgeryStaff[].LastName
String
PossibleLast name of the Surgery staff member
SurgeryStaff[].Credentials[]
Array of Strings
PossibleList of credentials for the Surgery staff member.
e.g. MD, PhD
SurgeryStaff[].Address
Object
PossibleProvider's address
SurgeryStaff[].Address.StreetAddress
String
PossibleStreet address
SurgeryStaff[].Address.City
String
PossibleCity
SurgeryStaff[].Address.State
String
PossibleState
SurgeryStaff[].Address.ZIP
String
PossibleZIP
SurgeryStaff[].Address.County
String
PossibleCounty
SurgeryStaff[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
SurgeryStaff[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
SurgeryStaff[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
SurgeryStaff[].Location
Object
PossibleProvider's location
SurgeryStaff[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
SurgeryStaff[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
SurgeryStaff[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
SurgeryStaff[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
SurgeryStaff[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
SurgeryStaff[].Location.Department
String
PossibleDepartment
SurgeryStaff[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
SurgeryStaff[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
SurgeryStaff[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
SurgeryStaff[].Location.Room
String
PossibleRoom.
Example: 136
SurgeryStaff[].Role
Object
ProbableThe role of this person in the surgery.
SurgeryStaff[].Role.Code
String
ProbableCode for the service
SurgeryStaff[].Role.Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
SurgeryStaff[].Role.Description
String
ProbableDescription of the service.
Example: Primary Surgeon, Anesthesiologist, etc.
SurgeryStaff[].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.
SurgeryStaff[].Duration
Numeric
ReliableLength of time that the staff member is scheduled for.
In minutes
SurgicalInfo
SurgicalInfo[]
Array of Objects
ProbableList of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.
SurgicalInfo[].Code
String
ProbableCode for the information element
SurgicalInfo[].Codeset
String
ProbableCode set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.
SurgicalInfo[].Description
String
ProbableDescription of the information element.
For AOEs, this is typically the text of the AOE question
SurgicalInfo[].Value
String
ReliableThe value of the corresponding Surgical Info code.
For example, the code will identify the question being answered, and this property will contain the answer.
Visit
Visit.VisitNumber
String
ReliableRequiredVisit Number used by the EHR to track this appointment.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.VisitDateTime
String
PossibleDateTime of appointment.
ISO 8601 Format
Visit.Status
String
ProbableStatus of the visit.
One of the following: Scheduled, Arrived, Completed, Pending, Canceled, Left without being seen, No show
Visit.Duration
Numeric
PossibleLength of appointment.
In minutes
Visit.PatientClass
String
ReliablePatient class will indicate the state of the patient at the time of scheduling.
Examples: Inpatient, Outpatient, Emergency
Visit.Notes[]
Array of Strings
PossibleNotes about the visit
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.Location
Object
ReliableLocation of the procedure
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.Location.Bed
String
ReliableBed.
Example: B
Visit.Diagnoses[]
Array of Objects
ProbableList of diagnoses associated with this 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
ProbableEquipment 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.
Visit.Equipment[].Duration
Numeric
ProbableLength of time that the equipment is scheduled for.
In minutes
SurgicalCase
SurgicalCase.Number
String
PossibleSurgery specific identifier
SurgicalCase.Status
String
PossibleStatus of the surgical case.
This is most often an EHR-specific value, such as 'Procedure started' or 'In Room'.
{
"Meta": {
"DataModel": "SurgicalScheduling",
"EventType": "Modification",
"EventDateTime": "2024-09-26T13:09:20.653Z",
"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": []
},
"Procedures": [
{
"Code": "6391",
"Codeset": null,
"Description": "Appendectomy",
"DateTime": "2015-12-13T21:08:57.581Z",
"Duration": 120,
"ProcedureInfo": [
{
"Description": "Laterality",
"Value": "unilateral left"
}
]
}
],
"SurgeryStaff": [
{
"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
},
"Role": {
"Code": "1.1",
"Codeset": null,
"Description": "Primary Surgeon"
},
"StartDateTime": "2015-12-13T21:08:57.581Z",
"Duration": 120
}
],
"SurgicalInfo": [
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Priority",
"Value": "Normal"
},
{
"Code": "1535135",
"Codeset": "Redox EHR Codes",
"Description": "Use Preference Cards",
"Value": "Y"
}
],
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"VisitDateTime": null,
"Status": null,
"Duration": 30,
"PatientClass": null,
"Notes": [],
"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
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136",
"Bed": "B"
},
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Equipment": []
},
"SurgicalCase": {
"Number": null,
"Status": null
}
}
A Cancel message is generated when an appointment is canceled. Visit.VisitNumber identifies the appointment being canceled.
Fields
Meta
Meta.DataModel
String
ReliableRequiredSurgicalScheduling
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
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType 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
Procedures
Procedures[]
Array of Objects
ProbableArray of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.
Procedures[].Code
String
ProbableCode for the service
Procedures[].Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Procedures[].Description
String
ProbableDescription of the service
Procedures[].DateTime
String
ReliableDateTime of appointment.
ISO 8601 Format
Procedures[].Duration
Numeric
ReliableRequiredLength of appointment.
In minutes
Procedures[].ProcedureInfo[]
PossibleAdditional information about the procedure being scheduled, such as body site.
Procedures[].ProcedureInfo[].Description
String
PossibleProcedureInfo description, such as 'Laterality'.
Procedures[].ProcedureInfo[].Value
String
PossibleProcedureInfo value, such as 'unilateral left'.
SurgeryStaff
SurgeryStaff[]
PossibleAll of the staff assigned to this appointment. Each may be scheduled individually.
SurgeryStaff[].ID
String
ProbableID of the Surgery staff member.
This ID is often required for Inpatient Visits.
SurgeryStaff[].IDType
String
ProbableID type of the ID for the Surgery staff member
SurgeryStaff[].FirstName
String
PossibleFirst name of the Surgery staff member
SurgeryStaff[].LastName
String
PossibleLast name of the Surgery staff member
SurgeryStaff[].Credentials[]
Array of Strings
PossibleList of credentials for the Surgery staff member.
e.g. MD, PhD
SurgeryStaff[].Address
Object
PossibleProvider's address
SurgeryStaff[].Address.StreetAddress
String
PossibleStreet address
SurgeryStaff[].Address.City
String
PossibleCity
SurgeryStaff[].Address.State
String
PossibleState
SurgeryStaff[].Address.ZIP
String
PossibleZIP
SurgeryStaff[].Address.County
String
PossibleCounty
SurgeryStaff[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
SurgeryStaff[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
SurgeryStaff[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
SurgeryStaff[].Location
Object
PossibleProvider's location
SurgeryStaff[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
SurgeryStaff[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
SurgeryStaff[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
SurgeryStaff[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
SurgeryStaff[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
SurgeryStaff[].Location.Department
String
PossibleDepartment
SurgeryStaff[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
SurgeryStaff[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
SurgeryStaff[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
SurgeryStaff[].Location.Room
String
PossibleRoom.
Example: 136
SurgeryStaff[].Role
Object
ProbableThe role of this person in the surgery.
SurgeryStaff[].Role.Code
String
ProbableCode for the service
SurgeryStaff[].Role.Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
SurgeryStaff[].Role.Description
String
ProbableDescription of the service.
Example: Primary Surgeon, Anesthesiologist, etc.
SurgeryStaff[].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.
SurgeryStaff[].Duration
Numeric
ReliableLength of time that the staff member is scheduled for.
In minutes
SurgicalInfo
SurgicalInfo[]
Array of Objects
ProbableList of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.
SurgicalInfo[].Code
String
ProbableCode for the information element
SurgicalInfo[].Codeset
String
ProbableCode set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.
SurgicalInfo[].Description
String
ProbableDescription of the information element.
For AOEs, this is typically the text of the AOE question
SurgicalInfo[].Value
String
ReliableThe value of the corresponding Surgical Info code.
For example, the code will identify the question being answered, and this property will contain the answer.
Visit
Visit.VisitNumber
String
ReliableRequiredVisit Number used by the EHR to track this appointment.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.VisitDateTime
String
PossibleDateTime of appointment.
ISO 8601 Format
Visit.Status
String
ProbableStatus of the visit.
One of the following: Scheduled, Arrived, Completed, Pending, Canceled, Left without being seen, No show
Visit.CancelReason
String
PossibleReason the visit was canceled
Visit.Duration
Numeric
PossibleLength of appointment.
In minutes
Visit.PatientClass
String
ReliablePatient class will indicate the state of the patient at the time of scheduling.
Examples: Inpatient, Outpatient, Emergency
Visit.Notes[]
Array of Strings
PossibleNotes about the visit
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.Location
Object
ReliableLocation of the procedure
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.Location.Bed
String
ReliableBed.
Example: B
Visit.Diagnoses[]
Array of Objects
ProbableList of diagnoses associated with this 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
ProbableEquipment 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.
Visit.Equipment[].Duration
Numeric
ProbableLength of time that the equipment is scheduled for.
In minutes
SurgicalCase
SurgicalCase.Number
String
PossibleSurgery specific identifier
SurgicalCase.Status
String
PossibleStatus of the surgical case.
This is most often an EHR-specific value, such as 'Procedure started' or 'In Room'.
{
"Meta": {
"DataModel": "SurgicalScheduling",
"EventType": "Cancel",
"EventDateTime": "2024-09-26T13:09:20.653Z",
"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": []
},
"Procedures": [
{
"Code": "6391",
"Codeset": null,
"Description": "Appendectomy",
"DateTime": "2015-12-13T21:08:57.581Z",
"Duration": 120,
"ProcedureInfo": [
{
"Description": "Laterality",
"Value": "unilateral left"
}
]
}
],
"SurgeryStaff": [
{
"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
},
"Role": {
"Code": "1.1",
"Codeset": null,
"Description": "Primary Surgeon"
},
"StartDateTime": "2015-12-13T21:08:57.581Z",
"Duration": 120
}
],
"SurgicalInfo": [
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Priority",
"Value": "Normal"
},
{
"Code": "1535135",
"Codeset": "Redox EHR Codes",
"Description": "Use Preference Cards",
"Value": "Y"
}
],
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"VisitDateTime": null,
"Status": null,
"CancelReason": "Conflicting appointment",
"Duration": null,
"PatientClass": null,
"Notes": [],
"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
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136",
"Bed": "B"
},
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Equipment": []
},
"SurgicalCase": {
"Number": null,
"Status": null
}
}
A NoShow message is generated when a patient does not show up for the scheduled appointment.
Fields
Meta
Meta.DataModel
String
ReliableRequiredSurgicalScheduling
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
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType 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
Procedures
Procedures[]
Array of Objects
ProbableArray of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.
Procedures[].Code
String
ProbableCode for the service
Procedures[].Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Procedures[].Description
String
ProbableDescription of the service
Procedures[].DateTime
String
ReliableRequiredDateTime of appointment.
ISO 8601 Format
Procedures[].Duration
Numeric
ReliableRequiredLength of appointment.
In minutes
Procedures[].ProcedureInfo[]
PossibleAdditional information about the procedure being scheduled, such as body site.
Procedures[].ProcedureInfo[].Description
String
PossibleProcedureInfo description, such as 'Laterality'.
Procedures[].ProcedureInfo[].Value
String
PossibleProcedureInfo value, such as 'unilateral left'.
SurgeryStaff
SurgeryStaff[]
PossibleAll of the staff assigned to this appointment. Each may be scheduled individually.
SurgeryStaff[].ID
String
ProbableID of the Surgery staff member.
This ID is often required for Inpatient Visits.
SurgeryStaff[].IDType
String
ProbableID type of the ID for the Surgery staff member
SurgeryStaff[].FirstName
String
PossibleFirst name of the Surgery staff member
SurgeryStaff[].LastName
String
PossibleLast name of the Surgery staff member
SurgeryStaff[].Credentials[]
Array of Strings
PossibleList of credentials for the Surgery staff member.
e.g. MD, PhD
SurgeryStaff[].Address
Object
PossibleProvider's address
SurgeryStaff[].Address.StreetAddress
String
PossibleStreet address
SurgeryStaff[].Address.City
String
PossibleCity
SurgeryStaff[].Address.State
String
PossibleState
SurgeryStaff[].Address.ZIP
String
PossibleZIP
SurgeryStaff[].Address.County
String
PossibleCounty
SurgeryStaff[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
SurgeryStaff[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
SurgeryStaff[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
SurgeryStaff[].Location
Object
PossibleProvider's location
SurgeryStaff[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
SurgeryStaff[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
SurgeryStaff[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
SurgeryStaff[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
SurgeryStaff[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
SurgeryStaff[].Location.Department
String
PossibleDepartment
SurgeryStaff[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
SurgeryStaff[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
SurgeryStaff[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
SurgeryStaff[].Location.Room
String
PossibleRoom.
Example: 136
SurgeryStaff[].Role
Object
ProbableThe role of this person in the surgery.
SurgeryStaff[].Role.Code
String
ProbableCode for the service
SurgeryStaff[].Role.Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
SurgeryStaff[].Role.Description
String
ProbableDescription of the service.
Example: Primary Surgeon, Anesthesiologist, etc.
SurgeryStaff[].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.
SurgeryStaff[].Duration
Numeric
ReliableLength of time that the staff member is scheduled for.
In minutes
SurgicalInfo
SurgicalInfo[]
Array of Objects
ProbableList of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.
SurgicalInfo[].Code
String
ProbableCode for the information element
SurgicalInfo[].Codeset
String
ProbableCode set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.
SurgicalInfo[].Description
String
ProbableDescription of the information element.
For AOEs, this is typically the text of the AOE question
SurgicalInfo[].Value
String
ReliableThe value of the corresponding Surgical Info code.
For example, the code will identify the question being answered, and this property will contain the answer.
Visit
Visit.VisitNumber
String
ReliableRequiredVisit Number used by the EHR to track this appointment.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.VisitDateTime
String
PossibleDateTime of appointment.
ISO 8601 Format
Visit.Status
String
ProbableStatus of the visit.
One of the following: Scheduled, Arrived, Completed, Pending, Canceled, Left without being seen, No show
Visit.NoShowReason
String
PossibleReason the patient did not show for the appointment
Visit.Duration
Numeric
PossibleLength of appointment.
In minutes
Visit.PatientClass
String
ReliablePatient class will indicate the state of the patient at the time of scheduling.
Examples: Inpatient, Outpatient, Emergency
Visit.Notes[]
Array of Strings
PossibleNotes about the visit
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.Location
Object
ReliableLocation of the procedure
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.Location.Bed
String
ReliableBed.
Example: B
Visit.Diagnoses[]
Array of Objects
ProbableList of diagnoses associated with this 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
ProbableEquipment 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.
Visit.Equipment[].Duration
Numeric
ProbableLength of time that the equipment is scheduled for.
In minutes
SurgicalCase
SurgicalCase.Number
String
PossibleSurgery specific identifier
SurgicalCase.Status
String
PossibleStatus of the surgical case.
This is most often an EHR-specific value, such as 'Procedure started' or 'In Room'.
{
"Meta": {
"DataModel": "SurgicalScheduling",
"EventType": "NoShow",
"EventDateTime": "2024-09-26T13:09:20.653Z",
"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": []
},
"Procedures": [
{
"Code": "6391",
"Codeset": null,
"Description": "Appendectomy",
"DateTime": "2015-12-13T21:08:57.581Z",
"Duration": 120,
"ProcedureInfo": [
{
"Description": "Laterality",
"Value": "unilateral left"
}
]
}
],
"SurgeryStaff": [
{
"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
},
"Role": {
"Code": "1.1",
"Codeset": null,
"Description": "Primary Surgeon"
},
"StartDateTime": "2015-12-13T21:08:57.581Z",
"Duration": 120
}
],
"SurgicalInfo": [
{
"Code": "23457",
"Codeset": "Redox EHR Codes",
"Description": "Priority",
"Value": "Normal"
},
{
"Code": "1535135",
"Codeset": "Redox EHR Codes",
"Description": "Use Preference Cards",
"Value": "Y"
}
],
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"VisitDateTime": null,
"Status": null,
"NoShowReason": "Car broke down.",
"Duration": null,
"PatientClass": null,
"Notes": [],
"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
}
},
"Location": {
"Type": "Inpatient",
"Facility": "RES General Hospital",
"FacilityIdentifiers": [],
"Department": "3N",
"DepartmentIdentifiers": [],
"Room": "136",
"Bed": "B"
},
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Pain in throat",
"Type": null,
"DocumentedDateTime": null
}
],
"Equipment": []
},
"SurgicalCase": {
"Number": null,
"Status": null
}
}