SurgicalScheduling

Surgical Scheduling is a special subset of scheduling messages dedicated to the scheduling and modification of surgical cases at the health system.The events are very similar to Scheduling data model but additinal information is communicated via key value pairs (SurgicalInfo in the data model).The additional information may contain questionaire answers from the patient, specific equipment requirements for the procedure, or in-progress notes about the surgery.

Newlink

A New message is generated when an appointment is booked in the EHR.

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
      Required

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Reliable
      Required

      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

  • Procedures
    • Procedures[]

      Array of Objects

      Probable

      Array of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.

    • Procedures[].Code

      String

      Probable

      Code for the service

    • Procedures[].Codeset

      String

      Probable

      Code set used to identify the service. Codeset will be blank for system-defined codes.

    • Procedures[].Description

      String

      Probable

      Description of the service

    • Procedures[].DateTime

      String

      Reliable
      Required

      DateTime of appointment. ISO 8601 Format

    • Procedures[].Duration

      Numeric

      Reliable
      Required

      Length of appointment. In minutes

    • Procedures[].ProcedureInfo[]

      Possible

      Additional information about the procedure being scheduled, such as body site.

    • Procedures[].ProcedureInfo[].Description

      String

      Possible

      ProcedureInfo description, such as 'Laterality'.

    • Procedures[].ProcedureInfo[].Value

      String

      Possible

      ProcedureInfo value, such as 'unilateral left'.

  • SurgeryStaff
    • SurgeryStaff[]

      Possible

      All of the staff assigned to this appointment. Each may be scheduled invidually.

    • SurgeryStaff[].ID

      String

      Probable

      ID of the Surgery staff member. This ID is required for Inpatient Visits

    • SurgeryStaff[].IDType

      String

      Probable

      ID type of the ID for the Surgery staff member

    • SurgeryStaff[].FirstName

      String

      Possible

      First name of the Surgery staff member

    • SurgeryStaff[].LastName

      String

      Possible

      Last name of the Surgery staff member

    • SurgeryStaff[].Credentials[]

      Array of Strings

      Possible

      List of credentials for the Surgery staff member. e.g. MD, PhD

    • SurgeryStaff[].Address

      Object

      Possible

      Provider's address

    • SurgeryStaff[].Address.StreetAddress

      String

      Possible

      Street address

    • SurgeryStaff[].Address.City

      String

      Possible

      City

    • SurgeryStaff[].Address.State

      String

      Possible

      State

    • SurgeryStaff[].Address.ZIP

      String

      Possible

      ZIP

    • SurgeryStaff[].Address.County

      String

      Possible

      County

    • SurgeryStaff[].Address.Country

      String

      Possible

      Country

    • SurgeryStaff[].Location

      Object

      Possible

      Provider's location

    • SurgeryStaff[].Location.Type

      String

      Possible

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

    • SurgeryStaff[].Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • SurgeryStaff[].Location.Department

      String

      Possible

      Department

    • SurgeryStaff[].Location.Room

      String

      Possible

      Room. Example: 136

    • SurgeryStaff[].PhoneNumber.Office

      String

      Possible

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

    • SurgeryStaff[].Role

      Object

      Probable

      The role of this person in the surgery.

    • SurgeryStaff[].Role.Code

      String

      Probable

      Code for the service

    • SurgeryStaff[].Role.Codeset

      String

      Probable

      Code set used to identify the service. Codeset will be blank for system-defined codes.

    • SurgeryStaff[].Role.Description

      String

      Probable

      Description of the service. Example: Primary Surgeon, Anesthesiologist, etc.

    • SurgeryStaff[].StartDateTime

      DateTime

      Probable

      If this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.

    • SurgeryStaff[].Duration

      Numeric

      Reliable

      Length of time that the staff member is scheduled for. In minutes

  • SurgicalInfo
    • SurgicalInfo[]

      Array of Objects

      Probable

      List of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.

    • SurgicalInfo[].Code

      String

      Probable

      Code for the information element

    • SurgicalInfo[].Codeset

      String

      Probable

      Code set used to identify the information element. Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.

    • SurgicalInfo[].Description

      String

      Probable

      Description of the information element. For AOEs, this is typically the text of the AOE question

    • SurgicalInfo[].Value

      String

      Reliable

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

  • Visit
    • Visit.VisitNumber

      String

      Reliable
      Required

      Visit Number used by the EHR to track this appointment.

    • Visit.Status

      String

      Probable

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

    • Visit.PatientClass

      String

      Reliable

      Patient class will indicate the state of the patient at the time of scheduling. Examples: Inpatient, Outpatient, Emergency

    • Visit.Notes[]

      Array of Strings

      Possible

      Notes about the visit

    • 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.Location

      Object

      Reliable

      Location of the procedure

    • 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.Location.Bed

      String

      Reliable

      Bed. Example: B

    • 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

  • SurgicalCase
    • SurgicalCase.Number

      String

      Possible

      Surgery specific identifier

