ClinicalDecisions

The Clinical Decision Support data model contains Request and Response events. The Request event is used to send over unsigned medication and procedure orders for review. The Response event is then used to send back recommended changes, such as removing or adding an additional order. Both events also contain sections for questions to be asked and responded to. If additional information is needed, the Response will also provide an external link for the provider to access and add the needed information.

RequestBETAlink

This is the format for the Clinical Decisions Support request.

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.

  • Session
    • Session.Questions[]

      Array of Objects

      Possible

      Questions answered by the ordering provider that apply to all of the orders in the CDS request.

    • Session.Questions[].Question

      Object

      Probable

      Information about the question

    • Session.Questions[].Question.Code

      String

      Probable

      Code for the question

    • Session.Questions[].Question.Codeset

      String

      Probable

      Code set used to identify the question

    • Session.Questions[].Question.Description

      String

      Probable

      Description of the question

    • Session.Questions[].Answer

      Object

      Probable

      Information about the answer

    • Session.Questions[].Answer.Code

      String

      Probable

      Code for the answer

    • Session.Questions[].Answer.Codeset

      String

      Probable

      Code set used to identify the answer

    • Session.Questions[].Answer.Description

      String

      Probable

      Description of the answer

  • 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

  • OrderingProvider
    • OrderingProvider.ID

      String

      Probable

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

    • OrderingProvider.IDType

      String

      Probable

      ID type of the ID for the ordering provider

    • OrderingProvider.FirstName

      String

      Possible

      First name of the ordering provider

    • OrderingProvider.LastName

      String

      Possible

      Last name of the ordering provider

    • OrderingProvider.Credentials[]

      Array of Strings

      Possible

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

    • OrderingProvider.Address

      Object

      Possible

      Provider's address

    • OrderingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • OrderingProvider.Address.City

      String

      Possible

      City

    • OrderingProvider.Address.State

      String

      Possible

      State

    • OrderingProvider.Address.ZIP

      String

      Possible

      ZIP

    • OrderingProvider.Address.County

      String

      Possible

      County

    • OrderingProvider.Address.Country

      String

      Possible

      Country

    • OrderingProvider.Location

      Object

      Possible

      Provider's location

    • OrderingProvider.Location.Type

      String

      Possible

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

    • OrderingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • OrderingProvider.Location.Department

      String

      Possible

      Department

    • OrderingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • OrderingProvider.PhoneNumber.Office

      String

      Possible

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

  • AuthorizingProvider
    • AuthorizingProvider.ID

      String

      Possible

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

    • AuthorizingProvider.IDType

      String

      Possible

      ID type of the ID for the authorizing provider

    • AuthorizingProvider.FirstName

      String

      Possible

      First name of the authorizing provider

    • AuthorizingProvider.LastName

      String

      Possible

      Last name of the authorizing provider

    • AuthorizingProvider.Credentials[]

      Array of Strings

      Possible

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

    • AuthorizingProvider.Address

      Object

      Possible

      Provider's address

    • AuthorizingProvider.Address.StreetAddress

      String

      Possible

      Street address

    • AuthorizingProvider.Address.City

      String

      Possible

      City

    • AuthorizingProvider.Address.State

      String

      Possible

      State

    • AuthorizingProvider.Address.ZIP

      String

      Possible

      ZIP

    • AuthorizingProvider.Address.County

      String

      Possible

      County

    • AuthorizingProvider.Address.Country

      String

      Possible

      Country

    • AuthorizingProvider.Location

      Object

      Possible

      Provider's location

    • AuthorizingProvider.Location.Type

      String

      Possible

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

    • AuthorizingProvider.Location.Facility

      String

      Possible

      Facility. Example: Community Hospital

    • AuthorizingProvider.Location.Department

      String

      Possible

      Department

    • AuthorizingProvider.Location.Room

      String

      Possible

      Room. Example: 136

    • AuthorizingProvider.PhoneNumber.Office

      String

      Possible

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

  • UnsignedMedicationOrders
    • UnsignedMedicationOrders[]

      Array of objects

      Reliable

      Array of unsigned medication orders

    • UnsignedMedicationOrders[].Identifiers

      Array of Objects

      Reliable

      Array of identifiers for the medication order

    • UnsignedMedicationOrders[].Identifiers[].ID

      String

      Reliable
      Required

      ID of the medication order

    • UnsignedMedicationOrders[].Identifiers[].IDType

      String

      Reliable
      Required

      IDType of the medication order

    • UnsignedMedicationOrders[].Frequency.Period

      String

      Probable

      How often the patient should be taking the medication. UCUM Units of Measure

    • UnsignedMedicationOrders[].Frequency.Unit

      String

      Probable

      Units for how often the patient should be taking the medication

    • UnsignedMedicationOrders[].Product

      Object

      Reliable

      The actual medication given

    • UnsignedMedicationOrders[].Product.Code

      String

      Reliable

      Code

    • UnsignedMedicationOrders[].Product.Codeset

      String

      Reliable

      Code set

    • UnsignedMedicationOrders[].Product.Name

      String

      Reliable

      Name

    • UnsignedMedicationOrders[].Priority

      String

      Possible

      Priority for taking this medication

    • UnsignedMedicationOrders[].Dose.Quantity

      Numeric

      Possible

      The size of the dose for pills, capsules, etc.

    • UnsignedMedicationOrders[].Mode

      String

      Reliable

      Mode in which the medication order was created. IP/OP

    • UnsignedMedicationOrders[].StartDate

      String

      Reliable

      When the medication was started. ISO 8601 Format

    • UnsignedMedicationOrders[].EndDate

      String

      Probable

      When the medication was ended. ISO 8601 Format

    • UnsignedMedicationOrders[].MixtureType

      String

      Possible

      Type of mixture of the medication. SimpleMed / IMSMixture / GenericMixture

    • UnsignedMedicationOrders[].MixtureComponents[]

      String

      Possible

      The individual components of a mixed medication

    • UnsignedMedicationOrders[].MixtureComponents[].Code

      String

      Possible

      The code that identifies the component. RxNorm code

    • UnsignedMedicationOrders[].MixtureComponents[].CodeType

      String

      Possible

      Type of code sent in the code field. RxNorm

    • UnsignedMedicationOrders[].MixtureComponents[].Dose.Quantity

      String

      Possible

      Amount of this component added to the mixture

    • UnsignedMedicationOrders[].MixtureComponents[].Dose.Units

      String

      Possible

      Units of the component added to the mixture. UCUM Units of Measure

    • UnsignedMedicationOrders[].Questions[]

      Array of Objects

      Possible

      Order-level questions

    • UnsignedMedicationOrders[].Questions[].Question

      Object

      Probable

      Information about the question

    • UnsignedMedicationOrders[].Questions[].Question.Code

      String

      Probable

      Code for the question

    • UnsignedMedicationOrders[].Questions[].Question.Codeset

      String

      Probable

      Code set used to identify the question

    • UnsignedMedicationOrders[].Questions[].Question.Description

      String

      Probable

      Description of the question

    • UnsignedMedicationOrders[].Questions[].Answer

      Object

      Probable

      Information about the answer

    • UnsignedMedicationOrders[].Questions[].Answer.Code

      String

      Probable

      Code for the answer

    • UnsignedMedicationOrders[].Questions[].Answer.Codeset

      String

      Probable

      Code set used to identify the answer

    • UnsignedMedicationOrders[].Questions[].Answer.Description

      String

      Probable

      Description of the answer

    • UnsignedMedicationOrders[].Notes[]

      Array of Strings

      Possible

      Order-level notes

  • UnsignedProcedureOrders
    • UnsignedProcedureOrders[]

      Array of Objects

      Reliable

      Array of unsigned procedure orders

    • UnsignedProcedureOrders[].Code

      String

      Reliable

      Code for the procedure

    • UnsignedProcedureOrders[].Codeset

      String

      Reliable

      Code set used to identify the procedure

    • UnsignedProcedureOrders[].Description

      String

      Reliable

      Description of the procedure

    • UnsignedProcedureOrders[].Identifiers

      Array of Objects

      Reliable

      Array of identifiers for the procedure order

    • UnsignedProcedureOrders[].Identifiers[].ID

      String

      Reliable
      Required

      ID of the procedure order

    • UnsignedProcedureOrders[].Identifiers[].IDType

      Numeric

      Reliable
      Required

      IDType of the procedure order

    • UnsignedProcedureOrders[].ScheduledDate

      String

      Possible

      Scheduled date of the procedure

    • UnsignedProcedureOrders[].Mode

      String

      Reliable

      Mode in which the procedure order was created. IP/OP

    • UnsignedProcedureOrders[].BodySite

      Object

      Probable

      The location on the body where the procedure was performed

    • UnsignedProcedureOrders[].BodySite.Code

      String

      Probable

      Code

    • UnsignedProcedureOrders[].BodySite.Codeset

      String

      Probable

      Code set

    • UnsignedProcedureOrders[].BodySite.Description

      String

      Probable

      Description

    • UnsignedProcedureOrders[].StartDate

      String

      Reliable

      When the procedure was started. ISO 8601 Format

    • UnsignedProcedureOrders[].EndDate

      String

      Probable

      When the procedure ended. ISO 8601 Format

    • UnsignedProcedureOrders[].Questions[]

      Array of Objects

      Possible

      Order-level questions

    • UnsignedProcedureOrders[].Questions[].Question

      Object

      Probable

      Information about the question

    • UnsignedProcedureOrders[].Questions[].Question.Code

      String

      Probable

      Code for the question

    • UnsignedProcedureOrders[].Questions[].Question.Codeset

      String

      Probable

      Code set used to identify the question

    • UnsignedProcedureOrders[].Questions[].Question.Description

      String

      Probable

      Description of the question

    • UnsignedProcedureOrders[].Questions[].Answer

      Object

      Probable

      Information about the answer

    • UnsignedProcedureOrders[].Questions[].Answer.Code

      String

      Probable

      Code for the answer

    • UnsignedProcedureOrders[].Questions[].Answer.Codeset

      String

      Probable

      Code set used to identify the answer

    • UnsignedProcedureOrders[].Questions[].Answer.Description

      String

      Probable

      Description of the answer

    • UnsignedProcedureOrders[].Notes[]

      Array of Strings

      Possible

      Order-level notes

