SchedulingPowered by Data Château

Scheduling messages are generated by a scheduling user in the EHR. They are used to notify external systems of new appointments and changes to existing appointments. Every appointment gets assigned a Visit.VisitNumber, and any changes to that appointment use the VisitNumber to identify the appointment getting altered. A patient ID can generally be expected. For Scheduling Holds and Blocks, the Patient ID will be null.

Data Château aggregates scheduling messages to create a comprehensive view of an organization's schedule. The Booked query and response events are then available for searching the schedule.

Newlink

A New message is generated and sent outbound from an EHR when an appointment is booked. Similarly, an application can generate and post a New message inbound to the EHR to schedule an appointment.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. E.g. New, Update

    • Meta.Test

      Boolean

      Reliable

      Flag as a test message

    • Meta.Source

      String

      Reliable

      Where the message originated. Included in messages from Redox

    • Meta.Source.ID

      String

      Reliable

      ID of the source. UUID

    • Meta.Source.Name

      String

      Reliable

      Name of the source

    • Meta.Destinations[]

      Array of Objects

      Reliable

      List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination. Required when sending data to Redox

    • Meta.Destinations[].ID

      String

      Reliable

      ID of the destination. UUID

    • Meta.Destinations[].Name

      String

      Reliable

      Name of the destination

    • Meta.Message

      String

      Reliable

      Record in Redox that corresponds to the communication sent from the source to Redox. Included in messages from Redox

    • Meta.Message.ID

      Numeric

      Reliable

      ID of the message created in Redox

    • Meta.Transmission

      String

      Reliable

      Record in Redox that corresponds to the communication sent from Redox to your destination. Included in messages from Redox

    • Meta.Transmission.ID

      Numeric

      Reliable

      ID of the transmission created in Redox

    • Meta.FacilityCode

      String

      Possible

      Code for the facility related to the message. Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

  • Patient
    • Patient.Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the patient

    • Patient.Identifiers[].ID

      String

      Reliable

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Reliable

      Type of ID. E.g. MRN, EPI

    • Patient.Demographics.FirstName

      String

      Reliable

      Patient's first name

    • Patient.Demographics.MiddleName

      String

      Possible

      Patient'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

      Reliable

      Patient's last name

    • Patient.Demographics.DOB

      String

      Reliable

      Patient's date of birth. In ISO 8601 format

    • Patient.Demographics.SSN

      String

      Probable

      Patient's social security number

    • Patient.Demographics.Sex

      String

      Reliable

      Patient's sex. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • Patient.Demographics.IsDeceased

      Boolean

      Possible

      Indicates if the patient is deceased

    • Patient.Demographics.DeathDateTime

      DateTime

      Possible

      Date and Time the patient was proclaimed deceased. ISO 8601 Format

    • Patient.Demographics.PhoneNumber.Home

      String

      Probable

      Patient's home phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Office

      String

      Probable

      Patient's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Mobile

      String

      Probable

      Patient's mobile phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.EmailAddresses[]

      Array of Strings

      Probable

      Patient's email address(es)

    • Patient.Demographics.Language

      String

      Possible

      Patient's primary spoken language. In ISO 639-1 alpha values (e.g. 'en'). Supported Values

    • Patient.Demographics.Citizenship[]

      Array of strings

      Possible

      Patient's nation(s) of citizenship. *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.

      Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*

    • Patient.Demographics.Address

      Object

      Probable

      Patient's home address

    • Patient.Demographics.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.Demographics.Address.City

      String

      Probable

      City

    • Patient.Demographics.Address.State

      String

      Probable

      State

    • Patient.Demographics.Address.ZIP

      String

      Probable

      ZIP

    • Patient.Demographics.Address.County

      String

      Possible

      County

    • Patient.Demographics.Address.Country

      String

      Possible

      Country

    • Patient.Notes[]

      Array of strings

      Possible

      Patient-level notes

  • AppointmentInfo
    • AppointmentInfo[]

      Array of Objects

      Probable

      List of supplementary clinical information associated with the appointment

    • AppointmentInfo[].Code

      String

      Probable

      Code for the information element

    • AppointmentInfo[].Codeset

      String

      Probable

      Code set used to identify the information element. Codeset will be blank for system-defined codes. LOINC or other codesets may be used where appropriate.

    • AppointmentInfo[].Description

      String

      Probable

      Description of the information element. Additional information that may come from patient-completed forms or other sources

    • AppointmentInfo[].Value

      String

      Reliable

      The value of the corresponding Appointment Info code. For example, the code will identify the question being answered, and this property will contain the answer.

  • Visit
    • Visit.VisitNumber

      String

      Reliable
      Required

      Visit Number

    • Visit.VisitDateTime

      String

      Reliable
      Required

      DateTime of appointment. ISO 8601 Format

    • Visit.PatientClass

      String

      Probable

      Patient class is used in many EHRs to determine where to put the patient. Examples: Outpatient, Hosptial Outpatient Department

    • Visit.Status

      String

      Probable

      Status of the visit. One of the following: Scheduled, Arrived, Completed, Canceled, Left without being seen, No show

    • Visit.Duration

      Numeric

      Reliable
      Required

      Length of appointment. In minutes

    • Visit.Reason

      String

      Probable

      Reason for appointment

    • Visit.Instructions[]

      Array of Strings

      Probable

      Appointment instructions

    • Visit.AttendingProvider.ID

      String

      Probable

      ID of the attending provider. This ID is required for Inpatient Visits

    • Visit.AttendingProvider.IDType

      String

      Probable

      ID type of the ID for the attending provider

    • Visit.AttendingProvider.FirstName

      String

      Possible

      First name of the attending provider

    • Visit.AttendingProvider.LastName

      String

      Possible

      Last name of the attending provider

    • Visit.AttendingProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the attending provider. e.g. MD, PhD

    • Visit.AttendingProvider.Address

      Object

      Possible

      Provider's address

    • Visit.AttendingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.AttendingProvider.Address.City

      String

      Possible

      City

    • Visit.AttendingProvider.Address.State

      String

      Possible

      State

    • Visit.AttendingProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.AttendingProvider.Address.County

      String

      Possible

      County

    • Visit.AttendingProvider.Address.Country

      String

      Possible

      Country

    • Visit.AttendingProvider.Location

      Object

      Possible

      Provider's location

    • Visit.AttendingProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.AttendingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.AttendingProvider.Location.Department

      String

      Possible

      Department

    • Visit.AttendingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.AttendingProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.ConsultingProvider.ID

      String

      Possible

      ID of the consulting provider. This ID is required for Inpatient Visits

    • Visit.ConsultingProvider.IDType

      String

      Possible

      ID type of the ID for the consulting provider

    • Visit.ConsultingProvider.FirstName

      String

      Possible

      First name of the consulting provider

    • Visit.ConsultingProvider.LastName

      String

      Possible

      Last name of the consulting provider

    • Visit.ConsultingProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the consulting provider. e.g. MD, PhD

    • Visit.ConsultingProvider.Address

      Object

      Possible

      Provider's address

    • Visit.ConsultingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.ConsultingProvider.Address.City

      String

      Possible

      City

    • Visit.ConsultingProvider.Address.State

      String

      Possible

      State

    • Visit.ConsultingProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.ConsultingProvider.Address.County

      String

      Possible

      County

    • Visit.ConsultingProvider.Address.Country

      String

      Possible

      Country

    • Visit.ConsultingProvider.Location

      Object

      Possible

      Provider's location

    • Visit.ConsultingProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.ConsultingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.ConsultingProvider.Location.Department

      String

      Possible

      Department

    • Visit.ConsultingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.ConsultingProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.ReferringProvider.ID

      String

      Possible

      ID of the referring provider. This ID is required for Inpatient Visits

    • Visit.ReferringProvider.IDType

      String

      Possible

      ID type of the ID for the referring provider

    • Visit.ReferringProvider.FirstName

      String

      Possible

      First name of the referring provider

    • Visit.ReferringProvider.LastName

      String

      Possible

      Last name of the referring provider

    • Visit.ReferringProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the referring provider. e.g. MD, PhD

    • Visit.ReferringProvider.Address

      Object

      Possible

      Provider's address

    • Visit.ReferringProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.ReferringProvider.Address.City

      String

      Possible

      City

    • Visit.ReferringProvider.Address.State

      String

      Possible

      State

    • Visit.ReferringProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.ReferringProvider.Address.County

      String

      Possible

      County

    • Visit.ReferringProvider.Address.Country

      String

      Possible

      Country

    • Visit.ReferringProvider.Location

      Object

      Possible

      Provider's location

    • Visit.ReferringProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.ReferringProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.ReferringProvider.Location.Department

      String

      Possible

      Department

    • Visit.ReferringProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.ReferringProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.VisitProvider.ID

      String

      Possible

      ID of the visit provider. This ID is required for Inpatient Visits

    • Visit.VisitProvider.IDType

      String

      Possible

      ID type of the ID for the visit provider

    • Visit.VisitProvider.FirstName

      String

      Possible

      First name of the visit provider

    • Visit.VisitProvider.LastName

      String

      Possible

      Last name of the visit provider

    • Visit.VisitProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the visit provider. e.g. MD, PhD

    • Visit.VisitProvider.Address

      Object

      Possible

      Provider's address

    • Visit.VisitProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.VisitProvider.Address.City

      String

      Possible

      City

    • Visit.VisitProvider.Address.State

      String

      Possible

      State

    • Visit.VisitProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.VisitProvider.Address.County

      String

      Possible

      County

    • Visit.VisitProvider.Address.Country

      String

      Possible

      Country

    • Visit.VisitProvider.Location

      Object

      Possible

      Provider's location

    • Visit.VisitProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.VisitProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.VisitProvider.Location.Department

      String

      Possible

      Department

    • Visit.VisitProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.VisitProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.Location

      Object

      Reliable

      Location of the appointment

    • Visit.Location.Type

      String

      Reliable

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.Location.Facility

      String

      Reliable

      Facility. Example: Community Hospital

    • Visit.Location.Department

      String

      Reliable
      Required

      Department

    • Visit.Location.Room

      String

      Reliable

      Room. Example: 136

    • Visit.Diagnoses[]

      Array of Objects

      Probable

      List of diagnoses associated with this visit

    • Visit.Diagnoses[].Code

      String

      Probable

      Code for the diagnosis

    • Visit.Diagnoses[].Codeset

      String

      Probable

      Code set used to identify the diagnosis. One of the following: ICD9, ICD10, HCPCS, CPT

    • Visit.Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Visit.Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

{
   "Meta": {
      "DataModel": "Scheduling",
      "EventType": "New",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Hickory Street",
            "City": "Monroe",
            "State": "WI",
            "ZIP": "53566",
            "County": "Green",
            "Country": "US"
         }
      },
      "Notes": []
   },
   "AppointmentInfo": [
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Priority",
         "Value": "Normal"
      },
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Form",
         "Value": "Lumbar"
      }
   ],
   "Visit": {
      "VisitNumber": "1234",
      "VisitDateTime": "2017-12-06T00:28:29.632Z",
      "PatientClass": null,
      "Status": null,
      "Duration": 15,
      "Reason": "Check up",
      "Instructions": [],
      "AttendingProvider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "ConsultingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "VisitProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "RES General Hospital",
         "Department": "3N",
         "Room": "136"
      },
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Pain in throat",
            "Type": null
         }
      ]
   }
}

Reschedulelink

