This data model allows real-time notifications of medication information for patients, whether for new or existing prescriptions.
Mediation data varies across healthcare organizations. We normalize some of these differences for you, but you may see that one provider provides more or less details than another. We recommend being flexible with differences and do extensive testing during implementation to verify that you don't have any issues with the varying levels of medication data.
If you're looking for a list of current medications, review the ClinicalSummary data model.
This data model has event types that allow you to:
- request a new medication for a patient;
- update or cancel an existing prescription for a patient; or
- record when a patient receives a medication.
Record that a patient has received a medication.
Request Body Schema
- Metarequired, object
- DataModelrequired, stringReliable
Medications
- EventTyperequired, stringReliable
Administration
- 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
- Administrationsrequired, Array of object
Medication Administrations documented as part of this event
- Statusrequired, stringReliable
If the medication was administered the status will be "Complete". This Event can also be used to indicate that a medication was partially given or refused.
Must be eitherComplete
,Refused
, orPartially Administered
- Medicationrequired, object
Data about the particular product administered, including dose and route.
- Productrequired, object
- Coderequired, stringReliable
A code describing the actual medication given.
Redox recommends using RxNorm - CodeSystemstring, nullReliable
ID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present. - CodeSystemNamestring, nullReliable
Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present. - Namestring, nullReliable
Name of the actual medication given
- AltCodesArray of object
Alternate or translation codes for the actual medication given
- Codestring, nullPossible
A code describing the actual medication given
- CodeSystemstring, nullPossible
ID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present. - CodeSystemNamestring, nullPossible
Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present. - Namestring, nullPossible
Name of the actual medication given
- Strengthobject
- Quantitynumber, nullPossible
The size of the strength for the medication product.
- Unitsstring, nullPossible
The units of the medication product strength.
UCUM Units of Measure
- Typestring, nullPossible
The type of product
- Orderobject
- IDstring, nullProbable
An identifier for the order that resulted in this administration.
- LotNumberstring, nullProbable
Lot number of the medication administered.
- Doseobject
- Quantitynumber, nullProbable
The size of the dose for pills, capsules, etc.
- Unitsstring, nullProbable
The units of the dose.
UCUM Units of Measure
- Rateobject
- Quantitynumber, nullProbable
If the medication is in liquid form, the rate at which it is administered
- Unitsstring, nullProbable
Units for the rate.
UCUM Units of Measure
- Routeobject
- Codestring, nullProbable
A code describing the method by which the medication is delivered.
Medication Route FDA Value Set - CodeSystemstring, nullProbable
ID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present. - CodeSystemNamestring, nullProbable
Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present. - Namestring, nullProbable
Name of the method by which the medication is delivered
- AltCodesArray of object
Alternate or translation codes for the method by which the medication is delivered
- Codestring, nullPossible
A code describing the method by which the medication is delivered
- CodeSystemstring, nullPossible
ID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present. - CodeSystemNamestring, nullPossible
Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present. - Namestring, nullPossible
Name of the method by which the medication is delivered
- ComponentsArray of object
The components of the medication
- Codestring, nullPossible
A code describing the components of the medication
- CodeSystemstring, nullPossible
ID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present. - CodeSystemNamestring, nullPossible
Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present. - Namestring, nullPossible
Name of the components of the medication
- Typestring, nullProbable
The type of component.
Allowed values are Base or Additive - Doseobject
- Quantitynumber, nullProbable
The size of the dose for the component.
- Unitsstring, nullProbable
The units of the dose.
UCUM Units of Measure
- IndicationsArray of object
This field identifies the condition or problem for which the drug/treatment was prescribed.
- Codestring, nullProbable
Code
- Codesetstring, nullProbable
Code set
- Descriptionstring, nullProbable
Description
- StartDatestring, nullReliable
When the administration started.
*ISO 8601 Format. In the event that the administration was * - EndDatestring, nullProbable
When the administration ended.
ISO 8601 Format - AdministeringProviderobject
- NPIstring, nullPossible
NPI of the The provider who actually administered the medication.
- IDstring, nullPossible
ID of the The provider who actually administered the medication.
This ID is often required for Inpatient Visits. - IDTypestring, nullPossible
ID type of the ID for the The provider who actually administered the medication.
- FirstNamestring, nullPossible
First name of the The provider who actually administered the medication.
- LastNamestring, nullPossible
Last name of the The provider who actually administered the medication.
- CredentialsArray of string
List of credentials for the The provider who actually administered the medication.
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
- OrderedByobject
- IDstring, nullPossible
ID of the The provider who actually entered the order.
This ID is often required for Inpatient Visits. - IDTypestring, nullPossible
ID type of the ID for the The provider who actually entered the order.
- FirstNamestring, nullPossible
First name of the The provider who actually entered the order.
- LastNamestring, nullPossible
Last name of the The provider who actually entered the order.
- CredentialsArray of string
List of credentials for the The provider who actually entered the order.
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
- VerifiedByobject
- IDstring, nullPossible
ID of the The pharmacist who verified the order.
This ID is often required for Inpatient Visits. - IDTypestring, nullPossible
ID type of the ID for the The pharmacist who verified the order.
- FirstNamestring, nullPossible
First name of the The pharmacist who verified the order.
- LastNamestring, nullPossible
Last name of the The pharmacist who verified the order.
- CredentialsArray of string
List of credentials for the The pharmacist who verified the order.
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
- Visitobject
The visit in which the medication administration was performed.
- VisitDateTimestring, nullProbable
DateTime of visit or the arrival time of the admission.
ISO 8601 Format - VisitNumberstring, nullProbable
Visit Number.
Unique ID of a single visit - AccountNumberstring, nullProbable
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 - Locationobject
Location of the visit
- 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
- 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
- ReferringProviderobject
- IDstring, nullProbable
ID of the referring provider.
This ID is often required for Inpatient Visits. - IDTypestring, nullProbable
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