Sample MessageDownload JSON Schema BETA
{
   "Meta": {
      "DataModel": "Clinical Decisions",
      "EventType": "Request",
      "EventDateTime": "2017-10-10T15:07:21.362Z",
      "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
   },
   "Session": {
      "Questions": [
         {
            "Question": {
               "Code": null,
               "Codeset": null,
               "Description": null
            },
            "Answer": {
               "Code": null,
               "Codeset": null,
               "Description": 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": []
   },
   "OrderingProvider": {
      "ID": "4236464757",
      "IDType": "NPI",
      "FirstName": "John",
      "LastName": "Slate",
      "Credentials": [
         "DO"
      ],
      "Address": {
         "StreetAddress": "500 First St.",
         "City": "Clayton",
         "State": "MO",
         "ZIP": "63105",
         "County": "Saint Louis",
         "Country": "USA"
      },
      "Location": {
         "Type": null,
         "Facility": null,
         "Department": null,
         "Room": null
      },
      "PhoneNumber": {
         "Office": "+13145554321"
      }
   },
   "AuthorizingProvider": {
      "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"
      }
   },
   "UnsignedMedicationOrders": [
      {
         "Identifiers": [
            {
               "ID": "384209384094849",
               "IDType": "EHR"
            }
         ],
         "Frequency": {
            "Period": "8",
            "Unit": "h"
         },
         "Product": {
            "Code": "104894",
            "Codeset": null,
            "Name": "Ondansetron 4 Mg Po Tbdp"
         },
         "Priority": "Stat",
         "Dose": {
            "Quantity": "4",
            "Units": "mg"
         },
         "Mode": "IP",
         "Route": "Oral",
         "StartDate": "2005-05-01T04:00:00.000Z",
         "EndDate": "2011-02-27T05:00:00.000Z",
         "MixtureType": null,
         "MixtureComponents": [
            {
               "Code": null,
               "CodeType": null,
               "Dose": {
                  "Quantity": null,
                  "Units": null
               }
            }
         ],
         "Questions": [
            {
               "Question": {
                  "Code": null,
                  "Codeset": null,
                  "Description": "Why is this medication being ordered?"
               },
               "Answer": {
                  "Code": null,
                  "Codeset": null,
                  "Description": "To prevent nausea after chemotherapy."
               }
            }
         ],
         "Notes": []
      }
   ],
   "UnsignedProcedureOrders": [
      {
         "Code": "76700",
         "Codeset": "CPT",
         "Description": null,
         "Identifiers": [
            {
               "ID": "329308430984409",
               "IDType": "EHR"
            }
         ],
         "ScheduledDate": "2005-07-02T04:00:00:000Z",
         "Mode": "IP",
         "BodySite": {
            "Code": null,
            "Codeset": null,
            "Description": null
         },
         "StartDate": "2005-05-01T04:00:00.000Z",
         "EndDate": "2011-02-27T05:00:00.000Z",
         "Questions": [
            {
               "Question": {
                  "Code": null,
                  "Codeset": null,
                  "Description": "Why is this ultrasound being ordered?"
               },
               "Answer": {
                  "Code": null,
                  "Codeset": null,
                  "Description": "The patient swallowed a foreign body."
               }
            }
         ],
         "Notes": []
      }
   ]
}

ResponseBETAlink

This is the format for a Clinical Decisions Support response.

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.

  • Advisories
    • Advisories[]

      Array of Objects

      Possible

      The array of returned CDS advisories

    • Advisories[].ShowAlert

      Boolean

      Possible

      A flag indicating whether there is an alert to show to the user. If set to false, the ordering will finish uninterrupted. True / False

    • Advisories[].Session

      String

      Possible
      Required

      This is the session ID that matches the original order to the support response.

    • Advisories[].RemovableUnsignedOrders[]

      Array of Objects

      Possible

      An array of unsigned orders suggested for removal

    • Advisories[].RemovableUnsignedOrders[].ID

      String

      Possible

      ID of the order suggested for removal

    • Advisories[].RemovableUnsignedOrders[].IDType

      String

      Possible

      ID type of the order suggested for removal

    • Advisories[].RemovableUnsignedOrders[].Title

      String

      Possible

      Title of the order suggested for removal

    • Advisories[].AdditionalUnsignedOrders[]

      Array of Objects

      Possible

      An array of additional unsigned orders suggested

    • Advisories[].AdditionalUnsignedOrders[].ID

      String

      Possible

      ID of the additional order suggested

    • Advisories[].AdditionalUnsignedOrders[].IDType

      String

      Possible

      IDType of the additional order suggested

    • Advisories[].AdditionalUnsignedOrders[].Title

      String

      Possible

      Title of the additional order suggested

    • Advisories[].AdditionalUnsignedOrders[].Questions[]

      Array of Objects

      Probable

      An array of questions about the additional unsigned orders suggested

    • Advisories[].AdditionalUnsignedOrders[].Questions[].Code

      String

      Probable

      Code

    • Advisories[].AdditionalUnsignedOrders[].Questions[].Codeset

      String

      Probable

      Code set

    • Advisories[].AdditionalUnsignedOrders[].Questions[].Description

      String

      Probable

      Description

    • Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[]

      Array of Objects

      Probable

      Possible answers for the question

    • Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[].Code

      String

      Probable

      Code

    • Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[].Codeset

      String

      Probable

      Code set

    • Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[].Description

      String

      Probable

      Description

    • Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[].Comment

      String

      Possible

      A comment regarding the answer

    • Advisories[].Description

      String

      Possible

      Text to display explaining the decision provided

    • Advisories[].Notes[]

      Array of Strings

      Possible

      Notes on processing next steps

    • Advisories[].Notes[].Text

      String

      Possible
    • Advisories[].Notes[].Display

      String

      Possible
    • Advisories[].AdditionalInfo[].DecisionSupport

      Object

      Reliable

      Provide additional information

    • Advisories[].AdditionalInfo[].DecisionSupport.Code

      String

      Reliable

      Code for the additional information

    • Advisories[].AdditionalInfo[].DecisionSupport.Codeset

      String

      Reliable

      Code set used to identify the additional information

    • Advisories[].AdditionalInfo[].DecisionSupport.Description

      String

      Reliable

      Description of the additional information

    • Advisories[].AdditionalInfo.Link

      String

      Possible

      Hyperlink to visit for requested additional information

    • Advisories[].Errors[]

      Array of Objects

      Reliable

      Provide Error codes and display the reason

    • Advisories[].Errors[].Code

      String

      Reliable

      Code for the errors

    • Advisories[].Errors[].Codeset

      String

      Reliable

      Code set used to identify the errors

    • Advisories[].Errors[].Description

      String

      Reliable

      Description of the errors

Sample MessageDownload JSON Schema BETA
{
   "Meta": {
      "DataModel": "Clinical Decisions",
      "EventType": "Response",
      "EventDateTime": "2017-10-10T15:07:21.362Z",
      "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
   },
   "Advisories": [
      {
         "ShowAlert": false,
         "Session": "session490284",
         "RemovableUnsignedOrders": [
            {
               "ID": "157968300",
               "IDType": "CPT",
               "Title": "Colonoscopy"
            }
         ],
         "AdditionalUnsignedOrders": [
            {
               "ID": "157968300",
               "IDType": "RxNorm",
               "Title": "Acetaminophen",
               "Questions": [
                  {
                     "Code": null,
                     "Codeset": null,
                     "Description": null,
                     "Answers": [
                        {
                           "Code": null,
                           "Codeset": null,
                           "Description": null,
                           "Comment": null
                        }
                     ]
                  }
               ]
            }
         ],
         "Description": null,
         "Notes": [
            {
               "Text": null,
               "Display": null
            }
         ],
         "AdditionalInfo": [
            {
               "DecisionSupport": {
                  "Code": "9",
                  "Codeset": null,
                  "Description": "We are very confident in this order."
               }
            }
         ],
         "Errors": [
            {
               "Code": null,
               "Codeset": null,
               "Description": null
            }
         ]
      }
   ]
}