This data model allows providers to request services with instructions for a patient's treatment. The order is generally triggered when the provider places an order or when the provider releases it (e.g., after ordering, a clinician takes action on a worklist of pending orders).
Orders commonly contain lab orders. If so, the EHR system sends a message with an expected date and time when a practitioner places an order (e.g., glucose test). When a nurse doing lab rounds (inpatient) or at a collection center (outpatient) collects the specimen, the EHR might send Order.Update with additional information about the collection (e.g., collection user, collection date/time).
This data model has event types that allow you to:
- receive a notification for new, updated, canceled, or grouped orders; or
- query for and receive orders.
Receive a notification when multiple orders are sent in the same ordering session.
Request Body Schema
- Metarequired, object- DataModelrequired, stringReliableOrder 
- EventTyperequired, stringReliableGroupedOrders 
- EventDateTimestring, nullReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received. 
 ISO 8601 Format
- Testboolean, nullReliableIndicates whether the request is a test or not. 
- SourceobjectContains the information for the system initiating the message, including the source ID and name. 
 Included in messages from Redox- IDstring, nullReliableIdentifies 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
- Namestring, nullReliableDisplays the name of the system initiating the message. 
 
- DestinationsArray of objectContains 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.- IDstring, nullReliableIdentifies the endpoint that the request is directed to. 
 UUID
- Namestring, nullReliableDisplays the name of the endpoint that the request is directed to. 
 
- LogsArray of objectContains the log identifier(s) for the request. - IDstring, nullReliableIdentifies 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
- AttemptIDstring, nullReliableIdentifies the request log attempt value, which is useful when retries are possible. 
 UUID
 
- FacilityCodestring, nullPossibleCode 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.
 
- Patientrequired, object- Identifiersrequired, Array of objectList of IDs and ID types that identify the patient - IDrequired, stringReliableID for the patient 
- IDTyperequired, stringReliableType of ID. 
 E.g. MRN, EPI
 
- Demographicsobject- FirstNamestring, nullReliablePatient's first name 
- MiddleNamestring, nullPossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field. 
- LastNamestring, nullReliablePatient's last name 
- DOBstring, nullReliablePatient's date of birth. 
 In ISO 8601 format
- SSNstring, nullProbablePatient's social security number 
- Sexstring, nullReliableValue SetPatient's sex 
- Racestring, nullPossibleValue SetPatient's race 
- IsHispanicboolean, nullPossibleValue SetIndicates if the patient is of hispanic origin. 
- Religionstring, nullPossibleValue SetPatient's religious affiliation 
- MaritalStatusstring, nullPossibleValue SetPatient's marital status 
- IsDeceasedboolean, nullPossibleIndicates if the patient is deceased 
- DeathDateTimestring, nullPossibleDate and Time the patient was proclaimed deceased. 
 ISO 8601 Format
- PhoneNumberobject- Homestring, nullProbablePatient's home phone number. 
 In E. 164 Format. (e.g. +16085551234)
- Officestring, nullProbablePatient's office phone number. 
 In E. 164 Format. (e.g. +16085551234)
- Mobilestring, nullProbablePatient's mobile phone number. 
 In E. 164 Format. (e.g. +16085551234)
 
- EmailAddressesArray of stringPatient's email address(es) 
- Languagestring, nullPossibleValue SetPatient's primary spoken language. 
 In ISO 639-1 alpha values (e.g. 'en'). Supported Values
- CitizenshipArray of stringPatient's nation(s) of citizenship. 
 In ISO 3166 alpha 2 format (e.g. 'US').
- AddressobjectPatient's home address - StreetAddressstring, nullProbableStreet address 
- Citystring, nullProbableCity 
- Statestring, nullProbableState 
- ZIPstring, nullProbableZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
 
- NotesArray of stringPatient-level notes 
 
