ClinicalDecisions
The ClinicalDecisions data model communicates real-time, immediate clinical decision support (CDS) to providers. This is helpful when a provider wants to recommend alternative medications and procedures or identify drug-drug interactions when they're placing an order.
The EHR system uses the Request event type to initiate the CDS workflow by providing the required information to the third-party app offering CDS data; the app then uses the Response event type to send back clinical insights, observations, and recommendations.
The ClinicalDecisions data model returns discrete data that the EHR system utilizes as part of an alert to advise on the provider's behavior. But to do this, the EHR system must have a corresponding CDS API that can map to the ClinicalDecisions data model. We've mostly seen this capability with Epic EHR systems, but since ClinicalDecisions was built on FHIR/CDS Hook specification, it has the potential to be supported by other EHR systems across the board.
This data model differs from the SSO data model in that the SSO data model returns a URL for the EHR system to launch the app's system, whereas ClinicalDecisions returns discrete data to offer CDS within the EHR system. ClinicalDecisions is also part of a typical ordering workflow while SSO is triggered when the user clicks a specially-configured button to launch an app within the EHR system.
Requestlink
BETAThis event type varies depending on the use case and the EHR system's alert setup. For example, an alternative medications alert would be configured to fire when a provider attempts to sign an order, or an alert regarding a possible chronic condition might fire based on a patient's vitals history when a new set is documented. See the general format below to provide CDS data.
Fields
Meta
Meta.DataModel
String
ReliableRequiredClinical Decisions
Meta.EventType
String
ReliableRequiredRequest
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Session
Session.Questions[]
Array of Objects
PossibleQuestions answered by the ordering provider that apply to all of the orders in the CDS request.
Session.Questions[].Question
Object
ProbableInformation about the question
Session.Questions[].Question.Code
String
ProbableCode for the question
Session.Questions[].Question.Codeset
String
ProbableCode set used to identify the question
Session.Questions[].Question.Description
String
ProbableDescription of the question
Session.Questions[].Answer
Object
ProbableInformation about the answer
Session.Questions[].Answer.Code
String
ProbableCode for the answer
Session.Questions[].Answer.Codeset
String
ProbableCode set used to identify the answer
Session.Questions[].Answer.Description
String
ProbableDescription of the answer
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
OrderingProvider
OrderingProvider.ID
String
ProbableID of the ordering provider.
This ID is often required for Inpatient Visits.
OrderingProvider.IDType
String
ProbableID type of the ID for the ordering provider
OrderingProvider.FirstName
String
PossibleFirst name of the ordering provider
OrderingProvider.LastName
String
PossibleLast name of the ordering provider
OrderingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the ordering provider.
e.g. MD, PhD
OrderingProvider.Address
Object
PossibleProvider's address
OrderingProvider.Address.StreetAddress
String
PossibleStreet address
OrderingProvider.Address.City
String
PossibleCity
OrderingProvider.Address.State
String
PossibleState
OrderingProvider.Address.ZIP
String
PossibleZIP
OrderingProvider.Address.County
String
PossibleCounty
OrderingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
OrderingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
OrderingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
OrderingProvider.Location
Object
PossibleProvider's location
OrderingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
OrderingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
OrderingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
OrderingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
OrderingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
OrderingProvider.Location.Department
String
PossibleDepartment
OrderingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
OrderingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
OrderingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
OrderingProvider.Location.Room
String
PossibleRoom.
Example: 136
AuthorizingProvider
AuthorizingProvider.ID
String
PossibleID of the authorizing provider.
This ID is often required for Inpatient Visits.
AuthorizingProvider.IDType
String
PossibleID type of the ID for the authorizing provider
AuthorizingProvider.FirstName
String
PossibleFirst name of the authorizing provider
AuthorizingProvider.LastName
String
PossibleLast name of the authorizing provider
AuthorizingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the authorizing provider.
e.g. MD, PhD
AuthorizingProvider.Address
Object
PossibleProvider's address
AuthorizingProvider.Address.StreetAddress
String
PossibleStreet address
AuthorizingProvider.Address.City
String
PossibleCity
AuthorizingProvider.Address.State
String
PossibleState
AuthorizingProvider.Address.ZIP
String
PossibleZIP
AuthorizingProvider.Address.County
String
PossibleCounty
AuthorizingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
AuthorizingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
AuthorizingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
AuthorizingProvider.Location
Object
PossibleProvider's location
AuthorizingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
AuthorizingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
AuthorizingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
AuthorizingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
AuthorizingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
AuthorizingProvider.Location.Department
String
PossibleDepartment
AuthorizingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
AuthorizingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
AuthorizingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
AuthorizingProvider.Location.Room
String
PossibleRoom.
Example: 136
UnsignedMedicationOrders
UnsignedMedicationOrders[]
Array of objects
ReliableArray of unsigned medication orders
UnsignedMedicationOrders[].Identifiers
Array of Objects
ReliableArray of identifiers for the medication order
UnsignedMedicationOrders[].Identifiers[].ID
String
ReliableRequiredID of the medication order
UnsignedMedicationOrders[].Identifiers[].IDType
String
ReliableRequiredIDType of the medication order
UnsignedMedicationOrders[].Frequency.Period
String
ProbableHow often the patient should be taking the medication.
UCUM Units of Measure
UnsignedMedicationOrders[].Frequency.Unit
String
ProbableUnits for how often the patient should be taking the medication
UnsignedMedicationOrders[].Product
Object
ReliableThe actual medication given
UnsignedMedicationOrders[].Product.Code
String
ReliableCode
UnsignedMedicationOrders[].Product.Codeset
String
ReliableCode set
UnsignedMedicationOrders[].Product.Name
String
ReliableName
UnsignedMedicationOrders[].Priority
String
PossiblePriority for taking this medication
UnsignedMedicationOrders[].Dose.Quantity
Numeric
PossibleThe size of the dose for pills, capsules, etc.
UnsignedMedicationOrders[].Dose.Units
String
PossibleThe units of the dose.
UCUM Units of Measure
UnsignedMedicationOrders[].Mode
String
ReliableMode in which the medication order was created.
IP/OP
UnsignedMedicationOrders[].Route
ProbableThe method by which the medication is delivered.
Medication Route FDA Value Set
UnsignedMedicationOrders[].StartDate
String
ReliableWhen the medication was started.
ISO 8601 Format
UnsignedMedicationOrders[].EndDate
String
ProbableWhen the medication was ended.
ISO 8601 Format
UnsignedMedicationOrders[].MixtureType
String
PossibleType of mixture of the medication.
SimpleMed / IMSMixture / GenericMixture
UnsignedMedicationOrders[].MixtureComponents[]
String
PossibleThe individual components of a mixed medication
UnsignedMedicationOrders[].MixtureComponents[].Code
String
PossibleThe code that identifies the component.
RxNorm code
UnsignedMedicationOrders[].MixtureComponents[].CodeType
String
PossibleType of code sent in the code field.
RxNorm
UnsignedMedicationOrders[].MixtureComponents[].Dose.Quantity
String
PossibleAmount of this component added to the mixture
UnsignedMedicationOrders[].MixtureComponents[].Dose.Units
String
PossibleUnits of the component added to the mixture.
UCUM Units of Measure
UnsignedMedicationOrders[].Questions[]
Array of Objects
PossibleOrder-level questions
UnsignedMedicationOrders[].Questions[].Question
Object
ProbableInformation about the question
UnsignedMedicationOrders[].Questions[].Question.Code
String
ProbableCode for the question
UnsignedMedicationOrders[].Questions[].Question.Codeset
String
ProbableCode set used to identify the question
UnsignedMedicationOrders[].Questions[].Question.Description
String
ProbableDescription of the question
UnsignedMedicationOrders[].Questions[].Answer
Object
ProbableInformation about the answer
UnsignedMedicationOrders[].Questions[].Answer.Code
String
ProbableCode for the answer
UnsignedMedicationOrders[].Questions[].Answer.Codeset
String
ProbableCode set used to identify the answer
UnsignedMedicationOrders[].Questions[].Answer.Description
String
ProbableDescription of the answer
UnsignedMedicationOrders[].Notes[]
Array of Strings
PossibleOrder-level notes
UnsignedProcedureOrders
UnsignedProcedureOrders[]
Array of Objects
ReliableArray of unsigned procedure orders
UnsignedProcedureOrders[].Code
String
ReliableCode for the procedure
UnsignedProcedureOrders[].Codeset
String
ReliableCode set used to identify the procedure
UnsignedProcedureOrders[].Description
String
ReliableDescription of the procedure
UnsignedProcedureOrders[].Identifiers
Array of Objects
ReliableArray of identifiers for the procedure order
UnsignedProcedureOrders[].Identifiers[].ID
String
ReliableRequiredID of the procedure order
UnsignedProcedureOrders[].Identifiers[].IDType
Numeric
ReliableRequiredIDType of the procedure order
UnsignedProcedureOrders[].ScheduledDate
String
PossibleScheduled date of the procedure
UnsignedProcedureOrders[].Mode
String
ReliableMode in which the procedure order was created.
IP/OP
UnsignedProcedureOrders[].BodySite
Object
ProbableThe location on the body where the procedure was performed
UnsignedProcedureOrders[].BodySite.Code
String
ProbableCode
UnsignedProcedureOrders[].BodySite.Codeset
String
ProbableCode set
UnsignedProcedureOrders[].BodySite.Description
String
ProbableDescription
UnsignedProcedureOrders[].StartDate
String
ReliableWhen the procedure was started.
ISO 8601 Format
UnsignedProcedureOrders[].EndDate
String
ProbableWhen the procedure ended.
ISO 8601 Format
UnsignedProcedureOrders[].Questions[]
Array of Objects
PossibleOrder-level questions
UnsignedProcedureOrders[].Questions[].Question
Object
ProbableInformation about the question
UnsignedProcedureOrders[].Questions[].Question.Code
String
ProbableCode for the question
UnsignedProcedureOrders[].Questions[].Question.Codeset
String
ProbableCode set used to identify the question
UnsignedProcedureOrders[].Questions[].Question.Description
String
ProbableDescription of the question
UnsignedProcedureOrders[].Questions[].Answer
Object
ProbableInformation about the answer
UnsignedProcedureOrders[].Questions[].Answer.Code
String
ProbableCode for the answer
UnsignedProcedureOrders[].Questions[].Answer.Codeset
String
ProbableCode set used to identify the answer
UnsignedProcedureOrders[].Questions[].Answer.Description
String
ProbableDescription of the answer
UnsignedProcedureOrders[].Notes[]
Array of Strings
PossibleOrder-level notes
{
"Meta": {
"DataModel": "Clinical Decisions",
"EventType": "Request",
"EventDateTime": "2023-05-23T13:49:48.036Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"FacilityCode": null
},
"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": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": []
},
"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"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+13145554321"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"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"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"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": []
}
]
}
Responselink
BETAThis event type contains CDS advisories for the provider to review and include during the clinical decisioning process.
Fields
Meta
Meta.DataModel
String
ReliableRequiredClinical Decisions
Meta.EventType
String
ReliableRequiredResponse
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Advisories
Advisories[]
Array of Objects
PossibleThe array of returned CDS advisories.
Advisories[].ShowAlert
Boolean
PossibleThis flag indicates whether a CDS alert is shown to the provider while they're placing an order in the EHR system. If the CDS alert shouldn't be visible in the EHR system, set this value to
false
. But keep in mind that if this isfalse
, the provider won't see an alert while placing an order.
True / False
Advisories[].Session
String
PossibleRequiredThis is the session ID that matches the original order to the support response.
Advisories[].RemovableUnsignedOrders[]
Array of Objects
PossibleAn array of unsigned orders suggested for removal.
Advisories[].RemovableUnsignedOrders[].ID
String
PossibleID of the order suggested for removal.
Advisories[].RemovableUnsignedOrders[].IDType
String
PossibleID type of the order suggested for removal.
Advisories[].RemovableUnsignedOrders[].Title
String
PossibleTitle of the order suggested for removal.
Advisories[].AdditionalUnsignedOrders[]
Array of Objects
PossibleAn array of additional unsigned orders suggested.
Advisories[].AdditionalUnsignedOrders[].ID
String
PossibleID of the additional order suggested.
Advisories[].AdditionalUnsignedOrders[].IDType
String
PossibleIDType of the additional order suggested.
Advisories[].AdditionalUnsignedOrders[].Title
String
PossibleTitle of the additional order suggested.
Advisories[].AdditionalUnsignedOrders[].Questions[]
Array of Objects
ProbableAn array of questions that correspond to any custom Ask at Order Entry (AOE) questions the provider may have filled out when placing an order. If the CDS workflow is triggered when the provider places a medication or procedure order, the healthcare organization can configure AOE questions to appear for certain orders to ensure the third-party app responding to the CDS request has all of the data it needs.
Advisories[].AdditionalUnsignedOrders[].Questions[].Code
String
ProbableCode
Advisories[].AdditionalUnsignedOrders[].Questions[].Codeset
String
ProbableCode set
Advisories[].AdditionalUnsignedOrders[].Questions[].Description
String
ProbableDescription
Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[]
Array of Objects
ProbablePossible answers for the question.
Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[].Code
String
ProbableCode
Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[].Codeset
String
ProbableCode set
Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[].Description
String
ProbableDescription
Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[].Comment
String
PossibleA comment regarding the answer.
Advisories[].Description
String
PossibleDisplays the CDS text for the provider to review while placing an order. This text description only displays when the
Advisories[].ShowAlert
field is set totrue
.
Advisories[].Notes[]
Array of Strings
PossibleNotes on processing next steps.
Advisories[].Notes[].Text
String
Possible
Advisories[].Notes[].Display
String
Possible
Advisories[].AdditionalInfo[].DecisionSupport
Object
ReliableProvide additional information
Advisories[].AdditionalInfo[].DecisionSupport.Code
String
ReliableCode for the additional information
Advisories[].AdditionalInfo[].DecisionSupport.Codeset
String
ReliableCode set used to identify the additional information
Advisories[].AdditionalInfo[].DecisionSupport.Description
String
ReliableDescription of the additional information
Advisories[].AdditionalInfo[].Link
String
PossibleMay contain an external link for the provider to access and enter additional information pertaining to the clinical decision.
Advisories[].Errors[]
Array of Objects
ReliableProvide Error codes and display the reason.
Advisories[].Errors[].Code
String
ReliableCode for the errors
Advisories[].Errors[].Codeset
String
ReliableCode set used to identify the errors
Advisories[].Errors[].Description
String
ReliableDescription of the errors
{
"Meta": {
"DataModel": "Clinical Decisions",
"EventType": "Response",
"EventDateTime": "2023-05-23T13:49:48.036Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"FacilityCode": null
},
"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."
},
"Link": "https://examplelink"
}
],
"Errors": [
{
"Code": null,
"Codeset": null,
"Description": null
}
]
}
]
}