A Reschedule message is generated when the date or time of an appoinment is changed. Pay attention to the Visit.VisitNumber, Visit.VisitDateTime and Visit.OldDateTime fields.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. Reschedule

    • Meta.Test

      Boolean

      Reliable

      Flag as a test message

    • Meta.Source

      String

      Reliable

      Where the message originated. Included in messages from Redox

    • Meta.Source.ID

      String

      Reliable

      ID of the source. UUID

    • Meta.Source.Name

      String

      Reliable

      Name of the source

    • Meta.Destinations[]

      Array of Objects

      Reliable

      List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination. Required when sending data to Redox

    • Meta.Destinations[].ID

      String

      Reliable

      ID of the destination. UUID

    • Meta.Destinations[].Name

      String

      Reliable

      Name of the destination

    • Meta.Message

      String

      Reliable

      Record in Redox that corresponds to the communication sent from the source to Redox. Included in messages from Redox

    • Meta.Message.ID

      Numeric

      Reliable

      ID of the message created in Redox

    • Meta.Transmission

      String

      Reliable

      Record in Redox that corresponds to the communication sent from Redox to your destination. Included in messages from Redox

    • Meta.Transmission.ID

      Numeric

      Reliable

      ID of the transmission created in Redox

    • Meta.FacilityCode

      String

      Possible

      Code for the facility related to the message. Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

  • Patient
    • Patient.Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the patient

    • Patient.Identifiers[].ID

      String

      Reliable

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Reliable

      Type of ID. E.g. MRN, EPI

    • Patient.Demographics.FirstName

      String

      Reliable

      Patient's first name

    • Patient.Demographics.MiddleName

      String

      Possible

      Patient'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

      Reliable

      Patient's last name

    • Patient.Demographics.DOB

      String

      Reliable

      Patient's date of birth. In ISO 8601 format

    • Patient.Demographics.SSN

      String

      Probable

      Patient's social security number

    • Patient.Demographics.Sex

      String

      Reliable

      Patient's sex. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • Patient.Demographics.IsDeceased

      Boolean

      Possible

      Indicates if the patient is deceased

    • Patient.Demographics.DeathDateTime

      DateTime

      Possible

      Date and Time the patient was proclaimed deceased. ISO 8601 Format

    • Patient.Demographics.PhoneNumber.Home

      String

      Probable

      Patient's home phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Office

      String

      Probable

      Patient's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Mobile

      String

      Probable

      Patient's mobile phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.EmailAddresses[]

      Array of Strings

      Probable

      Patient's email address(es)

    • Patient.Demographics.Language

      String

      Possible

      Patient's primary spoken language. In ISO 639-1 alpha values (e.g. 'en'). Supported Values

    • Patient.Demographics.Citizenship[]

      Array of strings

      Possible

      Patient's nation(s) of citizenship. *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.

      Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*

    • Patient.Demographics.Address

      Object

      Probable

      Patient's home address

    • Patient.Demographics.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.Demographics.Address.City

      String

      Probable

      City

    • Patient.Demographics.Address.State

      String

      Probable

      State

    • Patient.Demographics.Address.ZIP

      String

      Probable

      ZIP

    • Patient.Demographics.Address.County

      String

      Possible

      County

    • Patient.Demographics.Address.Country

      String

      Possible

      Country

    • Patient.Notes[]

      Array of strings

      Possible

      Patient-level notes

  • AppointmentInfo
    • AppointmentInfo[]

      Array of Objects

      Probable

      List of supplementary clinical information associated with the appointment

    • AppointmentInfo[].Code

      String

      Probable

      Code for the information element

    • AppointmentInfo[].Codeset

      String

      Probable

      Code set used to identify the information element. Codeset will be blank for system-defined codes. LOINC or other codesets may be used where appropriate.

    • AppointmentInfo[].Description

      String

      Probable

      Description of the information element. Additional information that may come from patient-completed forms or other sources

    • AppointmentInfo[].Value

      String

      Reliable

      The value of the corresponding Appointment Info code. For example, the code will identify the question being answered, and this property will contain the answer.

  • Visit
    • Visit.VisitNumber

      String

      Reliable
      Required

      Visit Number

    • Visit.OldVisitNumber

      String

      Possible

      Visit Number of the appointment being rescheduled. This is only needed by some systems, such as athenahealth. For systems that do not need this for rescheduling, it will be the likely same as the Visit.VisitNumber.

    • Visit.VisitDateTime

      String

      Reliable
      Required

      New DateTime of the appointment. ISO 8601 Format

    • Visit.OldDateTime

      String

      Possible

      Old DateTime of the appointment. ISO 8601 Format

    • Visit.PatientClass

      String

      Probable

      Patient class is used in many EHRs to determine where to put the patient. Examples: Outpatient, Hosptial Outpatient Department

    • Visit.Status

      String

      Probable

      Status of the visit. One of the following: Scheduled, Arrived, Completed, Canceled, Left without being seen, No show

    • Visit.Duration

      Numeric

      Reliable
      Required

      Length of appointment. In minutes

    • Visit.Reason

      String

      Probable

      Reason for appointment

    • Visit.Instructions[]

      Array of Strings

      Probable

      Appointment instructions

    • Visit.AttendingProvider.ID

      String

      Probable

      ID of the attending provider. This ID is required for Inpatient Visits

    • Visit.AttendingProvider.IDType

      String

      Probable

      ID type of the ID for the attending provider

    • Visit.AttendingProvider.FirstName

      String

      Possible

      First name of the attending provider

    • Visit.AttendingProvider.LastName

      String

      Possible

      Last name of the attending provider

    • Visit.AttendingProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the attending provider. e.g. MD, PhD

    • Visit.AttendingProvider.Address

      Object

      Possible

      Provider's address

    • Visit.AttendingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.AttendingProvider.Address.City

      String

      Possible

      City

    • Visit.AttendingProvider.Address.State

      String

      Possible

      State

    • Visit.AttendingProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.AttendingProvider.Address.County

      String

      Possible

      County

    • Visit.AttendingProvider.Address.Country

      String

      Possible

      Country

    • Visit.AttendingProvider.Location

      Object

      Possible

      Provider's location

    • Visit.AttendingProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.AttendingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.AttendingProvider.Location.Department

      String

      Possible

      Department

    • Visit.AttendingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.AttendingProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.ConsultingProvider.ID

      String

      Possible

      ID of the consulting provider. This ID is required for Inpatient Visits

    • Visit.ConsultingProvider.IDType

      String

      Possible

      ID type of the ID for the consulting provider

    • Visit.ConsultingProvider.FirstName

      String

      Possible

      First name of the consulting provider

    • Visit.ConsultingProvider.LastName

      String

      Possible

      Last name of the consulting provider

    • Visit.ConsultingProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the consulting provider. e.g. MD, PhD

    • Visit.ConsultingProvider.Address

      Object

      Possible

      Provider's address

    • Visit.ConsultingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.ConsultingProvider.Address.City

      String

      Possible

      City

    • Visit.ConsultingProvider.Address.State

      String

      Possible

      State

    • Visit.ConsultingProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.ConsultingProvider.Address.County

      String

      Possible

      County

    • Visit.ConsultingProvider.Address.Country

      String

      Possible

      Country

    • Visit.ConsultingProvider.Location

      Object

      Possible

      Provider's location

    • Visit.ConsultingProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.ConsultingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.ConsultingProvider.Location.Department

      String

      Possible

      Department

    • Visit.ConsultingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.ConsultingProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.ReferringProvider.ID

      String

      Possible

      ID of the referring provider. This ID is required for Inpatient Visits

    • Visit.ReferringProvider.IDType

      String

      Possible

      ID type of the ID for the referring provider

    • Visit.ReferringProvider.FirstName

      String

      Possible

      First name of the referring provider

    • Visit.ReferringProvider.LastName

      String

      Possible

      Last name of the referring provider

    • Visit.ReferringProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the referring provider. e.g. MD, PhD

    • Visit.ReferringProvider.Address

      Object

      Possible

      Provider's address

    • Visit.ReferringProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.ReferringProvider.Address.City

      String

      Possible

      City

    • Visit.ReferringProvider.Address.State

      String

      Possible

      State

    • Visit.ReferringProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.ReferringProvider.Address.County

      String

      Possible

      County

    • Visit.ReferringProvider.Address.Country

      String

      Possible

      Country

    • Visit.ReferringProvider.Location

      Object

      Possible

      Provider's location

    • Visit.ReferringProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.ReferringProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.ReferringProvider.Location.Department

      String

      Possible

      Department

    • Visit.ReferringProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.ReferringProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.VisitProvider.ID

      String

      Possible

      ID of the visit provider. This ID is required for Inpatient Visits

    • Visit.VisitProvider.IDType

      String

      Possible

      ID type of the ID for the visit provider

    • Visit.VisitProvider.FirstName

      String

      Possible

      First name of the visit provider

    • Visit.VisitProvider.LastName

      String

      Possible

      Last name of the visit provider

    • Visit.VisitProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the visit provider. e.g. MD, PhD

    • Visit.VisitProvider.Address

      Object

      Possible

      Provider's address

    • Visit.VisitProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.VisitProvider.Address.City

      String

      Possible

      City

    • Visit.VisitProvider.Address.State

      String

      Possible

      State

    • Visit.VisitProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.VisitProvider.Address.County

      String

      Possible

      County

    • Visit.VisitProvider.Address.Country

      String

      Possible

      Country

    • Visit.VisitProvider.Location

      Object

      Possible

      Provider's location

    • Visit.VisitProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.VisitProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.VisitProvider.Location.Department

      String

      Possible

      Department

    • Visit.VisitProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.VisitProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.Location

      Object

      Reliable

      Location of the appointment

    • Visit.Location.Type

      String

      Reliable

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.Location.Facility

      String

      Reliable

      Facility. Example: Community Hospital

    • Visit.Location.Department

      String

      Reliable
      Required

      Department

    • Visit.Location.Room

      String

      Reliable

      Room. Example: 136

    • Visit.Diagnoses[]

      Array of Objects

      Probable

      List of diagnoses associated with this visit

    • Visit.Diagnoses[].Code

      String

      Probable

      Code for the diagnosis

    • Visit.Diagnoses[].Codeset

      String

      Probable

      Code set used to identify the diagnosis. One of the following: ICD9, ICD10, HCPCS, CPT

    • Visit.Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Visit.Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

{
   "Meta": {
      "DataModel": "Scheduling",
      "EventType": "Reschedule",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Hickory Street",
            "City": "Monroe",
            "State": "WI",
            "ZIP": "53566",
            "County": "Green",
            "Country": "US"
         }
      },
      "Notes": []
   },
   "AppointmentInfo": [
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Priority",
         "Value": "Normal"
      },
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Form",
         "Value": "Lumbar"
      }
   ],
   "Visit": {
      "VisitNumber": "1234",
      "OldVisitNumber": "1234",
      "VisitDateTime": "2017-12-13T00:28:29.655Z",
      "OldDateTime": "2017-12-06T00:28:29.655Z",
      "PatientClass": null,
      "Status": null,
      "Duration": 15,
      "Reason": "Check up",
      "Instructions": [],
      "AttendingProvider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "ConsultingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "VisitProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "RES General Hospital",
         "Department": "3N",
         "Room": "136"
      },
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Pain in throat",
            "Type": null
         }
      ]
   }
}