{
   "Meta": {
      "DataModel": "SurgicalScheduling",
      "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": []
   },
   "Procedures": [
      {
         "Code": "6391",
         "Codeset": null,
         "Description": "Appendectomy",
         "DateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120,
         "ProcedureInfo": [
            {
               "Description": "Laterality",
               "Value": "unilateral left"
            }
         ]
      }
   ],
   "SurgeryStaff": [
      {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Role": {
            "Code": "1.1",
            "Codeset": null,
            "Description": "Primary Surgeon"
         },
         "StartDateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120
      }
   ],
   "SurgicalInfo": [
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Priority",
         "Value": "Normal"
      },
      {
         "Code": "1535135",
         "Codeset": "Redox EHR Codes",
         "Description": "Use Preference Cards",
         "Value": "Y"
      }
   ],
   "Visit": {
      "VisitNumber": "1234",
      "Status": null,
      "PatientClass": null,
      "Notes": [],
      "AttendingProvider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "RES General Hospital",
         "Department": "3N",
         "Room": "136",
         "Bed": "B"
      },
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Pain in throat",
            "Type": null
         }
      ]
   },
   "SurgicalCase": {
      "Number": null
   }
}

Reschedulelink

A Reschedule message is generated when the date or time of an appoinment is changed. Pay attention to each Services[] array entry as well as SurgicalStaff[] entries.

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
      Required

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Reliable
      Required

      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

  • Procedures
    • Procedures[]

      Array of Objects

      Probable

      Array of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.

    • Procedures[].Code

      String

      Probable

      Code for the service

    • Procedures[].Codeset

      String

      Probable

      Code set used to identify the service. Codeset will be blank for system-defined codes.

    • Procedures[].Description

      String

      Probable

      Description of the service

    • Procedures[].DateTime

      String

      Reliable
      Required

      DateTime of appointment. ISO 8601 Format

    • Procedures[].Duration

      Numeric

      Reliable
      Required

      Length of appointment. In minutes

    • Procedures[].ProcedureInfo[]

      Possible

      Additional information about the procedure being scheduled, such as body site.

    • Procedures[].ProcedureInfo[].Description

      String

      Possible

      ProcedureInfo description, such as 'Laterality'.

    • Procedures[].ProcedureInfo[].Value

      String

      Possible

      ProcedureInfo value, such as 'unilateral left'.

  • SurgeryStaff
    • SurgeryStaff[]

      Possible

      All of the staff assigned to this appointment. Each may be scheduled invidually.

    • SurgeryStaff[].ID

      String

      Probable

      ID of the Surgery staff member. This ID is required for Inpatient Visits

    • SurgeryStaff[].IDType

      String

      Probable

      ID type of the ID for the Surgery staff member

    • SurgeryStaff[].FirstName

      String

      Possible

      First name of the Surgery staff member

    • SurgeryStaff[].LastName

      String

      Possible

      Last name of the Surgery staff member

    • SurgeryStaff[].Credentials[]

      Array of Strings

      Possible

      List of credentials for the Surgery staff member. e.g. MD, PhD

    • SurgeryStaff[].Address

      Object

      Possible

      Provider's address

    • SurgeryStaff[].Address.StreetAddress

      String

      Possible

      Street address

    • SurgeryStaff[].Address.City

      String

      Possible

      City

    • SurgeryStaff[].Address.State

      String

      Possible

      State

    • SurgeryStaff[].Address.ZIP

      String

      Possible

      ZIP

    • SurgeryStaff[].Address.County

      String

      Possible

      County

    • SurgeryStaff[].Address.Country

      String

      Possible

      Country

    • SurgeryStaff[].Location

      Object

      Possible

      Provider's location

    • SurgeryStaff[].Location.Type

      String

      Possible

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

    • SurgeryStaff[].Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • SurgeryStaff[].Location.Department

      String

      Possible

      Department

    • SurgeryStaff[].Location.Room

      String

      Possible

      Room. Example: 136

    • SurgeryStaff[].PhoneNumber.Office

      String

      Possible

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

    • SurgeryStaff[].Role

      Object

      Probable

      The role of this person in the surgery.

    • SurgeryStaff[].Role.Code

      String

      Probable

      Code for the service

    • SurgeryStaff[].Role.Codeset

      String

      Probable

      Code set used to identify the service. Codeset will be blank for system-defined codes.

    • SurgeryStaff[].Role.Description

      String

      Probable

      Description of the service. Example: Primary Surgeon, Anesthesiologist, etc.

    • SurgeryStaff[].StartDateTime

      DateTime

      Probable

      If this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.

    • SurgeryStaff[].Duration

      Numeric

      Reliable

      Length of time that the staff member is scheduled for. In minutes

  • SurgicalInfo
    • SurgicalInfo[]

      Array of Objects

      Probable

      List of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.

    • SurgicalInfo[].Code

      String

      Probable

      Code for the information element

    • SurgicalInfo[].Codeset

      String

      Probable

      Code set used to identify the information element. Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.

    • SurgicalInfo[].Description

      String

      Probable

      Description of the information element. For AOEs, this is typically the text of the AOE question

    • SurgicalInfo[].Value

      String

      Reliable

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

  • Visit
    • Visit.VisitNumber

      String

      Reliable
      Required

      Visit Number used by the EHR to track this appointment.

    • Visit.Status

      String

      Probable

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

    • Visit.PatientClass

      String

      Reliable

      Patient class will indicate the state of the patient at the time of scheduling. Examples: Inpatient, Outpatient, Emergency

    • Visit.Notes[]

      Array of Strings

      Possible

      Notes about the visit

    • 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.Location

      Object

      Reliable

      Location of the procedure

    • 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.Location.Bed

      String

      Reliable

      Bed. Example: B

    • 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

  • SurgicalCase
    • SurgicalCase.Number

      String

      Possible

      Surgery specific identifier

