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, stringReliable
Order
- EventTyperequired, stringReliable
GroupedOrders
- EventDateTimestring, nullReliable
Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format - Testboolean, nullReliable
Indicates whether the request is a test or not.
- Sourceobject
Contains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox- IDstring, nullReliable
Identifies 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, nullReliable
Displays the name of the system initiating the message.
- DestinationsArray of object
Contains 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, nullReliable
Identifies the endpoint that the request is directed to.
UUID - Namestring, nullReliable
Displays the name of the endpoint that the request is directed to.
- LogsArray of object
Contains the log identifier(s) for the request.
- IDstring, nullReliable
Identifies 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, nullReliable
Identifies the request log attempt value, which is useful when retries are possible.
UUID
- FacilityCodestring, nullPossible
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.
- Patientrequired, object
- Identifiersrequired, Array of object
List of IDs and ID types that identify the patient
- IDrequired, stringReliable
ID for the patient
- IDTyperequired, stringReliable
Type of ID.
E.g. MRN, EPI
- Demographicsobject
- FirstNamestring, nullReliable
Patient's first name
- MiddleNamestring, nullPossible
Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- LastNamestring, nullReliable
Patient's last name
- DOBstring, nullReliable
Patient's date of birth.
In ISO 8601 format - SSNstring, nullProbable
Patient's social security number
- Sexstring, nullReliableValue Set
Patient's sex
- Racestring, nullPossibleValue Set
Patient's race
- IsHispanicboolean, nullPossibleValue Set
Indicates if the patient is of hispanic origin.
- Religionstring, nullPossibleValue Set
Patient's religious affiliation
- MaritalStatusstring, nullPossibleValue Set
Patient's marital status
- IsDeceasedboolean, nullPossible
Indicates if the patient is deceased
- DeathDateTimestring, nullPossible
Date and Time the patient was proclaimed deceased.
ISO 8601 Format - PhoneNumberobject
- Homestring, nullProbable
Patient's home phone number.
In E. 164 Format. (e.g. +16085551234) - Officestring, nullProbable
Patient's office phone number.
In E. 164 Format. (e.g. +16085551234) - Mobilestring, nullProbable
Patient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
- EmailAddressesArray of string
Patient's email address(es)
- Languagestring, nullPossibleValue Set
Patient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values - CitizenshipArray of string
Patient's nation(s) of citizenship.
In ISO 3166 alpha 2 format (e.g. 'US'). - Addressobject
Patient's home address
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- NotesArray of string
Patient-level notes
- Ordersrequired, Array of object
- IDrequired, stringReliable
ID of the order assigned by the placing system
- Statusrequired, stringReliableValue Set
The status of an order.
- ApplicationOrderIDstring, nullPossible
ID assigned by the application fulfilling the order
- TransactionDateTimestring, nullReliable
DateTime the order was placed
- CollectionDateTimestring, nullProbable
DateTime the specimen was collected
- Specimenobject
- Sourcestring, nullProbable
Source of the specimen
- BodySitestring, nullProbable
Body site from which the specimen was collected
- IDstring, nullPossible
ID of the collected specimen
- Procedureobject
Procedure that was ordered
- Codestring, nullReliable
Code for the procedure
- Codesetstring, nullReliable
Code 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, nullReliable
Description of the procedure
- Providerobject
- NPIstring, nullPossible
NPI of the ordering provider
- IDstring, nullPossible
ID of the ordering provider.
This ID is often required for Inpatient Visits. - IDTypestring, nullPossible
ID type of the ID for the ordering provider
- FirstNamestring, nullPossible
First name of the ordering provider
- LastNamestring, nullPossible
Last name of the ordering provider
- CredentialsArray of string
List of credentials for the ordering provider.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136
- ResultCopyProvidersArray of object
Array of providers to be copied on the results.
- NPIstring, nullPossible
NPI of the copied provider
- IDstring, nullPossible
ID of the copied provider.
This ID is often required for Inpatient Visits. - IDTypestring, nullPossible
ID type of the ID for the copied provider
- FirstNamestring, nullPossible
First name of the copied provider
- LastNamestring, nullPossible
Last name of the copied provider
- CredentialsArray of string
List of credentials for the copied provider.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136
- OrderingFacilityobject
- Namestring, nullPossible
Name of the facility this order was placed in
- Addressobject
Ordering facility's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberstring, nullPossible
Ordering facility's phone number.
In E. 164 Format. (i.e. +16085551234)
- Prioritystring, nullReliableValue Set
Priority of the order
- Commentsstring, nullPossible
Clinically relevant comments regarding the order
- NotesArray of string
Order-level notes
- DiagnosesArray of object
List of diagnoses associated with this order
- Codestring, nullProbable
Code for the diagnosis
- Codesetstring, nullProbableValue Set
Code set used to identify the diagnosis.
One of the following: ICD-9, ICD-10, HCPCS, CPT - Namestring, nullProbable
Name of the diagnosis
- Typestring, nullPossibleValue Set
Type of the diagnosis
- DocumentedDateTimestring, nullPossible
DateTime the diagnosis was documented.
ISO 8601 Format
- ClinicalInfoArray of object
List of supplementary clinical information associated with the order. Often these are answers to Ask at Order Entry (AOE) questions.
- Codestring, nullProbable
Code for the information element
- Codesetstring, nullProbable
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. - Descriptionstring, nullProbable
Description of the information element.
For AOEs, this is typically the text of the AOE question - Valuestring, nullReliable
Value of the information element.
For AOEs, this is typically the full answer - Unitsstring, nullPossible
Units of the value.
If the Value is a time range, this may be "WK" - Abbreviationstring, nullProbable
Abbreviation of the value of the information element.
Typically only present for text answer AOEs - NotesArray of string
Notes related to the clinical info
- Visitobject
- VisitNumberstring, nullReliable
Visit Number
- AccountNumberstring, nullPossible
Account Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc. - PatientClassstring, nullProbable
Patient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency - VisitDateTimestring, nullPossible
DateTime of visit or the arrival time of the visit or admission.
ISO 8601 Format - AttendingProviderobject
- IDstring, nullProbable
ID of the attending provider.
This ID is often required for Inpatient Visits. - IDTypestring, nullProbable
ID type of the ID for the attending provider
- FirstNamestring, nullPossible
First name of the attending provider
- LastNamestring, nullPossible
Last name of the attending provider
- CredentialsArray of string
List of credentials for the attending provider.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136
- ConsultingProviderobject
- IDstring, nullPossible
ID of the consulting provider.
This ID is often required for Inpatient Visits. - IDTypestring, nullPossible
ID type of the ID for the consulting provider
- FirstNamestring, nullPossible
First name of the consulting provider
- LastNamestring, nullPossible
Last name of the consulting provider
- CredentialsArray of string
List of credentials for the consulting provider.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136
- ReferringProviderobject
- IDstring, nullPossible
ID of the referring provider.
This ID is often required for Inpatient Visits. - IDTypestring, nullPossible
ID type of the ID for the referring provider
- FirstNamestring, nullPossible
First name of the referring provider
- LastNamestring, nullPossible
Last name of the referring provider
- CredentialsArray of string
List of credentials for the referring provider.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136
- Guarantorobject
Person ultimately responsible for the bill of the appointment
- Numberstring, nullProbable
Number of the guarantor
- FirstNamestring, nullProbable
First name
- MiddleNamestring, nullPossible
Middle name
- LastNamestring, nullProbable
Last name
- SSNstring, nullPossible
Guarantor's social security number
- DOBstring, nullPossible
Guarantor's date of birth.
In ISO 8601 format - Sexstring, nullPossibleValue Set
Guarantor's sex.
One of the following: Female, Male, Unknown, Other - Spouseobject
- FirstNamestring, nullProbable
Spouse's first name
- LastNamestring, nullProbable
Spouse's last name
- Addressobject
Address of the guarantor
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberobject
- Homestring, nullProbable
Home phone number.
In E. 164 Format (i.e. +16085551234) - Businessstring, nullProbable
Business phone number.
In E. 164 Format (i.e. +16085551234) - Mobilestring, nullProbable
Mobile phone number.
In E. 164 Format (i.e. +16085551234)
- EmailAddressesArray of string
Guarantor's email address(es)
- Typestring, nullProbable
Type of guarantor.
E.g. institution, individual - RelationToPatientstring, nullProbableValue Set
Relation to the patient
- Employerobject
- Namestring, nullProbable
Employer's name
- Addressobject
Employer's address
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberstring, nullProbable
Employer phone number.
In E. 164 Format (i.e. +16085551234)
- InsurancesArray of object
List of insurance coverages for the patient
- Planobject
- IDstring, nullProbable
Identifier of insurance plan
- IDTypestring, nullProbable
ID type of insurance plan
- Namestring, nullProbable
Name of insurance plan
- Typestring, nullPossible
Type of insurance plan
- MemberNumberstring, nullPossible
Patient member number
- Companyobject
- IDstring, nullProbable
ID of insurance company (payor)
- IDTypestring, nullProbable
ID type of insurance company (payor)
- Namestring, nullProbable
Name of insurance company (payor)
- Addressobject
Insurance company's address
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberstring, nullProbable
Insurance companys phone number.
In E. 164 Format (i.e. +16085551234)
- GroupNumberstring, nullProbable
Insurance policy group number
- GroupNamestring, nullProbable
Insurance policy group name
- EffectiveDatestring, nullProbable
Effect date of this insurance policy.
In YYYY-MM-DD format - ExpirationDatestring, nullProbable
Expiration date of this insurance policy.
In YYYY-MM-DD format - PolicyNumberstring, nullProbable
Insurance policy number
- Prioritystring, nullPossibleValue Set
The insurance priority sequence.
If the insurance works in conjunction with other insurance plans, this field contains priority sequence. - AgreementTypestring, nullProbableValue Set
Type of insurance agreement.
- CoverageTypestring, nullProbableValue Set
Type of insurance agreement.
Indicates who will be receiving the bill for the service. - Insuredobject
Individual who has the agreement with the insurance company for the related policy
- IdentifiersArray of object
List of IDs and ID types that identify the insured
- IDstring, nullPossible
ID for the insured
- IDTypestring, nullPossible
Type of ID.
E.g. MRN, EPI
- LastNamestring, nullPossible
Last name of the insured
- MiddleNamestring, nullPossible
Middle name of the insured
- FirstNamestring, nullPossible
First name of the insured
- SSNstring, nullPossible
Insured's social security number
- Relationshipstring, nullPossibleValue Set
Relationship of the insured to the patient
- DOBstring, nullPossible
Date of birth of the insured.
In YYYY-MM-DD format - Sexstring, nullPossibleValue Set
Sex of the insured
- Addressobject
Address of the insured
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- Locationobject
Location of the appointment
- Typestring, nullProbable
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullProbable
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullProbable
An ID specific to this facility
- IDTypestring, nullProbable
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullProbable
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullProbable
An ID specific to this department
- IDTypestring, nullProbable
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullProbable
Room.
Example: 136 - Bedstring, nullProbable
Bed.
Example: B