Modificationlink

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

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. Modification

    • Meta.Test

      Boolean

      Reliable

      Flag as a test message

    • Meta.Source

      String

      Reliable

      Where the message originated. Included in messages from Redox

    • Meta.Source.ID

      String

      Reliable

      ID of the source. UUID

    • Meta.Source.Name

      String

      Reliable

      Name of the source

    • Meta.Destinations[]

      Array of Objects

      Reliable

      List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination. Required when sending data to Redox

    • Meta.Destinations[].ID

      String

      Reliable

      ID of the destination. UUID

    • Meta.Destinations[].Name

      String

      Reliable

      Name of the destination

    • Meta.Message

      String

      Reliable

      Record in Redox that corresponds to the communication sent from the source to Redox. Included in messages from Redox

    • Meta.Message.ID

      Numeric

      Reliable

      ID of the message created in Redox

    • Meta.Transmission

      String

      Reliable

      Record in Redox that corresponds to the communication sent from Redox to your destination. Included in messages from Redox

    • Meta.Transmission.ID

      Numeric

      Reliable

      ID of the transmission created in Redox

    • Meta.FacilityCode

      String

      Possible

      Code for the facility related to the message. Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

  • Patient
    • Patient.Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the patient

    • Patient.Identifiers[].ID

      String

      Reliable

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Reliable

      Type of ID. E.g. MRN, EPI

    • Patient.Demographics.FirstName

      String

      Reliable

      Patient's first name

    • Patient.Demographics.MiddleName

      String

      Possible

      Patient'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

      Reliable

      Patient's last name

    • Patient.Demographics.DOB

      String

      Reliable

      Patient's date of birth. In ISO 8601 format

    • Patient.Demographics.SSN

      String

      Probable

      Patient's social security number

    • Patient.Demographics.Sex

      String

      Reliable

      Patient's sex. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • Patient.Demographics.IsDeceased

      Boolean

      Possible

      Indicates if the patient is deceased

    • Patient.Demographics.DeathDateTime

      DateTime

      Possible

      Date and Time the patient was proclaimed deceased. ISO 8601 Format

    • Patient.Demographics.PhoneNumber.Home

      String

      Probable

      Patient's home phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Office

      String

      Probable

      Patient's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Mobile

      String

      Probable

      Patient's mobile phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.EmailAddresses[]

      Array of Strings

      Probable

      Patient's email address(es)

    • Patient.Demographics.Language

      String

      Possible

      Patient's primary spoken language. In ISO 639-1 alpha values (e.g. 'en'). Supported Values

    • Patient.Demographics.Citizenship[]

      Array of strings

      Possible

      Patient's nation(s) of citizenship. *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.

      Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*

    • Patient.Demographics.Address

      Object

      Probable

      Patient's home address

    • Patient.Demographics.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.Demographics.Address.City

      String

      Probable

      City

    • Patient.Demographics.Address.State

      String

      Probable

      State

    • Patient.Demographics.Address.ZIP

      String

      Probable

      ZIP

    • Patient.Demographics.Address.County

      String

      Possible

      County

    • Patient.Demographics.Address.Country

      String

      Possible

      Country

    • Patient.Notes[]

      Array of strings

      Possible

      Patient-level notes

  • AppointmentInfo
    • AppointmentInfo[]

      Array of Objects

      Probable

      List of supplementary clinical information associated with the appointment

    • AppointmentInfo[].Code

      String

      Probable

      Code for the information element

    • AppointmentInfo[].Codeset

      String

      Probable

      Code set used to identify the information element. Codeset will be blank for system-defined codes. LOINC or other codesets may be used where appropriate.

    • AppointmentInfo[].Description

      String

      Probable

      Description of the information element. Additional information that may come from patient-completed forms or other sources

    • AppointmentInfo[].Value

      String

      Reliable

      The value of the corresponding Appointment Info code. For example, the code will identify the question being answered, and this property will contain the answer.

  • Visit
    • Visit.VisitNumber

      String

      Reliable
      Required

      Visit Number

    • Visit.VisitDateTime

      String

      Reliable
      Required

      DateTime of appointment. ISO 8601 Format

    • Visit.PatientClass

      String

      Probable

      Patient class is used in many EHRs to determine where to put the patient. Examples: Outpatient, Hosptial Outpatient Department

    • Visit.Status

      String

      Probable

      Status of the visit. One of the following: Scheduled, Arrived, Completed, Canceled, Left without being seen, No show

    • Visit.Duration

      Numeric

      Reliable
      Required

      Length of appointment. In minutes

    • Visit.Reason

      String

      Probable

      Reason for appointment

    • Visit.Instructions[]

      Array of Strings

      Probable

      Appointment instructions

    • Visit.AttendingProvider.ID

      String

      Probable

      ID of the attending provider. This ID is required for Inpatient Visits

    • Visit.AttendingProvider.IDType

      String

      Probable

      ID type of the ID for the attending provider

    • Visit.AttendingProvider.FirstName

      String

      Possible

      First name of the attending provider

    • Visit.AttendingProvider.LastName

      String

      Possible

      Last name of the attending provider

    • Visit.AttendingProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the attending provider. e.g. MD, PhD

    • Visit.AttendingProvider.Address

      Object

      Possible

      Provider's address

    • Visit.AttendingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.AttendingProvider.Address.City

      String

      Possible

      City

    • Visit.AttendingProvider.Address.State

      String

      Possible

      State

    • Visit.AttendingProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.AttendingProvider.Address.County

      String

      Possible

      County

    • Visit.AttendingProvider.Address.Country

      String

      Possible

      Country

    • Visit.AttendingProvider.Location

      Object

      Possible

      Provider's location

    • Visit.AttendingProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.AttendingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.AttendingProvider.Location.Department

      String

      Possible

      Department

    • Visit.AttendingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.AttendingProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.ConsultingProvider.ID

      String

      Possible

      ID of the consulting provider. This ID is required for Inpatient Visits

    • Visit.ConsultingProvider.IDType

      String

      Possible

      ID type of the ID for the consulting provider

    • Visit.ConsultingProvider.FirstName

      String

      Possible

      First name of the consulting provider

    • Visit.ConsultingProvider.LastName

      String

      Possible

      Last name of the consulting provider

    • Visit.ConsultingProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the consulting provider. e.g. MD, PhD

    • Visit.ConsultingProvider.Address

      Object

      Possible

      Provider's address

    • Visit.ConsultingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.ConsultingProvider.Address.City

      String

      Possible

      City

    • Visit.ConsultingProvider.Address.State

      String

      Possible

      State

    • Visit.ConsultingProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.ConsultingProvider.Address.County

      String

      Possible

      County

    • Visit.ConsultingProvider.Address.Country

      String

      Possible

      Country

    • Visit.ConsultingProvider.Location

      Object

      Possible

      Provider's location

    • Visit.ConsultingProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.ConsultingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.ConsultingProvider.Location.Department

      String

      Possible

      Department

    • Visit.ConsultingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.ConsultingProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.ReferringProvider.ID

      String

      Possible

      ID of the referring provider. This ID is required for Inpatient Visits

    • Visit.ReferringProvider.IDType

      String

      Possible

      ID type of the ID for the referring provider

    • Visit.ReferringProvider.FirstName

      String

      Possible

      First name of the referring provider

    • Visit.ReferringProvider.LastName

      String

      Possible

      Last name of the referring provider

    • Visit.ReferringProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the referring provider. e.g. MD, PhD

    • Visit.ReferringProvider.Address

      Object

      Possible

      Provider's address

    • Visit.ReferringProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.ReferringProvider.Address.City

      String

      Possible

      City

    • Visit.ReferringProvider.Address.State

      String

      Possible

      State

    • Visit.ReferringProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.ReferringProvider.Address.County

      String

      Possible

      County

    • Visit.ReferringProvider.Address.Country

      String

      Possible

      Country

    • Visit.ReferringProvider.Location

      Object

      Possible

      Provider's location

    • Visit.ReferringProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.ReferringProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.ReferringProvider.Location.Department

      String

      Possible

      Department

    • Visit.ReferringProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.ReferringProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.VisitProvider.ID

      String

      Possible

      ID of the visit provider. This ID is required for Inpatient Visits

    • Visit.VisitProvider.IDType

      String

      Possible

      ID type of the ID for the visit provider

    • Visit.VisitProvider.FirstName

      String

      Possible

      First name of the visit provider

    • Visit.VisitProvider.LastName

      String

      Possible

      Last name of the visit provider

    • Visit.VisitProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the visit provider. e.g. MD, PhD

    • Visit.VisitProvider.Address

      Object

      Possible

      Provider's address

    • Visit.VisitProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.VisitProvider.Address.City

      String

      Possible

      City

    • Visit.VisitProvider.Address.State

      String

      Possible

      State

    • Visit.VisitProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.VisitProvider.Address.County

      String

      Possible

      County

    • Visit.VisitProvider.Address.Country

      String

      Possible

      Country

    • Visit.VisitProvider.Location

      Object

      Possible

      Provider's location

    • Visit.VisitProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.VisitProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.VisitProvider.Location.Department

      String

      Possible

      Department

    • Visit.VisitProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.VisitProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.Location

      Object

      Reliable

      Location of the appointment

    • Visit.Location.Type

      String

      Reliable

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.Location.Facility

      String

      Reliable

      Facility. Example: Community Hospital

    • Visit.Location.Department

      String

      Reliable
      Required

      Department

    • Visit.Location.Room

      String

      Reliable

      Room. Example: 136

    • Visit.Diagnoses[]

      Array of Objects

      Probable

      List of diagnoses associated with this visit

    • Visit.Diagnoses[].Code

      String

      Probable

      Code for the diagnosis

    • Visit.Diagnoses[].Codeset

      String

      Probable

      Code set used to identify the diagnosis. One of the following: ICD9, ICD10, HCPCS, CPT

    • Visit.Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Visit.Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

{
   "Meta": {
      "DataModel": "Scheduling",
      "EventType": "Modification",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Hickory Street",
            "City": "Monroe",
            "State": "WI",
            "ZIP": "53566",
            "County": "Green",
            "Country": "US"
         }
      },
      "Notes": []
   },
   "AppointmentInfo": [
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Priority",
         "Value": "Normal"
      },
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Form",
         "Value": "Lumbar"
      }
   ],
   "Visit": {
      "VisitNumber": "1234",
      "VisitDateTime": "2017-12-06T00:28:29.669Z",
      "PatientClass": null,
      "Status": null,
      "Duration": 30,
      "Reason": "Check up",
      "Instructions": [],
      "AttendingProvider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "ConsultingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "VisitProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "RES General Hospital",
         "Department": "3N",
         "Room": "136"
      },
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Pain in throat",
            "Type": null
         }
      ]
   }
}

Cancellink