{
   "Meta": {
      "DataModel": "SurgicalScheduling",
      "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": []
   },
   "Procedures": [
      {
         "Code": "6391",
         "Codeset": null,
         "Description": "Appendectomy",
         "DateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120,
         "ProcedureInfo": [
            {
               "Description": "Laterality",
               "Value": "unilateral left"
            }
         ]
      }
   ],
   "SurgeryStaff": [
      {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Role": {
            "Code": "1.1",
            "Codeset": null,
            "Description": "Primary Surgeon"
         },
         "StartDateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120
      }
   ],
   "SurgicalInfo": [
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Priority",
         "Value": "Normal"
      },
      {
         "Code": "1535135",
         "Codeset": "Redox EHR Codes",
         "Description": "Use Preference Cards",
         "Value": "Y"
      }
   ],
   "Visit": {
      "VisitNumber": "1234",
      "Status": null,
      "PatientClass": null,
      "Notes": [],
      "AttendingProvider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "RES General Hospital",
         "Department": "3N",
         "Room": "136",
         "Bed": "B"
      },
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Pain in throat",
            "Type": null
         }
      ]
   },
   "SurgicalCase": {
      "Number": 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
      Required

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Reliable
      Required

      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

  • Procedures
    • Procedures[]

      Array of Objects

      Probable

      Array of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.

    • Procedures[].Code

      String

      Probable

      Code for the service

    • Procedures[].Codeset

      String

      Probable

      Code set used to identify the service. Codeset will be blank for system-defined codes.

    • Procedures[].Description

      String

      Probable

      Description of the service

    • Procedures[].DateTime

      String

      Reliable
      Required

      DateTime of appointment. ISO 8601 Format

    • Procedures[].Duration

      Numeric

      Reliable
      Required

      Length of appointment. In minutes

    • Procedures[].ProcedureInfo[]

      Possible

      Additional information about the procedure being scheduled, such as body site.

    • Procedures[].ProcedureInfo[].Description

      String

      Possible

      ProcedureInfo description, such as 'Laterality'.

    • Procedures[].ProcedureInfo[].Value

      String

      Possible

      ProcedureInfo value, such as 'unilateral left'.

  • SurgeryStaff
    • SurgeryStaff[]

      Possible

      All of the staff assigned to this appointment. Each may be scheduled invidually.

    • SurgeryStaff[].ID

      String

      Probable

      ID of the Surgery staff member. This ID is required for Inpatient Visits

    • SurgeryStaff[].IDType

      String

      Probable

      ID type of the ID for the Surgery staff member

    • SurgeryStaff[].FirstName

      String

      Possible

      First name of the Surgery staff member

    • SurgeryStaff[].LastName

      String

      Possible

      Last name of the Surgery staff member

    • SurgeryStaff[].Credentials[]

      Array of Strings

      Possible

      List of credentials for the Surgery staff member. e.g. MD, PhD

    • SurgeryStaff[].Address

      Object

      Possible

      Provider's address

    • SurgeryStaff[].Address.StreetAddress

      String

      Possible

      Street address

    • SurgeryStaff[].Address.City

      String

      Possible

      City

    • SurgeryStaff[].Address.State

      String

      Possible

      State

    • SurgeryStaff[].Address.ZIP

      String

      Possible

      ZIP

    • SurgeryStaff[].Address.County

      String

      Possible

      County

    • SurgeryStaff[].Address.Country

      String

      Possible

      Country

    • SurgeryStaff[].Location

      Object

      Possible

      Provider's location

    • SurgeryStaff[].Location.Type

      String

      Possible

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

    • SurgeryStaff[].Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • SurgeryStaff[].Location.Department

      String

      Possible

      Department

    • SurgeryStaff[].Location.Room

      String

      Possible

      Room. Example: 136

    • SurgeryStaff[].PhoneNumber.Office

      String

      Possible

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

    • SurgeryStaff[].Role

      Object

      Probable

      The role of this person in the surgery.

    • SurgeryStaff[].Role.Code

      String

      Probable

      Code for the service

    • SurgeryStaff[].Role.Codeset

      String

      Probable

      Code set used to identify the service. Codeset will be blank for system-defined codes.

    • SurgeryStaff[].Role.Description

      String

      Probable

      Description of the service. Example: Primary Surgeon, Anesthesiologist, etc.

    • SurgeryStaff[].StartDateTime

      DateTime

      Probable

      If this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.

    • SurgeryStaff[].Duration

      Numeric

      Reliable

      Length of time that the staff member is scheduled for. In minutes

  • SurgicalInfo
    • SurgicalInfo[]

      Array of Objects

      Probable

      List of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.

    • SurgicalInfo[].Code

      String

      Probable

      Code for the information element

    • SurgicalInfo[].Codeset

      String

      Probable

      Code set used to identify the information element. Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.

    • SurgicalInfo[].Description

      String

      Probable

      Description of the information element. For AOEs, this is typically the text of the AOE question

    • SurgicalInfo[].Value

      String

      Reliable

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

  • Visit
    • Visit.VisitNumber

      String

      Reliable
      Required

      Visit Number used by the EHR to track this appointment.

    • Visit.Status

      String

      Probable

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

    • Visit.PatientClass

      String

      Reliable

      Patient class will indicate the state of the patient at the time of scheduling. Examples: Inpatient, Outpatient, Emergency

    • Visit.Notes[]

      Array of Strings

      Possible

      Notes about the visit

    • 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.Location

      Object

      Reliable

      Location of the procedure

    • 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.Location.Bed

      String

      Reliable

      Bed. Example: B

    • 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

  • SurgicalCase
    • SurgicalCase.Number

      String

      Possible

      Surgery specific identifier

{
   "Meta": {
      "DataModel": "SurgicalScheduling",
      "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": []
   },
   "Procedures": [
      {
         "Code": "6391",
         "Codeset": null,
         "Description": "Appendectomy",
         "DateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120,
         "ProcedureInfo": [
            {
               "Description": "Laterality",
               "Value": "unilateral left"
            }
         ]
      }
   ],
   "SurgeryStaff": [
      {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Role": {
            "Code": "1.1",
            "Codeset": null,
            "Description": "Primary Surgeon"
         },
         "StartDateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120
      }
   ],
   "SurgicalInfo": [
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Priority",
         "Value": "Normal"
      },
      {
         "Code": "1535135",
         "Codeset": "Redox EHR Codes",
         "Description": "Use Preference Cards",
         "Value": "Y"
      }
   ],
   "Visit": {
      "VisitNumber": "1234",
      "Status": null,
      "PatientClass": null,
      "Notes": [],
      "AttendingProvider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "RES General Hospital",
         "Department": "3N",
         "Room": "136",
         "Bed": "B"
      },
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Pain in throat",
            "Type": null
         }
      ]
   },
   "SurgicalCase": {
      "Number": null
   }
}