- Ordersrequired, Array of object- IDrequired, stringReliableID of the order assigned by the placing system 
- Statusrequired, stringReliableValue SetThe status of an order. 
- ApplicationOrderIDstring, nullPossibleID assigned by the application fulfilling the order 
- TransactionDateTimestring, nullReliableDateTime the order was placed 
- CollectionDateTimestring, nullProbableDateTime the specimen was collected 
- Specimenobject- Sourcestring, nullProbableSource of the specimen 
- BodySitestring, nullProbableBody site from which the specimen was collected 
- IDstring, nullPossibleID of the collected specimen 
 
- ProcedureobjectProcedure that was ordered - Codestring, nullReliableCode for the procedure 
- Codesetstring, nullReliableCode set used to identify the procedure. 
 CPT, HCPCS, SNOMED, or LOINC. If no code set is specified, a health system specific identifier is being used.
- Descriptionstring, nullReliableDescription of the procedure 
 
- Providerobject- NPIstring, nullPossibleNPI of the ordering provider 
- IDstring, nullPossibleID of the ordering provider. 
 This ID is often required for Inpatient Visits.
- IDTypestring, nullPossibleID type of the ID for the ordering provider 
- FirstNamestring, nullPossibleFirst name of the ordering provider 
- LastNamestring, nullPossibleLast name of the ordering provider 
- CredentialsArray of stringList of credentials for the ordering provider. 
 e.g. MD, PhD
- AddressobjectProvider's address - StreetAddressstring, nullPossibleStreet address 
- Citystring, nullPossibleCity 
- Statestring, nullPossibleState 
- ZIPstring, nullPossibleZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
- EmailAddressesArray of stringProvider's email address(es) 
- PhoneNumberobject- Officestring, nullPossibleProvider's office phone number. 
 In E. 164 Format. (e.g. +16085551234)
 
- LocationobjectProvider's location - Typestring, nullPossibleType of location. 
 Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Facilitystring, nullPossibleFacility. 
 Example: Community Hospital
- FacilityIdentifiersArray of objectList of IDs specific to this facility - IDstring, nullPossibleAn ID specific to this facility 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Departmentstring, nullPossibleDepartment 
- DepartmentIdentifiersArray of objectList of IDs specific to this department - IDstring, nullPossibleAn ID specific to this department 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Roomstring, nullPossibleRoom. 
 Example: 136
 
 
- ResultCopyProvidersArray of objectArray of providers to be copied on the results. - NPIstring, nullPossibleNPI of the copied provider 
- IDstring, nullPossibleID of the copied provider. 
 This ID is often required for Inpatient Visits.
- IDTypestring, nullPossibleID type of the ID for the copied provider 
- FirstNamestring, nullPossibleFirst name of the copied provider 
- LastNamestring, nullPossibleLast name of the copied provider 
- CredentialsArray of stringList of credentials for the copied provider. 
 e.g. MD, PhD
- AddressobjectProvider's address - StreetAddressstring, nullPossibleStreet address 
- Citystring, nullPossibleCity 
- Statestring, nullPossibleState 
- ZIPstring, nullPossibleZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
- EmailAddressesArray of stringProvider's email address(es) 
- PhoneNumberobject- Officestring, nullPossibleProvider's office phone number. 
 In E. 164 Format. (e.g. +16085551234)
 
- LocationobjectProvider's location - Typestring, nullPossibleType of location. 
 Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Facilitystring, nullPossibleFacility. 
 Example: Community Hospital
- FacilityIdentifiersArray of objectList of IDs specific to this facility - IDstring, nullPossibleAn ID specific to this facility 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Departmentstring, nullPossibleDepartment 
- DepartmentIdentifiersArray of objectList of IDs specific to this department - IDstring, nullPossibleAn ID specific to this department 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Roomstring, nullPossibleRoom. 
 Example: 136
 
 