A Cancel message is generated when an appointment is canceled. Visit.VisitNumber identifies the appointment being canceled.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. Cancel

    • Meta.Test

      Boolean

      Reliable

      Flag as a test message

    • Meta.Source

      String

      Reliable

      Where the message originated. Included in messages from Redox

    • Meta.Source.ID

      String

      Reliable

      ID of the source. UUID

    • Meta.Source.Name

      String

      Reliable

      Name of the source

    • Meta.Destinations[]

      Array of Objects

      Reliable

      List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination. Required when sending data to Redox

    • Meta.Destinations[].ID

      String

      Reliable

      ID of the destination. UUID

    • Meta.Destinations[].Name

      String

      Reliable

      Name of the destination

    • Meta.Message

      String

      Reliable

      Record in Redox that corresponds to the communication sent from the source to Redox. Included in messages from Redox

    • Meta.Message.ID

      Numeric

      Reliable

      ID of the message created in Redox

    • Meta.Transmission

      String

      Reliable

      Record in Redox that corresponds to the communication sent from Redox to your destination. Included in messages from Redox

    • Meta.Transmission.ID

      Numeric

      Reliable

      ID of the transmission created in Redox

    • Meta.FacilityCode

      String

      Possible

      Code for the facility related to the message. Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

  • Patient
    • Patient.Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the patient

    • Patient.Identifiers[].ID

      String

      Reliable

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Reliable

      Type of ID. E.g. MRN, EPI

    • Patient.Demographics.FirstName

      String

      Reliable

      Patient's first name

    • Patient.Demographics.MiddleName

      String

      Possible

      Patient'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

      Reliable

      Patient's last name

    • Patient.Demographics.DOB

      String

      Reliable

      Patient's date of birth. In ISO 8601 format

    • Patient.Demographics.SSN

      String

      Probable

      Patient's social security number

    • Patient.Demographics.Sex

      String

      Reliable

      Patient's sex. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • Patient.Demographics.IsDeceased

      Boolean

      Possible

      Indicates if the patient is deceased

    • Patient.Demographics.DeathDateTime

      DateTime

      Possible

      Date and Time the patient was proclaimed deceased. ISO 8601 Format

    • Patient.Demographics.PhoneNumber.Home

      String

      Probable

      Patient's home phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Office

      String

      Probable

      Patient's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Mobile

      String

      Probable

      Patient's mobile phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.EmailAddresses[]

      Array of Strings

      Probable

      Patient's email address(es)

    • Patient.Demographics.Language

      String

      Possible

      Patient's primary spoken language. In ISO 639-1 alpha values (e.g. 'en'). Supported Values

    • Patient.Demographics.Citizenship[]

      Array of strings

      Possible

      Patient's nation(s) of citizenship. *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.

      Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*

    • Patient.Demographics.Address

      Object

      Probable

      Patient's home address

    • Patient.Demographics.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.Demographics.Address.City

      String

      Probable

      City

    • Patient.Demographics.Address.State

      String

      Probable

      State

    • Patient.Demographics.Address.ZIP

      String

      Probable

      ZIP

    • Patient.Demographics.Address.County

      String

      Possible

      County

    • Patient.Demographics.Address.Country

      String

      Possible

      Country

    • Patient.Notes[]

      Array of strings

      Possible

      Patient-level notes

  • AppointmentInfo
    • AppointmentInfo[]

      Array of Objects

      Probable

      List of supplementary clinical information associated with the appointment

    • AppointmentInfo[].Code

      String

      Probable

      Code for the information element

    • AppointmentInfo[].Codeset

      String

      Probable

      Code set used to identify the information element. Codeset will be blank for system-defined codes. LOINC or other codesets may be used where appropriate.

    • AppointmentInfo[].Description

      String

      Probable

      Description of the information element. Additional information that may come from patient-completed forms or other sources

    • AppointmentInfo[].Value

      String

      Reliable

      The value of the corresponding Appointment Info code. For example, the code will identify the question being answered, and this property will contain the answer.

  • Visit
    • Visit.VisitNumber

      String

      Reliable
      Required

      Visit Number

    • Visit.VisitDateTime

      String

      Reliable
      Required

      DateTime of appointment. ISO 8601 Format

    • Visit.PatientClass

      String

      Probable

      Patient class is used in many EHRs to determine where to put the patient. Examples: Outpatient, Hosptial Outpatient Department

    • Visit.Status

      String

      Probable

      Status of the visit. One of the following: Scheduled, Arrived, Completed, Canceled, Left without being seen, No show

    • Visit.Duration

      Numeric

      Reliable

      Length of appointment. In minutes

    • Visit.Reason

      String

      Probable

      Reason for appointment

    • Visit.CancelReason

      String

      Possible

      Reason the visit was canceled

    • Visit.Instructions[]

      Array of Strings

      Probable

      Appointment instructions

    • Visit.AttendingProvider.ID

      String

      Probable

      ID of the attending provider. This ID is required for Inpatient Visits

    • Visit.AttendingProvider.IDType

      String

      Probable

      ID type of the ID for the attending provider

    • Visit.AttendingProvider.FirstName

      String

      Possible

      First name of the attending provider

    • Visit.AttendingProvider.LastName

      String

      Possible

      Last name of the attending provider

    • Visit.AttendingProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the attending provider. e.g. MD, PhD

    • Visit.AttendingProvider.Address

      Object

      Possible

      Provider's address

    • Visit.AttendingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.AttendingProvider.Address.City

      String

      Possible

      City

    • Visit.AttendingProvider.Address.State

      String

      Possible

      State

    • Visit.AttendingProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.AttendingProvider.Address.County

      String

      Possible

      County

    • Visit.AttendingProvider.Address.Country

      String

      Possible

      Country

    • Visit.AttendingProvider.Location

      Object

      Possible

      Provider's location

    • Visit.AttendingProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.AttendingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.AttendingProvider.Location.Department

      String

      Possible

      Department

    • Visit.AttendingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.AttendingProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.ConsultingProvider.ID

      String

      Possible

      ID of the consulting provider. This ID is required for Inpatient Visits

    • Visit.ConsultingProvider.IDType

      String

      Possible

      ID type of the ID for the consulting provider

    • Visit.ConsultingProvider.FirstName

      String

      Possible

      First name of the consulting provider

    • Visit.ConsultingProvider.LastName

      String

      Possible

      Last name of the consulting provider

    • Visit.ConsultingProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the consulting provider. e.g. MD, PhD

    • Visit.ConsultingProvider.Address

      Object

      Possible

      Provider's address

    • Visit.ConsultingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.ConsultingProvider.Address.City

      String

      Possible

      City

    • Visit.ConsultingProvider.Address.State

      String

      Possible

      State

    • Visit.ConsultingProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.ConsultingProvider.Address.County

      String

      Possible

      County

    • Visit.ConsultingProvider.Address.Country

      String

      Possible

      Country

    • Visit.ConsultingProvider.Location

      Object

      Possible

      Provider's location

    • Visit.ConsultingProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.ConsultingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.ConsultingProvider.Location.Department

      String

      Possible

      Department

    • Visit.ConsultingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.ConsultingProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.ReferringProvider.ID

      String

      Possible

      ID of the referring provider. This ID is required for Inpatient Visits

    • Visit.ReferringProvider.IDType

      String

      Possible

      ID type of the ID for the referring provider

    • Visit.ReferringProvider.FirstName

      String

      Possible

      First name of the referring provider

    • Visit.ReferringProvider.LastName

      String

      Possible

      Last name of the referring provider

    • Visit.ReferringProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the referring provider. e.g. MD, PhD

    • Visit.ReferringProvider.Address

      Object

      Possible

      Provider's address

    • Visit.ReferringProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.ReferringProvider.Address.City

      String

      Possible

      City

    • Visit.ReferringProvider.Address.State

      String

      Possible

      State

    • Visit.ReferringProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.ReferringProvider.Address.County

      String

      Possible

      County

    • Visit.ReferringProvider.Address.Country

      String

      Possible

      Country

    • Visit.ReferringProvider.Location

      Object

      Possible

      Provider's location

    • Visit.ReferringProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.ReferringProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.ReferringProvider.Location.Department

      String

      Possible

      Department

    • Visit.ReferringProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.ReferringProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.VisitProvider.ID

      String

      Possible

      ID of the visit provider. This ID is required for Inpatient Visits

    • Visit.VisitProvider.IDType

      String

      Possible

      ID type of the ID for the visit provider

    • Visit.VisitProvider.FirstName

      String

      Possible

      First name of the visit provider

    • Visit.VisitProvider.LastName

      String

      Possible

      Last name of the visit provider

    • Visit.VisitProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the visit provider. e.g. MD, PhD

    • Visit.VisitProvider.Address

      Object

      Possible

      Provider's address

    • Visit.VisitProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.VisitProvider.Address.City

      String

      Possible

      City

    • Visit.VisitProvider.Address.State

      String

      Possible

      State

    • Visit.VisitProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.VisitProvider.Address.County

      String

      Possible

      County

    • Visit.VisitProvider.Address.Country

      String

      Possible

      Country

    • Visit.VisitProvider.Location

      Object

      Possible

      Provider's location

    • Visit.VisitProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.VisitProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.VisitProvider.Location.Department

      String

      Possible

      Department

    • Visit.VisitProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.VisitProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.Location

      Object

      Reliable

      Location of the appointment

    • Visit.Location.Type

      String

      Reliable

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.Location.Facility

      String

      Reliable

      Facility. Example: Community Hospital

    • Visit.Location.Department

      String

      Reliable
      Required

      Department

    • Visit.Location.Room

      String

      Reliable

      Room. Example: 136

    • Visit.Diagnoses[]

      Array of Objects

      Probable

      List of diagnoses associated with this visit

    • Visit.Diagnoses[].Code

      String

      Probable

      Code for the diagnosis

    • Visit.Diagnoses[].Codeset

      String

      Probable

      Code set used to identify the diagnosis. One of the following: ICD9, ICD10, HCPCS, CPT

    • Visit.Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Visit.Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

{
   "Meta": {
      "DataModel": "Scheduling",
      "EventType": "Cancel",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Hickory Street",
            "City": "Monroe",
            "State": "WI",
            "ZIP": "53566",
            "County": "Green",
            "Country": "US"
         }
      },
      "Notes": []
   },
   "AppointmentInfo": [
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Priority",
         "Value": "Normal"
      },
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Form",
         "Value": "Lumbar"
      }
   ],
   "Visit": {
      "VisitNumber": "1234",
      "VisitDateTime": "2017-12-06T00:28:29.682Z",
      "PatientClass": null,
      "Status": null,
      "Duration": 15,
      "Reason": "Check up",
      "CancelReason": "Conflicting appointment",
      "Instructions": [],
      "AttendingProvider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "ConsultingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "VisitProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "RES General Hospital",
         "Department": "3N",
         "Room": "136"
      },
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Pain in throat",
            "Type": null
         }
      ]
   }
}

NoShowlink