Cancellink

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

Fields

  • Visit
    • Visit.CancelReason

      String

      Possible

      Reason the visit was canceled

    • Visit.VisitNumber

      String

      Reliable
      Required

      Visit Number used by the EHR to track this appointment.

    • Visit.Status

      String

      Probable

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

    • Visit.PatientClass

      String

      Reliable

      Patient class will indicate the state of the patient at the time of scheduling. Examples: Inpatient, Outpatient, Emergency

    • Visit.Notes[]

      Array of Strings

      Possible

      Notes about the visit

    • 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.Location

      Object

      Reliable

      Location of the procedure

    • 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.Location.Bed

      String

      Reliable

      Bed. Example: B

    • 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
    • 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
      Required

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Reliable
      Required

      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

  • Procedures
    • Procedures[]

      Array of Objects

      Probable

      Array of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.

    • Procedures[].Code

      String

      Probable

      Code for the service

    • Procedures[].Codeset

      String

      Probable

      Code set used to identify the service. Codeset will be blank for system-defined codes.

    • Procedures[].Description

      String

      Probable

      Description of the service

    • Procedures[].DateTime

      String

      Reliable
      Required

      DateTime of appointment. ISO 8601 Format

    • Procedures[].Duration

      Numeric

      Reliable
      Required

      Length of appointment. In minutes

    • Procedures[].ProcedureInfo[]

      Possible

      Additional information about the procedure being scheduled, such as body site.

    • Procedures[].ProcedureInfo[].Description

      String

      Possible

      ProcedureInfo description, such as 'Laterality'.

    • Procedures[].ProcedureInfo[].Value

      String

      Possible

      ProcedureInfo value, such as 'unilateral left'.

  • SurgeryStaff
    • SurgeryStaff[]

      Possible

      All of the staff assigned to this appointment. Each may be scheduled invidually.

    • SurgeryStaff[].ID

      String

      Probable

      ID of the Surgery staff member. This ID is required for Inpatient Visits

    • SurgeryStaff[].IDType

      String

      Probable

      ID type of the ID for the Surgery staff member

    • SurgeryStaff[].FirstName

      String

      Possible

      First name of the Surgery staff member

    • SurgeryStaff[].LastName

      String

      Possible

      Last name of the Surgery staff member

    • SurgeryStaff[].Credentials[]

      Array of Strings

      Possible

      List of credentials for the Surgery staff member. e.g. MD, PhD

    • SurgeryStaff[].Address

      Object

      Possible

      Provider's address

    • SurgeryStaff[].Address.StreetAddress

      String

      Possible

      Street address

    • SurgeryStaff[].Address.City

      String

      Possible

      City

    • SurgeryStaff[].Address.State

      String

      Possible

      State

    • SurgeryStaff[].Address.ZIP

      String

      Possible

      ZIP

    • SurgeryStaff[].Address.County

      String

      Possible

      County

    • SurgeryStaff[].Address.Country

      String

      Possible

      Country

    • SurgeryStaff[].Location

      Object

      Possible

      Provider's location

    • SurgeryStaff[].Location.Type

      String

      Possible

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

    • SurgeryStaff[].Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • SurgeryStaff[].Location.Department

      String

      Possible

      Department

    • SurgeryStaff[].Location.Room

      String

      Possible

      Room. Example: 136

    • SurgeryStaff[].PhoneNumber.Office

      String

      Possible

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

    • SurgeryStaff[].Role

      Object

      Probable

      The role of this person in the surgery.

    • SurgeryStaff[].Role.Code

      String

      Probable

      Code for the service

    • SurgeryStaff[].Role.Codeset

      String

      Probable

      Code set used to identify the service. Codeset will be blank for system-defined codes.

    • SurgeryStaff[].Role.Description

      String

      Probable

      Description of the service. Example: Primary Surgeon, Anesthesiologist, etc.

    • SurgeryStaff[].StartDateTime

      DateTime

      Probable

      If this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.

    • SurgeryStaff[].Duration

      Numeric

      Reliable

      Length of time that the staff member is scheduled for. In minutes

  • SurgicalInfo
    • SurgicalInfo[]

      Array of Objects

      Probable

      List of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.

    • SurgicalInfo[].Code

      String

      Probable

      Code for the information element

    • SurgicalInfo[].Codeset

      String

      Probable

      Code set used to identify the information element. Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.

    • SurgicalInfo[].Description

      String

      Probable

      Description of the information element. For AOEs, this is typically the text of the AOE question

    • SurgicalInfo[].Value

      String

      Reliable

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

  • SurgicalCase
    • SurgicalCase.Number

      String

      Possible

      Surgery specific identifier