- OrderingFacilityobject- Namestring, nullPossibleName of the facility this order was placed in 
- AddressobjectOrdering facility's address - StreetAddressstring, nullPossibleStreet address 
- Citystring, nullPossibleCity 
- Statestring, nullPossibleState 
- ZIPstring, nullPossibleZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
- PhoneNumberstring, nullPossibleOrdering facility's phone number. 
 In E. 164 Format. (i.e. +16085551234)
 
- Prioritystring, nullReliableValue SetPriority of the order 
- Commentsstring, nullPossibleClinically relevant comments regarding the order 
- NotesArray of stringOrder-level notes 
- DiagnosesArray of objectList of diagnoses associated with this order - Codestring, nullProbableCode for the diagnosis 
- Codesetstring, nullProbableValue SetCode set used to identify the diagnosis. 
 One of the following: ICD-9, ICD-10, HCPCS, CPT
- Namestring, nullProbableName of the diagnosis 
- Typestring, nullPossibleValue SetType of the diagnosis 
- DocumentedDateTimestring, nullPossibleDateTime the diagnosis was documented. 
 ISO 8601 Format
 
- ClinicalInfoArray of objectList of supplementary clinical information associated with the order. Often these are answers to Ask at Order Entry (AOE) questions. - Codestring, nullProbableCode for the information element 
- Codesetstring, nullProbableCode set used to identify the information element. 
 Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.
- Descriptionstring, nullProbableDescription of the information element. 
 For AOEs, this is typically the text of the AOE question
- Valuestring, nullReliableValue of the information element. 
 For AOEs, this is typically the full answer
- Unitsstring, nullPossibleUnits of the value. 
 If the Value is a time range, this may be "WK"
- Abbreviationstring, nullProbableAbbreviation of the value of the information element. 
 Typically only present for text answer AOEs
- NotesArray of stringNotes related to the clinical info 
 
 
- Visitobject- VisitNumberstring, nullReliableVisit Number 
- AccountNumberstring, nullPossibleAccount Number. 
 An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
- PatientClassstring, nullProbablePatient class is used in many EHRs to determine where to put the patient. 
 Examples: Inpatient, Outpatient, Emergency
- VisitDateTimestring, nullPossibleDateTime of visit or the arrival time of the visit or admission. 
 ISO 8601 Format
- AttendingProviderobject- IDstring, nullProbableID of the attending provider. 
 This ID is often required for Inpatient Visits.
- IDTypestring, nullProbableID type of the ID for the attending provider 
- FirstNamestring, nullPossibleFirst name of the attending provider 
- LastNamestring, nullPossibleLast name of the attending provider 
- CredentialsArray of stringList of credentials for the attending provider. 
 e.g. MD, PhD
- AddressobjectProvider's address - StreetAddressstring, nullPossibleStreet address 
- Citystring, nullPossibleCity 
- Statestring, nullPossibleState 
- ZIPstring, nullPossibleZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
- EmailAddressesArray of stringProvider's email address(es) 
- PhoneNumberobject- Officestring, nullPossibleProvider's office phone number. 
 In E. 164 Format. (e.g. +16085551234)
 
- LocationobjectProvider's location - Typestring, nullPossibleType of location. 
 Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Facilitystring, nullPossibleFacility. 
 Example: Community Hospital
- FacilityIdentifiersArray of objectList of IDs specific to this facility - IDstring, nullPossibleAn ID specific to this facility 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Departmentstring, nullPossibleDepartment 
- DepartmentIdentifiersArray of objectList of IDs specific to this department - IDstring, nullPossibleAn ID specific to this department 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Roomstring, nullPossibleRoom. 
 Example: 136
 
 
- ConsultingProviderobject- IDstring, nullPossibleID of the consulting provider. 
 This ID is often required for Inpatient Visits.
- IDTypestring, nullPossibleID type of the ID for the consulting provider 
- FirstNamestring, nullPossibleFirst name of the consulting provider 
- LastNamestring, nullPossibleLast name of the consulting provider 
- CredentialsArray of stringList of credentials for the consulting provider. 
 e.g. MD, PhD