A NoShow message is generated when a patient does not show up for the scheduled appointment.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. NoShow

    • Meta.Test

      Boolean

      Reliable

      Flag as a test message

    • Meta.Source

      String

      Reliable

      Where the message originated. Included in messages from Redox

    • Meta.Source.ID

      String

      Reliable

      ID of the source. UUID

    • Meta.Source.Name

      String

      Reliable

      Name of the source

    • Meta.Destinations[]

      Array of Objects

      Reliable

      List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination. Required when sending data to Redox

    • Meta.Destinations[].ID

      String

      Reliable

      ID of the destination. UUID

    • Meta.Destinations[].Name

      String

      Reliable

      Name of the destination

    • Meta.Message

      String

      Reliable

      Record in Redox that corresponds to the communication sent from the source to Redox. Included in messages from Redox

    • Meta.Message.ID

      Numeric

      Reliable

      ID of the message created in Redox

    • Meta.Transmission

      String

      Reliable

      Record in Redox that corresponds to the communication sent from Redox to your destination. Included in messages from Redox

    • Meta.Transmission.ID

      Numeric

      Reliable

      ID of the transmission created in Redox

    • Meta.FacilityCode

      String

      Possible

      Code for the facility related to the message. Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

  • Patient
    • Patient.Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the patient

    • Patient.Identifiers[].ID

      String

      Reliable

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Reliable

      Type of ID. E.g. MRN, EPI

    • Patient.Demographics.FirstName

      String

      Reliable

      Patient's first name

    • Patient.Demographics.MiddleName

      String

      Possible

      Patient'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

      Reliable

      Patient's last name

    • Patient.Demographics.DOB

      String

      Reliable

      Patient's date of birth. In ISO 8601 format

    • Patient.Demographics.SSN

      String

      Probable

      Patient's social security number

    • Patient.Demographics.Sex

      String

      Reliable

      Patient's sex. One of the following: Female, Male, Unknown, Other

    • Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • Patient.Demographics.IsDeceased

      Boolean

      Possible

      Indicates if the patient is deceased

    • Patient.Demographics.DeathDateTime

      DateTime

      Possible

      Date and Time the patient was proclaimed deceased. ISO 8601 Format

    • Patient.Demographics.PhoneNumber.Home

      String

      Probable

      Patient's home phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Office

      String

      Probable

      Patient's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.PhoneNumber.Mobile

      String

      Probable

      Patient's mobile phone number. In E. 164 Format. (e.g. +16085551234)

    • Patient.Demographics.EmailAddresses[]

      Array of Strings

      Probable

      Patient's email address(es)

    • Patient.Demographics.Language

      String

      Possible

      Patient's primary spoken language. In ISO 639-1 alpha values (e.g. 'en'). Supported Values

    • Patient.Demographics.Citizenship[]

      Array of strings

      Possible

      Patient's nation(s) of citizenship. *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.

      Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*

    • Patient.Demographics.Address

      Object

      Probable

      Patient's home address

    • Patient.Demographics.Address.StreetAddress

      String

      Probable

      Street address

    • Patient.Demographics.Address.City

      String

      Probable

      City

    • Patient.Demographics.Address.State

      String

      Probable

      State

    • Patient.Demographics.Address.ZIP

      String

      Probable

      ZIP

    • Patient.Demographics.Address.County

      String

      Possible

      County

    • Patient.Demographics.Address.Country

      String

      Possible

      Country

    • Patient.Notes[]

      Array of strings

      Possible

      Patient-level notes

  • AppointmentInfo
    • AppointmentInfo[]

      Array of Objects

      Probable

      List of supplementary clinical information associated with the appointment

    • AppointmentInfo[].Code

      String

      Probable

      Code for the information element

    • AppointmentInfo[].Codeset

      String

      Probable

      Code set used to identify the information element. Codeset will be blank for system-defined codes. LOINC or other codesets may be used where appropriate.

    • AppointmentInfo[].Description

      String

      Probable

      Description of the information element. Additional information that may come from patient-completed forms or other sources

    • AppointmentInfo[].Value

      String

      Reliable

      The value of the corresponding Appointment Info code. For example, the code will identify the question being answered, and this property will contain the answer.

  • Visit
    • Visit.VisitNumber

      String

      Reliable
      Required

      Visit Number

    • Visit.VisitDateTime

      String

      Reliable
      Required

      DateTime of appointment. ISO 8601 Format

    • Visit.PatientClass

      String

      Probable

      Patient class is used in many EHRs to determine where to put the patient. Examples: Outpatient, Hosptial Outpatient Department

    • Visit.Status

      String

      Probable

      Status of the visit. One of the following: Scheduled, Arrived, Completed, Canceled, Left without being seen, No show

    • Visit.Duration

      Numeric

      Reliable

      Length of appointment. In minutes

    • Visit.Reason

      String

      Probable

      Reason for appointment

    • Visit.NoShowReason

      String

      Possible

      Reason the patient did not show for the appointment

    • Visit.Instructions[]

      Array of Strings

      Probable

      Appointment instructions

    • Visit.AttendingProvider.ID

      String

      Probable

      ID of the attending provider. This ID is required for Inpatient Visits

    • Visit.AttendingProvider.IDType

      String

      Probable

      ID type of the ID for the attending provider

    • Visit.AttendingProvider.FirstName

      String

      Possible

      First name of the attending provider

    • Visit.AttendingProvider.LastName

      String

      Possible

      Last name of the attending provider

    • Visit.AttendingProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the attending provider. e.g. MD, PhD

    • Visit.AttendingProvider.Address

      Object

      Possible

      Provider's address

    • Visit.AttendingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.AttendingProvider.Address.City

      String

      Possible

      City

    • Visit.AttendingProvider.Address.State

      String

      Possible

      State

    • Visit.AttendingProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.AttendingProvider.Address.County

      String

      Possible

      County

    • Visit.AttendingProvider.Address.Country

      String

      Possible

      Country

    • Visit.AttendingProvider.Location

      Object

      Possible

      Provider's location

    • Visit.AttendingProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.AttendingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.AttendingProvider.Location.Department

      String

      Possible

      Department

    • Visit.AttendingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.AttendingProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.ConsultingProvider.ID

      String

      Possible

      ID of the consulting provider. This ID is required for Inpatient Visits

    • Visit.ConsultingProvider.IDType

      String

      Possible

      ID type of the ID for the consulting provider

    • Visit.ConsultingProvider.FirstName

      String

      Possible

      First name of the consulting provider

    • Visit.ConsultingProvider.LastName

      String

      Possible

      Last name of the consulting provider

    • Visit.ConsultingProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the consulting provider. e.g. MD, PhD

    • Visit.ConsultingProvider.Address

      Object

      Possible

      Provider's address

    • Visit.ConsultingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.ConsultingProvider.Address.City

      String

      Possible

      City

    • Visit.ConsultingProvider.Address.State

      String

      Possible

      State

    • Visit.ConsultingProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.ConsultingProvider.Address.County

      String

      Possible

      County

    • Visit.ConsultingProvider.Address.Country

      String

      Possible

      Country

    • Visit.ConsultingProvider.Location

      Object

      Possible

      Provider's location

    • Visit.ConsultingProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.ConsultingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.ConsultingProvider.Location.Department

      String

      Possible

      Department

    • Visit.ConsultingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.ConsultingProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.ReferringProvider.ID

      String

      Possible

      ID of the referring provider. This ID is required for Inpatient Visits

    • Visit.ReferringProvider.IDType

      String

      Possible

      ID type of the ID for the referring provider

    • Visit.ReferringProvider.FirstName

      String

      Possible

      First name of the referring provider

    • Visit.ReferringProvider.LastName

      String

      Possible

      Last name of the referring provider

    • Visit.ReferringProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the referring provider. e.g. MD, PhD

    • Visit.ReferringProvider.Address

      Object

      Possible

      Provider's address

    • Visit.ReferringProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.ReferringProvider.Address.City

      String

      Possible

      City

    • Visit.ReferringProvider.Address.State

      String

      Possible

      State

    • Visit.ReferringProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.ReferringProvider.Address.County

      String

      Possible

      County

    • Visit.ReferringProvider.Address.Country

      String

      Possible

      Country

    • Visit.ReferringProvider.Location

      Object

      Possible

      Provider's location

    • Visit.ReferringProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.ReferringProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.ReferringProvider.Location.Department

      String

      Possible

      Department

    • Visit.ReferringProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.ReferringProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.VisitProvider.ID

      String

      Possible

      ID of the visit provider. This ID is required for Inpatient Visits

    • Visit.VisitProvider.IDType

      String

      Possible

      ID type of the ID for the visit provider

    • Visit.VisitProvider.FirstName

      String

      Possible

      First name of the visit provider

    • Visit.VisitProvider.LastName

      String

      Possible

      Last name of the visit provider

    • Visit.VisitProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the visit provider. e.g. MD, PhD

    • Visit.VisitProvider.Address

      Object

      Possible

      Provider's address

    • Visit.VisitProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.VisitProvider.Address.City

      String

      Possible

      City

    • Visit.VisitProvider.Address.State

      String

      Possible

      State

    • Visit.VisitProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.VisitProvider.Address.County

      String

      Possible

      County

    • Visit.VisitProvider.Address.Country

      String

      Possible

      Country

    • Visit.VisitProvider.Location

      Object

      Possible

      Provider's location

    • Visit.VisitProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.VisitProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.VisitProvider.Location.Department

      String

      Possible

      Department

    • Visit.VisitProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.VisitProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.Location

      Object

      Reliable

      Location of the appointment

    • Visit.Location.Type

      String

      Reliable

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.Location.Facility

      String

      Reliable

      Facility. Example: Community Hospital

    • Visit.Location.Department

      String

      Reliable
      Required

      Department

    • Visit.Location.Room

      String

      Reliable

      Room. Example: 136

    • Visit.Diagnoses[]

      Array of Objects

      Probable

      List of diagnoses associated with this visit

    • Visit.Diagnoses[].Code

      String

      Probable

      Code for the diagnosis

    • Visit.Diagnoses[].Codeset

      String

      Probable

      Code set used to identify the diagnosis. One of the following: ICD9, ICD10, HCPCS, CPT

    • Visit.Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Visit.Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

{
   "Meta": {
      "DataModel": "Scheduling",
      "EventType": "NoShow",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "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": "Asian",
         "IsHispanic": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Hickory Street",
            "City": "Monroe",
            "State": "WI",
            "ZIP": "53566",
            "County": "Green",
            "Country": "US"
         }
      },
      "Notes": []
   },
   "AppointmentInfo": [
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Priority",
         "Value": "Normal"
      },
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Form",
         "Value": "Lumbar"
      }
   ],
   "Visit": {
      "VisitNumber": "1234",
      "VisitDateTime": "2017-12-06T00:28:29.696Z",
      "PatientClass": null,
      "Status": null,
      "Duration": 15,
      "Reason": "Check up",
      "NoShowReason": "Car broke down.",
      "Instructions": [],
      "AttendingProvider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "ConsultingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "VisitProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "RES General Hospital",
         "Department": "3N",
         "Room": "136"
      },
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Pain in throat",
            "Type": null
         }
      ]
   }
}

AvailableSlotsBETAlink

This query finds and returns times available for booking an appointment within a given time range. The response for this query is the AvailableSlotsResponse documented below.

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

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. E.g. New, Update

    • Meta.Test

      Boolean

      Reliable

      Flag as a test message

    • Meta.Source

      String

      Reliable

      Where the message originated. Included in messages from Redox

    • Meta.Source.ID

      String

      Reliable

      ID of the source. UUID

    • Meta.Source.Name

      String

      Reliable

      Name of the source

    • Meta.Destinations[]

      Array of Objects

      Reliable

      List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination. Required when sending data to Redox

    • Meta.Destinations[].ID

      String

      Reliable

      ID of the destination. UUID

    • Meta.Destinations[].Name

      String

      Reliable

      Name of the destination

    • Meta.Message

      String

      Reliable

      Record in Redox that corresponds to the communication sent from the source to Redox. Included in messages from Redox

    • Meta.Message.ID

      Numeric

      Reliable

      ID of the message created in Redox

    • Meta.Transmission

      String

      Reliable

      Record in Redox that corresponds to the communication sent from Redox to your destination. Included in messages from Redox

    • Meta.Transmission.ID

      Numeric

      Reliable

      ID of the transmission created in Redox

    • Meta.FacilityCode

      String

      Possible

      Code for the facility related to the message. Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

  • Patient
    • Patient.Identifiers[]

      Array of Objects

      Possible

      List of IDs and ID types that identify the patient

    • Patient.Identifiers[].ID

      String

      Possible

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Possible

      Type of ID. E.g. MRN, EPI

  • StartDateTime
    • StartDateTime

      String

      Reliable
      Required

      Start of the time range to search for appointments. ISO 8601 Format

  • EndDateTime
    • EndDateTime

      String

      Possible

      End of the time range to search for appointments. ISO 8601 Format

  • Visit
    • Visit.Reasons[]

      Array of Strings

      Reliable

      The appointment reasons to search for

    • Visit.AttendingProviders[].ID

      String

      Probable

      ID of the provider. This ID is required for Inpatient Visits

    • Visit.AttendingProviders[].IDType

      String

      Probable

      ID type of the ID for the provider

    • Visit.AttendingProviders[].FirstName

      String

      Possible

      First name of the provider

    • Visit.AttendingProviders[].LastName

      String

      Possible

      Last name of the provider

    • Visit.AttendingProviders[].Credentials[]

      Array of Strings

      Possible

      List of credentials for the provider. e.g. MD, PhD

    • Visit.AttendingProviders[].Address

      Object

      Possible

      Provider's address

    • Visit.AttendingProviders[].Address.StreetAddress

      String

      Possible

      Street address

    • Visit.AttendingProviders[].Address.City

      String

      Possible

      City

    • Visit.AttendingProviders[].Address.State

      String

      Possible

      State

    • Visit.AttendingProviders[].Address.ZIP

      String

      Possible

      ZIP

    • Visit.AttendingProviders[].Address.County

      String

      Possible

      County

    • Visit.AttendingProviders[].Address.Country

      String

      Possible

      Country

    • Visit.AttendingProviders[].Location

      Object

      Possible

      Provider's location

    • Visit.AttendingProviders[].Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.AttendingProviders[].Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.AttendingProviders[].Location.Department

      String

      Possible

      Department

    • Visit.AttendingProviders[].Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.AttendingProviders[].PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.Locations[]

      Object

      Probable

      Location of the appointment

    • Visit.Locations[].Type

      String

      Probable

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.Locations[].Facility

      String

      Probable

      Facility. Example: Community Hospital

    • Visit.Locations[].Department

      String

      Probable

      Department

    • Visit.Locations[].Room

      String

      Probable

      Room. Example: 136