{
   "Visit": {
      "CancelReason": "Conflicting appointment",
      "VisitNumber": "1234",
      "Status": null,
      "PatientClass": null,
      "Notes": [],
      "AttendingProvider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "RES General Hospital",
         "Department": "3N",
         "Room": "136",
         "Bed": "B"
      },
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Pain in throat",
            "Type": null
         }
      ]
   },
   "Meta": {
      "DataModel": "SurgicalScheduling",
      "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": []
   },
   "Procedures": [
      {
         "Code": "6391",
         "Codeset": null,
         "Description": "Appendectomy",
         "DateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120,
         "ProcedureInfo": [
            {
               "Description": "Laterality",
               "Value": "unilateral left"
            }
         ]
      }
   ],
   "SurgeryStaff": [
      {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Role": {
            "Code": "1.1",
            "Codeset": null,
            "Description": "Primary Surgeon"
         },
         "StartDateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120
      }
   ],
   "SurgicalInfo": [
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Priority",
         "Value": "Normal"
      },
      {
         "Code": "1535135",
         "Codeset": "Redox EHR Codes",
         "Description": "Use Preference Cards",
         "Value": "Y"
      }
   ],
   "SurgicalCase": {
      "Number": null
   }
}

NoShowlink

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

Fields

  • Visit
    • Visit.NoShowReason

      String

      Possible

      Reason the patient did not show for the appointment

    • Visit.VisitNumber

      String

      Reliable
      Required

      Visit Number used by the EHR to track this appointment.

    • Visit.Status

      String

      Probable

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

    • Visit.PatientClass

      String

      Reliable

      Patient class will indicate the state of the patient at the time of scheduling. Examples: Inpatient, Outpatient, Emergency

    • Visit.Notes[]

      Array of Strings

      Possible

      Notes about the visit

    • 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.Location

      Object

      Reliable

      Location of the procedure

    • 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.Location.Bed

      String

      Reliable

      Bed. Example: B

    • 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
    • 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
      Required

      ID for the patient

    • Patient.Identifiers[].IDType

      String

      Reliable
      Required

      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

  • Procedures
    • Procedures[]

      Array of Objects

      Probable

      Array of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.

    • Procedures[].Code

      String

      Probable

      Code for the service

    • Procedures[].Codeset

      String

      Probable

      Code set used to identify the service. Codeset will be blank for system-defined codes.

    • Procedures[].Description

      String

      Probable

      Description of the service

    • Procedures[].DateTime

      String

      Reliable
      Required

      DateTime of appointment. ISO 8601 Format

    • Procedures[].Duration

      Numeric

      Reliable
      Required

      Length of appointment. In minutes

    • Procedures[].ProcedureInfo[]

      Possible

      Additional information about the procedure being scheduled, such as body site.

    • Procedures[].ProcedureInfo[].Description

      String

      Possible

      ProcedureInfo description, such as 'Laterality'.

    • Procedures[].ProcedureInfo[].Value

      String

      Possible

      ProcedureInfo value, such as 'unilateral left'.

  • SurgeryStaff
    • SurgeryStaff[]

      Possible

      All of the staff assigned to this appointment. Each may be scheduled invidually.

    • SurgeryStaff[].ID

      String

      Probable

      ID of the Surgery staff member. This ID is required for Inpatient Visits

    • SurgeryStaff[].IDType

      String

      Probable

      ID type of the ID for the Surgery staff member

    • SurgeryStaff[].FirstName

      String

      Possible

      First name of the Surgery staff member

    • SurgeryStaff[].LastName

      String

      Possible

      Last name of the Surgery staff member

    • SurgeryStaff[].Credentials[]

      Array of Strings

      Possible

      List of credentials for the Surgery staff member. e.g. MD, PhD

    • SurgeryStaff[].Address

      Object

      Possible

      Provider's address

    • SurgeryStaff[].Address.StreetAddress

      String

      Possible

      Street address

    • SurgeryStaff[].Address.City

      String

      Possible

      City

    • SurgeryStaff[].Address.State

      String

      Possible

      State

    • SurgeryStaff[].Address.ZIP

      String

      Possible

      ZIP

    • SurgeryStaff[].Address.County

      String

      Possible

      County

    • SurgeryStaff[].Address.Country

      String

      Possible

      Country

    • SurgeryStaff[].Location

      Object

      Possible

      Provider's location

    • SurgeryStaff[].Location.Type

      String

      Possible

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

    • SurgeryStaff[].Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • SurgeryStaff[].Location.Department

      String

      Possible

      Department

    • SurgeryStaff[].Location.Room

      String

      Possible

      Room. Example: 136

    • SurgeryStaff[].PhoneNumber.Office

      String

      Possible

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

    • SurgeryStaff[].Role

      Object

      Probable

      The role of this person in the surgery.

    • SurgeryStaff[].Role.Code

      String

      Probable

      Code for the service

    • SurgeryStaff[].Role.Codeset

      String

      Probable

      Code set used to identify the service. Codeset will be blank for system-defined codes.

    • SurgeryStaff[].Role.Description

      String

      Probable

      Description of the service. Example: Primary Surgeon, Anesthesiologist, etc.

    • SurgeryStaff[].StartDateTime

      DateTime

      Probable

      If this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.

    • SurgeryStaff[].Duration

      Numeric

      Reliable

      Length of time that the staff member is scheduled for. In minutes

  • SurgicalInfo
    • SurgicalInfo[]

      Array of Objects

      Probable

      List of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.

    • SurgicalInfo[].Code

      String

      Probable

      Code for the information element

    • SurgicalInfo[].Codeset

      String

      Probable

      Code set used to identify the information element. Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.

    • SurgicalInfo[].Description

      String

      Probable

      Description of the information element. For AOEs, this is typically the text of the AOE question

    • SurgicalInfo[].Value

      String

      Reliable

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

  • SurgicalCase
    • SurgicalCase.Number

      String

      Possible

      Surgery specific identifier