- AddressobjectProvider's address - StreetAddressstring, nullPossibleStreet address 
- Citystring, nullPossibleCity 
- Statestring, nullPossibleState 
- ZIPstring, nullPossibleZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
- EmailAddressesArray of stringProvider's email address(es) 
- PhoneNumberobject- Officestring, nullPossibleProvider's office phone number. 
 In E. 164 Format. (e.g. +16085551234)
 
- LocationobjectProvider's location - Typestring, nullPossibleType of location. 
 Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Facilitystring, nullPossibleFacility. 
 Example: Community Hospital
- FacilityIdentifiersArray of objectList of IDs specific to this facility - IDstring, nullPossibleAn ID specific to this facility 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Departmentstring, nullPossibleDepartment 
- DepartmentIdentifiersArray of objectList of IDs specific to this department - IDstring, nullPossibleAn ID specific to this department 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Roomstring, nullPossibleRoom. 
 Example: 136
 
 
- ReferringProviderobject- IDstring, nullPossibleID of the referring provider. 
 This ID is often required for Inpatient Visits.
- IDTypestring, nullPossibleID type of the ID for the referring provider 
- FirstNamestring, nullPossibleFirst name of the referring provider 
- LastNamestring, nullPossibleLast name of the referring provider 
- CredentialsArray of stringList of credentials for the referring provider. 
 e.g. MD, PhD
- AddressobjectProvider's address - StreetAddressstring, nullPossibleStreet address 
- Citystring, nullPossibleCity 
- Statestring, nullPossibleState 
- ZIPstring, nullPossibleZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
- EmailAddressesArray of stringProvider's email address(es) 
- PhoneNumberobject- Officestring, nullPossibleProvider's office phone number. 
 In E. 164 Format. (e.g. +16085551234)
 
- LocationobjectProvider's location - Typestring, nullPossibleType of location. 
 Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Facilitystring, nullPossibleFacility. 
 Example: Community Hospital
- FacilityIdentifiersArray of objectList of IDs specific to this facility - IDstring, nullPossibleAn ID specific to this facility 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Departmentstring, nullPossibleDepartment 
- DepartmentIdentifiersArray of objectList of IDs specific to this department - IDstring, nullPossibleAn ID specific to this department 
- IDTypestring, nullPossibleThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Roomstring, nullPossibleRoom. 
 Example: 136
 
 
- GuarantorobjectPerson ultimately responsible for the bill of the appointment - Numberstring, nullProbableNumber of the guarantor 
- FirstNamestring, nullProbableFirst name 
- MiddleNamestring, nullPossibleMiddle name 
- LastNamestring, nullProbableLast name 
- SSNstring, nullPossibleGuarantor's social security number 
- DOBstring, nullPossibleGuarantor's date of birth. 
 In ISO 8601 format
- Sexstring, nullPossibleValue SetGuarantor's sex. 
 One of the following: Female, Male, Unknown, Other
- Spouseobject- FirstNamestring, nullProbableSpouse's first name 
- LastNamestring, nullProbableSpouse's last name 
 
- AddressobjectAddress of the guarantor - StreetAddressstring, nullProbableStreet address 
- Citystring, nullProbableCity 
- Statestring, nullProbableState 
- ZIPstring, nullProbableZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
- PhoneNumberobject- Homestring, nullProbableHome phone number. 
 In E. 164 Format (i.e. +16085551234)
- Businessstring, nullProbableBusiness phone number. 
 In E. 164 Format (i.e. +16085551234)
- Mobilestring, nullProbableMobile phone number. 
 In E. 164 Format (i.e. +16085551234)
 
- EmailAddressesArray of stringGuarantor's email address(es) 
- Typestring, nullProbableType of guarantor. 
 E.g. institution, individual