{
   "Meta": {
      "DataModel": "Scheduling",
      "EventType": "AvailableSlots",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
            "IDType": "EHRID"
         },
         {
            "ID": "a1d4ee8aba494ca",
            "IDType": "NIST"
         }
      ]
   },
   "StartDateTime": "2017-12-06T00:28:29.700Z",
   "EndDateTime": null,
   "Visit": {
      "Reasons": [],
      "AttendingProviders": [],
      "Locations": []
   }
}

AvailableSlotsResponseBETAlink

This is the format of the response you will receive for a AvailableSlots query.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. E.g. New, Update

    • Meta.Test

      Boolean

      Reliable

      Flag as a test message

    • Meta.Source

      String

      Reliable

      Where the message originated. Included in messages from Redox

    • Meta.Source.ID

      String

      Reliable

      ID of the source. UUID

    • Meta.Source.Name

      String

      Reliable

      Name of the source

    • Meta.Destinations[]

      Array of Objects

      Reliable

      List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination. Required when sending data to Redox

    • Meta.Destinations[].ID

      String

      Reliable

      ID of the destination. UUID

    • Meta.Destinations[].Name

      String

      Reliable

      Name of the destination

    • Meta.Message

      String

      Reliable

      Record in Redox that corresponds to the communication sent from the source to Redox. Included in messages from Redox

    • Meta.Message.ID

      Numeric

      Reliable

      ID of the message created in Redox

    • Meta.Transmission

      String

      Reliable

      Record in Redox that corresponds to the communication sent from Redox to your destination. Included in messages from Redox

    • Meta.Transmission.ID

      Numeric

      Reliable

      ID of the transmission created in Redox

    • Meta.FacilityCode

      String

      Possible

      Code for the facility related to the message. Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

    • Meta.IsIncomplete

      Boolean

      Reliable

      Indicates that a limit was reached, and not all data was returned. If true, the sender may want to restrict the parameters of the request in order to match fewer results.

  • AvailableSlots
    • AvailableSlots[].ID

      Numeric

      Probable

      The ID of the appointment slot

    • AvailableSlots[].DateTime

      String

      Reliable
      Required

      The DateTime of the appointment slot. ISO 8601 Format

    • AvailableSlots[].Reason

      String

      Reliable

      The visit reason of the appointment slot

    • AvailableSlots[].Duration

      Numeric

      Reliable
      Required

      Length of appointment. In minutes

    • AvailableSlots[].Provider.ID

      String

      Reliable

      ID of the provider. This ID is required for Inpatient Visits

    • AvailableSlots[].Provider.IDType

      String

      Reliable

      ID type of the ID for the provider

    • AvailableSlots[].Provider.FirstName

      String

      Possible

      First name of the provider

    • AvailableSlots[].Provider.LastName

      String

      Possible

      Last name of the provider

    • AvailableSlots[].Provider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the provider. e.g. MD, PhD

    • AvailableSlots[].Provider.Address

      Object

      Possible

      Provider's address

    • AvailableSlots[].Provider.Address.StreetAddress

      String

      Possible

      Street address

    • AvailableSlots[].Provider.Address.City

      String

      Possible

      City

    • AvailableSlots[].Provider.Address.State

      String

      Possible

      State

    • AvailableSlots[].Provider.Address.ZIP

      String

      Possible

      ZIP

    • AvailableSlots[].Provider.Address.County

      String

      Possible

      County

    • AvailableSlots[].Provider.Address.Country

      String

      Possible

      Country

    • AvailableSlots[].Provider.Location

      Object

      Possible

      Provider's location

    • AvailableSlots[].Provider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • AvailableSlots[].Provider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • AvailableSlots[].Provider.Location.Department

      String

      Possible

      Department

    • AvailableSlots[].Provider.Location.Room

      String

      Possible

      Room. Example: 136

    • AvailableSlots[].Provider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • AvailableSlots[].Location

      Object

      Reliable

      Location of the appointment

    • AvailableSlots[].Location.Type

      String

      Reliable

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • AvailableSlots[].Location.Facility

      String

      Reliable

      Facility. Example: Community Hospital

    • AvailableSlots[].Location.Department

      String

      Reliable

      Department

    • AvailableSlots[].Location.Room

      String

      Reliable

      Room. Example: 136

    • AvailableSlots[].Notes[]

      Array of strings

      Possible

      Additional notes about this slot

{
   "Meta": {
      "DataModel": "Scheduling",
      "EventType": "AvailableSlotsResponse",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null,
      "IsIncomplete": false
   },
   "AvailableSlots": [
      {
         "ID": null,
         "DateTime": "Mon Aug 01 2016 14:00:00 GMT-0500 (CDT)",
         "Reason": "Follow Up",
         "Duration": "15",
         "Provider": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Pat",
            "LastName": "Granite",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "123 Main St.",
               "City": "Madison",
               "State": "WI",
               "ZIP": "53703",
               "County": "Dane",
               "Country": "USA"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+16085551234"
            }
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": "Clinic A",
            "Room": null
         },
         "Notes": []
      },
      {
         "ID": null,
         "DateTime": "Mon Aug 01 2016 15:00:00 GMT-0500 (CDT)",
         "Reason": "Follow Up",
         "Duration": "15",
         "Provider": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Pat",
            "LastName": "Granite",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "123 Main St.",
               "City": "Madison",
               "State": "WI",
               "ZIP": "53703",
               "County": "Dane",
               "Country": "USA"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+16085551234"
            }
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": "Clinic A",
            "Room": null
         },
         "Notes": []
      },
      {
         "ID": null,
         "DateTime": "Mon Aug 01 2016 16:00:00 GMT-0500 (CDT)",
         "Reason": "Follow Up",
         "Duration": "15",
         "Provider": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Pat",
            "LastName": "Granite",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "123 Main St.",
               "City": "Madison",
               "State": "WI",
               "ZIP": "53703",
               "County": "Dane",
               "Country": "USA"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+16085551234"
            }
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": "Clinic A",
            "Room": null
         },
         "Notes": []
      },
      {
         "ID": null,
         "DateTime": "Mon Aug 01 2016 17:00:00 GMT-0500 (CDT)",
         "Reason": "Follow Up",
         "Duration": "15",
         "Provider": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Pat",
            "LastName": "Granite",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "123 Main St.",
               "City": "Madison",
               "State": "WI",
               "ZIP": "53703",
               "County": "Dane",
               "Country": "USA"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+16085551234"
            }
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": "Clinic A",
            "Room": null
         },
         "Notes": []
      }
   ]
}

Bookedlink

This query finds and returns booked appointments within a given time range. The response for this query is the BookedResponse documented below.

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

This endpoint is available for use in most integrations through the Redox Data Chateau.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. E.g. New, Update

    • Meta.Test

      Boolean

      Reliable

      Flag as a test message

    • Meta.Source

      String

      Reliable

      Where the message originated. Included in messages from Redox

    • Meta.Source.ID

      String

      Reliable

      ID of the source. UUID

    • Meta.Source.Name

      String

      Reliable

      Name of the source

    • Meta.Destinations[]

      Array of Objects

      Reliable

      List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination. Required when sending data to Redox

    • Meta.Destinations[].ID

      String

      Reliable

      ID of the destination. UUID

    • Meta.Destinations[].Name

      String

      Reliable

      Name of the destination

    • Meta.Message

      String

      Reliable

      Record in Redox that corresponds to the communication sent from the source to Redox. Included in messages from Redox

    • Meta.Message.ID

      Numeric

      Reliable

      ID of the message created in Redox

    • Meta.Transmission

      String

      Reliable

      Record in Redox that corresponds to the communication sent from Redox to your destination. Included in messages from Redox

    • Meta.Transmission.ID

      Numeric

      Reliable

      ID of the transmission created in Redox

    • Meta.FacilityCode

      String

      Possible

      Code for the facility related to the message. Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

  • StartDateTime
    • StartDateTime

      String

      Reliable
      Required

      Start of the time range to search for appointments. ISO 8601 Format

  • EndDateTime
    • EndDateTime

      String

      Possible

      End of the time range to search for appointments. ISO 8601 Format

  • Visit
    • Visit.Reason

      Array of Strings

      Reliable

      The appointment reason to search for

    • Visit.AttendingProviders[].ID

      String

      Probable

      ID of the provider. This ID is required for Inpatient Visits

    • Visit.AttendingProviders[].IDType

      String

      Probable

      ID type of the ID for the provider

    • Visit.AttendingProviders[].FirstName

      String

      Possible

      First name of the provider

    • Visit.AttendingProviders[].LastName

      String

      Possible

      Last name of the provider

    • Visit.AttendingProviders[].Credentials[]

      Array of Strings

      Possible

      List of credentials for the provider. e.g. MD, PhD

    • Visit.AttendingProviders[].Address

      Object

      Possible

      Provider's address

    • Visit.AttendingProviders[].Address.StreetAddress

      String

      Possible

      Street address

    • Visit.AttendingProviders[].Address.City

      String

      Possible

      City

    • Visit.AttendingProviders[].Address.State

      String

      Possible

      State

    • Visit.AttendingProviders[].Address.ZIP

      String

      Possible

      ZIP

    • Visit.AttendingProviders[].Address.County

      String

      Possible

      County

    • Visit.AttendingProviders[].Address.Country

      String

      Possible

      Country

    • Visit.AttendingProviders[].Location

      Object

      Possible

      Provider's location

    • Visit.AttendingProviders[].Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.AttendingProviders[].Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.AttendingProviders[].Location.Department

      String

      Possible

      Department

    • Visit.AttendingProviders[].Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.AttendingProviders[].PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.VisitProvider.ID

      String

      Possible

      ID of the visit provider. This ID is required for Inpatient Visits

    • Visit.VisitProvider.IDType

      String

      Possible

      ID type of the ID for the visit provider

    • Visit.VisitProvider.FirstName

      String

      Possible

      First name of the visit provider

    • Visit.VisitProvider.LastName

      String

      Possible

      Last name of the visit provider

    • Visit.VisitProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the visit provider. e.g. MD, PhD

    • Visit.VisitProvider.Address

      Object

      Possible

      Provider's address

    • Visit.VisitProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visit.VisitProvider.Address.City

      String

      Possible

      City

    • Visit.VisitProvider.Address.State

      String

      Possible

      State

    • Visit.VisitProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visit.VisitProvider.Address.County

      String

      Possible

      County

    • Visit.VisitProvider.Address.Country

      String

      Possible

      Country

    • Visit.VisitProvider.Location

      Object

      Possible

      Provider's location

    • Visit.VisitProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.VisitProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visit.VisitProvider.Location.Department

      String

      Possible

      Department

    • Visit.VisitProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visit.VisitProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visit.Location

      Object

      Probable

      Location of the appointment

    • Visit.Location.Type

      String

      Probable

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visit.Location.Facility

      String

      Probable

      Facility. Example: Community Hospital

    • Visit.Location.Department

      String

      Probable

      Department

    • Visit.Location.Room

      String

      Probable

      Room. Example: 136

    • Visit.Patients[]

      Array of Objects

      Probable

      Patient(s) for the appointment

    • Visit.Patients[].Identifiers[]

      Array of Objects

      Probable

      List of IDs and ID types that identify the patient

    • Visit.Patients[].Identifiers[].ID

      String

      Probable

      ID for the patient

    • Visit.Patients[].Identifiers[].IDType

      String

      Probable

      Type of ID. E.g. MRN, EPI