{
   "Visit": {
      "NoShowReason": "Car broke down.",
      "VisitNumber": "1234",
      "Status": null,
      "PatientClass": null,
      "Notes": [],
      "AttendingProvider": {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         }
      },
      "Location": {
         "Type": "Inpatient",
         "Facility": "RES General Hospital",
         "Department": "3N",
         "Room": "136",
         "Bed": "B"
      },
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Pain in throat",
            "Type": null
         }
      ]
   },
   "Meta": {
      "DataModel": "SurgicalScheduling",
      "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": []
   },
   "Procedures": [
      {
         "Code": "6391",
         "Codeset": null,
         "Description": "Appendectomy",
         "DateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120,
         "ProcedureInfo": [
            {
               "Description": "Laterality",
               "Value": "unilateral left"
            }
         ]
      }
   ],
   "SurgeryStaff": [
      {
         "ID": "4356789876",
         "IDType": "NPI",
         "FirstName": "Pat",
         "LastName": "Granite",
         "Credentials": [
            "MD"
         ],
         "Address": {
            "StreetAddress": "123 Main St.",
            "City": "Madison",
            "State": "WI",
            "ZIP": "53703",
            "County": "Dane",
            "Country": "USA"
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         },
         "PhoneNumber": {
            "Office": "+16085551234"
         },
         "Role": {
            "Code": "1.1",
            "Codeset": null,
            "Description": "Primary Surgeon"
         },
         "StartDateTime": "2015-12-13T21:08:57.581Z",
         "Duration": 120
      }
   ],
   "SurgicalInfo": [
      {
         "Code": "23457",
         "Codeset": "Redox EHR Codes",
         "Description": "Priority",
         "Value": "Normal"
      },
      {
         "Code": "1535135",
         "Codeset": "Redox EHR Codes",
         "Description": "Use Preference Cards",
         "Value": "Y"
      }
   ],
   "SurgicalCase": {
      "Number": null
   }
}