- RelationToPatientstring, nullProbableValue SetRelation to the patient 
- Employerobject- Namestring, nullProbableEmployer's name 
- AddressobjectEmployer's address - StreetAddressstring, nullProbableStreet address 
- Citystring, nullProbableCity 
- Statestring, nullProbableState 
- ZIPstring, nullProbableZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
- PhoneNumberstring, nullProbableEmployer phone number. 
 In E. 164 Format (i.e. +16085551234)
 
 
- InsurancesArray of objectList of insurance coverages for the patient - Planobject- IDstring, nullProbableIdentifier of insurance plan 
- IDTypestring, nullProbableID type of insurance plan 
- Namestring, nullProbableName of insurance plan 
- Typestring, nullPossibleType of insurance plan 
 
- MemberNumberstring, nullPossiblePatient member number 
- Companyobject- IDstring, nullProbableID of insurance company (payor) 
- IDTypestring, nullProbableID type of insurance company (payor) 
- Namestring, nullProbableName of insurance company (payor) 
- AddressobjectInsurance company's address - StreetAddressstring, nullProbableStreet address 
- Citystring, nullProbableCity 
- Statestring, nullProbableState 
- ZIPstring, nullProbableZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
- PhoneNumberstring, nullProbableInsurance companys phone number. 
 In E. 164 Format (i.e. +16085551234)
 
- GroupNumberstring, nullProbableInsurance policy group number 
- GroupNamestring, nullProbableInsurance policy group name 
- EffectiveDatestring, nullProbableEffect date of this insurance policy. 
 In YYYY-MM-DD format
- ExpirationDatestring, nullProbableExpiration date of this insurance policy. 
 In YYYY-MM-DD format
- PolicyNumberstring, nullProbableInsurance policy number 
- Prioritystring, nullPossibleValue SetThe insurance priority sequence. 
 If the insurance works in conjunction with other insurance plans, this field contains priority sequence.
- AgreementTypestring, nullProbableValue SetType of insurance agreement. 
- CoverageTypestring, nullProbableValue SetType of insurance agreement. 
 Indicates who will be receiving the bill for the service.
- InsuredobjectIndividual who has the agreement with the insurance company for the related policy - IdentifiersArray of objectList of IDs and ID types that identify the insured - IDstring, nullPossibleID for the insured 
- IDTypestring, nullPossibleType of ID. 
 E.g. MRN, EPI
 
- LastNamestring, nullPossibleLast name of the insured 
- MiddleNamestring, nullPossibleMiddle name of the insured 
- FirstNamestring, nullPossibleFirst name of the insured 
- SSNstring, nullPossibleInsured's social security number 
- Relationshipstring, nullPossibleValue SetRelationship of the insured to the patient 
- DOBstring, nullPossibleDate of birth of the insured. 
 In YYYY-MM-DD format
- Sexstring, nullPossibleValue SetSex of the insured 
- AddressobjectAddress of the insured - StreetAddressstring, nullProbableStreet address 
- Citystring, nullProbableCity 
- Statestring, nullProbableState 
- ZIPstring, nullProbableZIP 
- Countystring, nullPossibleCounty 
- Countrystring, nullPossibleValue SetCountry 
 
 
 
- LocationobjectLocation of the appointment - Typestring, nullProbableType of location. 
 Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Facilitystring, nullProbableFacility. 
 Example: Community Hospital
- FacilityIdentifiersArray of objectList of IDs specific to this facility - IDstring, nullProbableAn ID specific to this facility 
- IDTypestring, nullProbableThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Departmentstring, nullProbableDepartment 
- DepartmentIdentifiersArray of objectList of IDs specific to this department - IDstring, nullProbableAn ID specific to this department 
- IDTypestring, nullProbableThe source or system to which this ID pertains. 
 Could be an OID or a human-readable name
 
- Roomstring, nullProbableRoom. 
 Example: 136
- Bedstring, nullProbableBed. 
 Example: B