{
   "Meta": {
      "DataModel": "Scheduling",
      "EventType": "Booked",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "FacilityCode": null
   },
   "StartDateTime": "2017-12-06T00:28:29.708Z",
   "EndDateTime": null,
   "Visit": {
      "Reason": null,
      "AttendingProviders": [
         {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Pat",
            "LastName": "Granite",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "123 Main St.",
               "City": "Madison",
               "State": "WI",
               "ZIP": "53703",
               "County": "Dane",
               "Country": "USA"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+16085551234"
            }
         }
      ],
      "VisitProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": null
         }
      },
      "Location": {
         "Type": null,
         "Facility": null,
         "Department": null,
         "Room": null
      },
      "Patients": [
         {
            "Identifiers": [
               {
                  "ID": "0000000001",
                  "IDType": "MR"
               },
               {
                  "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
                  "IDType": "EHRID"
               },
               {
                  "ID": "a1d4ee8aba494ca",
                  "IDType": "NIST"
               }
            ]
         }
      ]
   }
}

BookedResponselink

This is the format of the response you will receive for a Booked query.

Fields

  • Meta
    • Meta.DataModel

      String

      Reliable
      Required

      Data model. E.g. Scheduling, Results

    • Meta.EventType

      String

      Reliable
      Required

      Type of event. E.g. New, Update

    • Meta.Test

      Boolean

      Reliable

      Flag as a test message

    • Meta.Source

      String

      Reliable

      Where the message originated. Included in messages from Redox

    • Meta.Source.ID

      String

      Reliable

      ID of the source. UUID

    • Meta.Source.Name

      String

      Reliable

      Name of the source

    • Meta.Destinations[]

      Array of Objects

      Reliable

      List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination. Required when sending data to Redox

    • Meta.Destinations[].ID

      String

      Reliable

      ID of the destination. UUID

    • Meta.Destinations[].Name

      String

      Reliable

      Name of the destination

    • Meta.Message

      String

      Reliable

      Record in Redox that corresponds to the communication sent from the source to Redox. Included in messages from Redox

    • Meta.Message.ID

      Numeric

      Reliable

      ID of the message created in Redox

    • Meta.Transmission

      String

      Reliable

      Record in Redox that corresponds to the communication sent from Redox to your destination. Included in messages from Redox

    • Meta.Transmission.ID

      Numeric

      Reliable

      ID of the transmission created in Redox

    • Meta.FacilityCode

      String

      Possible

      Code for the facility related to the message. Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

    • Meta.IsIncomplete

      Boolean

      Reliable

      Indicates that a limit was reached, and not all data was returned. If true, the sender may want to restrict the parameters of the request in order to match fewer results.

  • Visits
    • Visits[].VisitNumber

      String

      Reliable
      Required

      Visit Number

    • Visits[].VisitDateTime

      String

      Reliable
      Required

      DateTime of appointment. ISO 8601 Format

    • Visits[].PatientClass

      String

      Probable

      Patient class is used in many EHRs to determine where to put the patient. Examples: Outpatient, Hosptial Outpatient Department

    • Visits[].Status

      String

      Probable

      Status of the visit. One of the following: Scheduled, Arrived, Completed, Canceled, Left without being seen, No show

    • Visits[].Duration

      Numeric

      Reliable
      Required

      Length of appointment. In minutes

    • Visits[].Reason

      String

      Probable

      Reason for appointment

    • Visits[].CancelReason

      String

      Possible

      Reason the visit was canceled

    • Visits[].LastUpdated

      DateTime

      Probable

      DateTime when the appointment was last modified. ISO 8601 Format

    • Visits[].ScheduledDateTime

      DateTime

      Possible

      DateTime when the visit was scheduled. ISO 8601 Format

    • Visits[].CancelDateTime

      DateTime

      Possible

      DateTime when the visit was canceled. ISO 8601 Format

    • Visits[].Instructions[]

      Array of Strings

      Probable

      Appointment instructions

    • Visits[].AttendingProvider.ID

      String

      Probable

      ID of the attending provider. This ID is required for Inpatient Visits

    • Visits[].AttendingProvider.IDType

      String

      Probable

      ID type of the ID for the attending provider

    • Visits[].AttendingProvider.FirstName

      String

      Possible

      First name of the attending provider

    • Visits[].AttendingProvider.LastName

      String

      Possible

      Last name of the attending provider

    • Visits[].AttendingProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the attending provider. e.g. MD, PhD

    • Visits[].AttendingProvider.Address

      Object

      Possible

      Provider's address

    • Visits[].AttendingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visits[].AttendingProvider.Address.City

      String

      Possible

      City

    • Visits[].AttendingProvider.Address.State

      String

      Possible

      State

    • Visits[].AttendingProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visits[].AttendingProvider.Address.County

      String

      Possible

      County

    • Visits[].AttendingProvider.Address.Country

      String

      Possible

      Country

    • Visits[].AttendingProvider.Location

      Object

      Possible

      Provider's location

    • Visits[].AttendingProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visits[].AttendingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visits[].AttendingProvider.Location.Department

      String

      Possible

      Department

    • Visits[].AttendingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visits[].AttendingProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visits[].ConsultingProvider.ID

      String

      Possible

      ID of the consulting provider. This ID is required for Inpatient Visits

    • Visits[].ConsultingProvider.IDType

      String

      Possible

      ID type of the ID for the consulting provider

    • Visits[].ConsultingProvider.FirstName

      String

      Possible

      First name of the consulting provider

    • Visits[].ConsultingProvider.LastName

      String

      Possible

      Last name of the consulting provider

    • Visits[].ConsultingProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the consulting provider. e.g. MD, PhD

    • Visits[].ConsultingProvider.Address

      Object

      Possible

      Provider's address

    • Visits[].ConsultingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visits[].ConsultingProvider.Address.City

      String

      Possible

      City

    • Visits[].ConsultingProvider.Address.State

      String

      Possible

      State

    • Visits[].ConsultingProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visits[].ConsultingProvider.Address.County

      String

      Possible

      County

    • Visits[].ConsultingProvider.Address.Country

      String

      Possible

      Country

    • Visits[].ConsultingProvider.Location

      Object

      Possible

      Provider's location

    • Visits[].ConsultingProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visits[].ConsultingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visits[].ConsultingProvider.Location.Department

      String

      Possible

      Department

    • Visits[].ConsultingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visits[].ConsultingProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visits[].ReferringProvider.ID

      String

      Possible

      ID of the referring provider. This ID is required for Inpatient Visits

    • Visits[].ReferringProvider.IDType

      String

      Possible

      ID type of the ID for the referring provider

    • Visits[].ReferringProvider.FirstName

      String

      Possible

      First name of the referring provider

    • Visits[].ReferringProvider.LastName

      String

      Possible

      Last name of the referring provider

    • Visits[].ReferringProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the referring provider. e.g. MD, PhD

    • Visits[].ReferringProvider.Address

      Object

      Possible

      Provider's address

    • Visits[].ReferringProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visits[].ReferringProvider.Address.City

      String

      Possible

      City

    • Visits[].ReferringProvider.Address.State

      String

      Possible

      State

    • Visits[].ReferringProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visits[].ReferringProvider.Address.County

      String

      Possible

      County

    • Visits[].ReferringProvider.Address.Country

      String

      Possible

      Country

    • Visits[].ReferringProvider.Location

      Object

      Possible

      Provider's location

    • Visits[].ReferringProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visits[].ReferringProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visits[].ReferringProvider.Location.Department

      String

      Possible

      Department

    • Visits[].ReferringProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visits[].ReferringProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visits[].VisitProvider.ID

      String

      Possible

      ID of the visit provider. This ID is required for Inpatient Visits

    • Visits[].VisitProvider.IDType

      String

      Possible

      ID type of the ID for the visit provider

    • Visits[].VisitProvider.FirstName

      String

      Possible

      First name of the visit provider

    • Visits[].VisitProvider.LastName

      String

      Possible

      Last name of the visit provider

    • Visits[].VisitProvider.Credentials[]

      Array of Strings

      Possible

      List of credentials for the visit provider. e.g. MD, PhD

    • Visits[].VisitProvider.Address

      Object

      Possible

      Provider's address

    • Visits[].VisitProvider.Address.StreetAddress

      String

      Possible

      Street address

    • Visits[].VisitProvider.Address.City

      String

      Possible

      City

    • Visits[].VisitProvider.Address.State

      String

      Possible

      State

    • Visits[].VisitProvider.Address.ZIP

      String

      Possible

      ZIP

    • Visits[].VisitProvider.Address.County

      String

      Possible

      County

    • Visits[].VisitProvider.Address.Country

      String

      Possible

      Country

    • Visits[].VisitProvider.Location

      Object

      Possible

      Provider's location

    • Visits[].VisitProvider.Location.Type

      String

      Possible

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visits[].VisitProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • Visits[].VisitProvider.Location.Department

      String

      Possible

      Department

    • Visits[].VisitProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • Visits[].VisitProvider.PhoneNumber.Office

      String

      Possible

      Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visits[].Location

      Object

      Reliable

      Location of the appointment

    • Visits[].Location.Type

      String

      Reliable

      Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

    • Visits[].Location.Facility

      String

      Reliable

      Facility. Example: Community Hospital

    • Visits[].Location.Department

      String

      Reliable
      Required

      Department

    • Visits[].Location.Room

      String

      Reliable

      Room. Example: 136

    • Visits[].Diagnoses[]

      Array of Objects

      Probable

      List of diagnoses associated with this visit

    • Visits[].Diagnoses[].Code

      String

      Probable

      Code for the diagnosis

    • Visits[].Diagnoses[].Codeset

      String

      Probable

      Code set used to identify the diagnosis. One of the following: ICD9, ICD10, HCPCS, CPT

    • Visits[].Diagnoses[].Name

      String

      Probable

      Name of the diagnosis

    • Visits[].Diagnoses[].Type

      String

      Possible

      List of diagnoses associated with this visit. One of the following: Admitting, Working, or Final

    • Visits[].Patient.Identifiers[]

      Array of Objects

      Reliable

      List of IDs and ID types that identify the patient

    • Visits[].Patient.Identifiers[].ID

      String

      Reliable
      Required

      ID for the patient

    • Visits[].Patient.Identifiers[].IDType

      String

      Reliable
      Required

      Type of ID. E.g. MRN, EPI

    • Visits[].Patient.Demographics.FirstName

      String

      Reliable

      Patient's first name

    • Visits[].Patient.Demographics.MiddleName

      String

      Possible

      Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.

    • Visits[].Patient.Demographics.LastName

      String

      Reliable

      Patient's last name

    • Visits[].Patient.Demographics.DOB

      String

      Reliable

      Patient's date of birth. In ISO 8601 format

    • Visits[].Patient.Demographics.SSN

      String

      Probable

      Patient's social security number

    • Visits[].Patient.Demographics.Sex

      String

      Reliable

      Patient's sex. One of the following: Female, Male, Unknown, Other

    • Visits[].Patient.Demographics.Race

      String

      Possible

      Patient's race. Supported Values

    • Visits[].Patient.Demographics.IsHispanic

      Boolean

      Possible

      Indicates if the patient is of hispanic origin.

    • Visits[].Patient.Demographics.MaritalStatus

      String

      Possible

      Patient's marital status. Supported Values

    • Visits[].Patient.Demographics.IsDeceased

      Boolean

      Possible

      Indicates if the patient is deceased

    • Visits[].Patient.Demographics.DeathDateTime

      DateTime

      Possible

      Date and Time the patient was proclaimed deceased. ISO 8601 Format

    • Visits[].Patient.Demographics.PhoneNumber.Home

      String

      Probable

      Patient's home phone number. In E. 164 Format. (e.g. +16085551234)

    • Visits[].Patient.Demographics.PhoneNumber.Office

      String

      Probable

      Patient's office phone number. In E. 164 Format. (e.g. +16085551234)

    • Visits[].Patient.Demographics.PhoneNumber.Mobile

      String

      Probable

      Patient's mobile phone number. In E. 164 Format. (e.g. +16085551234)

    • Visits[].Patient.Demographics.EmailAddresses[]

      Array of Strings

      Probable

      Patient's email address(es)

    • Visits[].Patient.Demographics.Language

      String

      Possible

      Patient's primary spoken language. In ISO 639-1 alpha values (e.g. 'en'). Supported Values

    • Visits[].Patient.Demographics.Citizenship[]

      Array of strings

      Possible

      Patient's nation(s) of citizenship. *In ISO 3166 alpha 2 format (e.g. 'US'). Reference Table.

      Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*

    • Visits[].Patient.Demographics.Address

      Object

      Probable

      Patient's home address

    • Visits[].Patient.Demographics.Address.StreetAddress

      String

      Probable

      Street address

    • Visits[].Patient.Demographics.Address.City

      String

      Probable

      City

    • Visits[].Patient.Demographics.Address.State

      String

      Probable

      State

    • Visits[].Patient.Demographics.Address.ZIP

      String

      Probable

      ZIP

    • Visits[].Patient.Demographics.Address.County

      String

      Possible

      County

    • Visits[].Patient.Demographics.Address.Country

      String

      Possible

      Country

    • Visits[].Patient.Notes[]

      Array of strings

      Possible

      Patient-level notes

    • Visits[].AppointmentInfo[]

      Array of Objects

      Possible

      List of supplementary clinical information associated with the appointment

    • Visits[].AppointmentInfo[].Code

      String

      Possible

      Code for the information element

    • Visits[].AppointmentInfo[].Codeset

      String

      Possible

      Code set used to identify the information element. Codeset will be blank for system-defined codes. LOINC or other codesets may be used where appropriate.

    • Visits[].AppointmentInfo[].Description

      String

      Possible

      Description of the information element. Additional information that may come from patient-completed forms or other sources

    • Visits[].AppointmentInfo[].Value

      String

      Possible

      The value of the corresponding Appointment Info code. For example, the code will identify the question being answered, and this property will contain the answer.

{
   "Meta": {
      "DataModel": "Scheduling",
      "EventType": "BookedResponse",
      "EventDateTime": "2017-12-06T00:28:28.775Z",
      "Test": true,
      "Source": {
         "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
         "Name": "Redox Dev Tools"
      },
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null,
      "IsIncomplete": false
   },
   "Visits": [
      {
         "VisitNumber": "1234",
         "VisitDateTime": "Mon Aug 01 2016 14:00:00 GMT-0500 (CDT)",
         "PatientClass": null,
         "Status": null,
         "Duration": "15",
         "Reason": "Follow Up",
         "CancelReason": "Conflicting appointment",
         "LastUpdated": null,
         "ScheduledDateTime": null,
         "CancelDateTime": null,
         "Instructions": [],
         "AttendingProvider": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Pat",
            "LastName": "Granite",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "123 Main St.",
               "City": "Madison",
               "State": "WI",
               "ZIP": "53703",
               "County": "Dane",
               "Country": "USA"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+16085551234"
            }
         },
         "ConsultingProvider": {
            "ID": null,
            "IDType": null,
            "FirstName": null,
            "LastName": null,
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": null
            }
         },
         "ReferringProvider": {
            "ID": null,
            "IDType": null,
            "FirstName": null,
            "LastName": null,
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": null
            }
         },
         "VisitProvider": {
            "ID": null,
            "IDType": null,
            "FirstName": null,
            "LastName": null,
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": null
            }
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": "Clinic A",
            "Room": null
         },
         "Diagnoses": [],
         "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": "Asian",
               "IsHispanic": null,
               "MaritalStatus": "Single",
               "IsDeceased": null,
               "DeathDateTime": null,
               "PhoneNumber": {
                  "Home": "+18088675301",
                  "Office": null,
                  "Mobile": null
               },
               "EmailAddresses": [],
               "Language": "en",
               "Citizenship": [],
               "Address": {
                  "StreetAddress": "4762 Hickory Street",
                  "City": "Monroe",
                  "State": "WI",
                  "ZIP": "53566",
                  "County": "Green",
                  "Country": "US"
               }
            },
            "Notes": []
         },
         "AppointmentInfo": []
      },
      {
         "VisitNumber": "1235",
         "VisitDateTime": "Mon Aug 01 2016 15:00:00 GMT-0500 (CDT)",
         "PatientClass": null,
         "Status": null,
         "Duration": "15",
         "Reason": "Follow Up",
         "CancelReason": null,
         "LastUpdated": null,
         "ScheduledDateTime": null,
         "CancelDateTime": null,
         "Instructions": [],
         "AttendingProvider": {
            "ID": "4236464757",
            "IDType": "NPI",
            "FirstName": "John",
            "LastName": "Slate",
            "Credentials": [
               "DO"
            ],
            "Address": {
               "StreetAddress": "500 First St.",
               "City": "Clayton",
               "State": "MO",
               "ZIP": "63105",
               "County": "Saint Louis",
               "Country": "USA"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+13145554321"
            }
         },
         "ConsultingProvider": {
            "ID": null,
            "IDType": null,
            "FirstName": null,
            "LastName": null,
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": null
            }
         },
         "ReferringProvider": {
            "ID": null,
            "IDType": null,
            "FirstName": null,
            "LastName": null,
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": null
            }
         },
         "VisitProvider": {
            "ID": null,
            "IDType": null,
            "FirstName": null,
            "LastName": null,
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": null
            }
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": "Clinic A",
            "Room": null
         },
         "Diagnoses": [],
         "Patient": {
            "Identifiers": [
               {
                  "ID": "0000000002",
                  "IDType": "MR"
               },
               {
                  "ID": "81ac9647-3a07-46b7-85b4-c5d09099fb3b",
                  "IDType": "EHRID"
               },
               {
                  "ID": "ffc486eff2b04b8^^^&1.3.6.1.4.1.21367.2005.13.20.1000&ISO",
                  "IDType": "NIST"
               }
            ],
            "Demographics": {
               "FirstName": "Barbara",
               "MiddleName": null,
               "LastName": "Bixby",
               "DOB": "1982-07-24",
               "SSN": "202-02-0002",
               "Sex": "Female",
               "Race": "White",
               "IsHispanic": null,
               "MaritalStatus": "Married",
               "IsDeceased": null,
               "DeathDateTime": null,
               "PhoneNumber": {
                  "Home": "+18088675303",
                  "Office": "+17077543758",
                  "Mobile": "+19189368865"
               },
               "EmailAddresses": [
                  "barb.bixby@test.net"
               ],
               "Language": "en",
               "Citizenship": [],
               "Address": {
                  "StreetAddress": "4762 Hickory Street",
                  "City": "Monroe",
                  "State": "WI",
                  "ZIP": "53566",
                  "County": "Green",
                  "Country": "US"
               }
            },
            "Notes": []
         },
         "AppointmentInfo": []
      },
      {
         "VisitNumber": "1236",
         "VisitDateTime": "Mon Aug 01 2016 16:00:00 GMT-0500 (CDT)",
         "PatientClass": null,
         "Status": null,
         "Duration": "15",
         "Reason": "Follow Up",
         "CancelReason": null,
         "LastUpdated": null,
         "ScheduledDateTime": null,
         "CancelDateTime": null,
         "Instructions": [],
         "AttendingProvider": {
            "ID": "2434534567",
            "IDType": "NPI",
            "FirstName": "Sharon",
            "LastName": "Chalk",
            "Credentials": [
               "MD",
               "PhD"
            ],
            "Address": {
               "StreetAddress": "312 Maple Dr. Suite 400",
               "City": "Verona",
               "State": "WI",
               "ZIP": "53593",
               "County": "Dane",
               "Country": "USA"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": "+16085559999"
            }
         },
         "ConsultingProvider": {
            "ID": null,
            "IDType": null,
            "FirstName": null,
            "LastName": null,
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": null
            }
         },
         "ReferringProvider": {
            "ID": null,
            "IDType": null,
            "FirstName": null,
            "LastName": null,
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": null
            }
         },
         "VisitProvider": {
            "ID": null,
            "IDType": null,
            "FirstName": null,
            "LastName": null,
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            },
            "PhoneNumber": {
               "Office": null
            }
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": "Clinic A",
            "Room": null
         },
         "Diagnoses": [],
         "Patient": {
            "Identifiers": [
               {
                  "ID": "0000000003",
                  "IDType": "MR"
               },
               {
                  "ID": "e3fedf48-c8bf-4728-845f-cb810001b571",
                  "IDType": "EHRID"
               },
               {
                  "ID": "ef05d4068ee144f^^^&1.3.6.1.4.1.21367.2005.13.20.1000&ISO",
                  "IDType": "NIST"
               }
            ],
            "Demographics": {
               "FirstName": "Walter",
               "MiddleName": null,
               "LastName": "Carthwright",
               "DOB": "1945-03-04",
               "SSN": "303-03-0003",
               "Sex": "Male",
               "Race": "Black",
               "IsHispanic": true,
               "MaritalStatus": "Widowed",
               "IsDeceased": null,
               "DeathDateTime": null,
               "PhoneNumber": {
                  "Home": "+18088675310",
                  "Office": null,
                  "Mobile": null
               },
               "EmailAddresses": [
                  "wc1945@test.net"
               ],
               "Language": "es",
               "Citizenship": [],
               "Address": {
                  "StreetAddress": "648 Ethan Terrace",
                  "City": "Agoura Hills",
                  "State": "CA",
                  "ZIP": "91301",
                  "County": "Los Angelas",
                  "Country": "US"
               }
            },
            "Notes": []
         },
         "AppointmentInfo": []
      }
   ]
}