Redox | Medications

Medications

The Medications data model allows real-time notification of new prescriptions and modifications or cancellations to existing ones, as well as medication administrations.

Keep in mind that medication data tends to vary quite a bit across healthcare organizations. We do what we can to normalize these differences for you, but you may see that one healthcare organization provides more or less details than another. We recommend being flexible with these differences and doing extensive testing during implementation to verify that you don't have any issues with the varying levels of medication data.

We don't currently support these event types: a) Dispense: Triggered as medication is dispensed or prescriptions are filled; b) Statement: Triggered when patients self-report medications they take; c) Renewal: Triggered when a patient requests a fill of a prescription. If you have use cases for these event types, talk to your Redox rep.

If you're looking for a list of a patient's current medications, check out the ClinicalSummary data model.

New
Update
Cancel
Administration

New

Indicates a new request for a medication to be dispensed for the given patient. This event type is usually triggered by a new prescription in the outpatient context or pharmacy verification of a new order in the inpatient context.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Medications
- Meta.EventType
  String
  Reliable
  Required
  New
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  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
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  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.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  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
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
- Patient.Identifiers[]
  Array of Objects
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- Patient.Demographics.LastName
  String
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  ValueSet
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  ValueSet
  Patient's race
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  ValueSet
  Indicates if the patient is of hispanic origin.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Religion
  String
  Possible
  ValueSet
  Patient's religious affiliation
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.MaritalStatus
  String
  Possible
  ValueSet
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  ValueSet
  Patient's primary spoken language
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  ValueSet
  Patient's nation(s) of citizenship
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes
- Patient.Allergies[]
  Array of Objects
  Probable
- Patient.Allergies[].Code
  String
  Probable
  A code describing the type of allergy intolerance this is (food, drug, etc.).
  SNOMED CT from Allergy/Adverse Event Type Value Set
- Patient.Allergies[].CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Name
  String
  Probable
  Name of the type of allergy intolerance this is (food, drug, etc.)
- Patient.Allergies[].AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the type of allergy intolerance this is (food, drug, etc.)
- Patient.Allergies[].AltCodes[].Code
  String
  Possible
  A code describing the type of allergy intolerance this is (food, drug, etc.)
- Patient.Allergies[].AltCodes[].CodeSystem
  String
  Possible
  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.
- Patient.Allergies[].AltCodes[].CodeSystemName
  String
  Possible
  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.
- Patient.Allergies[].AltCodes[].Name
  String
  Possible
  Name of the type of allergy intolerance this is (food, drug, etc.)
- Patient.Allergies[].Substance.Code
  String
  Probable
  A code describing the substance that causes the allergy/intolerance.
  RxNorm, SNOMED CT, NDF-RT, UNII
- Patient.Allergies[].Substance.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Substance.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Substance.Name
  String
  Probable
  Name of the substance that causes the allergy/intolerance
- Patient.Allergies[].Substance.AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the substance that causes the allergy/intolerance
- Patient.Allergies[].Substance.AltCodes[].Code
  String
  Possible
  A code describing the substance that causes the allergy/intolerance
- Patient.Allergies[].Substance.AltCodes[].CodeSystem
  String
  Possible
  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.
- Patient.Allergies[].Substance.AltCodes[].CodeSystemName
  String
  Possible
  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.
- Patient.Allergies[].Substance.AltCodes[].Name
  String
  Possible
  Name of the substance that causes the allergy/intolerance
- Patient.Allergies[].Reaction[]
  String
  Probable
  All the reactions caused by this particular substance.
  SNOMED CT
- Patient.Allergies[].Reaction[].Code
  String
  Probable
  A code describing the reaction caused by the allergy (dizziness, hives, etc.).
  SNOMED CT
- Patient.Allergies[].Reaction[].CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Reaction[].CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Reaction[].Name
  String
  Probable
  Name of the reaction caused by the allergy (dizziness, hives, etc.)
- Patient.Allergies[].Reaction[].AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the reaction caused by the allergy (dizziness, hives, etc.)
- Patient.Allergies[].Reaction[].AltCodes[].Code
  String
  Possible
  A code describing the reaction caused by the allergy (dizziness, hives, etc.)
- Patient.Allergies[].Reaction[].AltCodes[].CodeSystem
  String
  Possible
  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.
- Patient.Allergies[].Reaction[].AltCodes[].CodeSystemName
  String
  Possible
  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.
- Patient.Allergies[].Reaction[].AltCodes[].Name
  String
  Possible
  Name of the reaction caused by the allergy (dizziness, hives, etc.)
- Patient.Allergies[].Reaction[].Severity.Code
  String
  Probable
  A code describing a code for the severity of the reaction (moderate, severe, etc.).
  SNOMED CT
- Patient.Allergies[].Reaction[].Severity.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Reaction[].Severity.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Reaction[].Severity.Name
  String
  Probable
  Name of a code for the severity of the reaction (moderate, severe, etc.)
- Patient.Allergies[].Reaction[].Text
  String
  Probable
  Free text form of reactions to this substance, includes information that cannot be captured by coded value.
- Patient.Allergies[].Severity.Code
  String
  Probable
  A code describing a code for the severity of the reaction (moderate, severe, etc.).
  SNOMED CT. Note that when multiple reactions have different severities, the severity at the allergy[] level is generally the highest of all reaction severities. This field is no longer recommended for use, but is preserved for backwards compatibility.
- Patient.Allergies[].Severity.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Severity.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Severity.Name
  String
  Probable
  Name of a code for the severity of the reaction (moderate, severe, etc.).
- Patient.Allergies[].Criticality.Code
  String
  Probable
  A code describing a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
  SNOMED CT. Note this is a different concept than reaction severity.
- Patient.Allergies[].Criticality.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Criticality.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Criticality.Name
  String
  Probable
  Name of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
- Patient.Allergies[].Status.Code
  String
  Probable
  A code describing the current status of the allergy (active, historic, etc.).
  SNOMED CT (Active, Inactive, Resolved)
- Patient.Allergies[].Status.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Status.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Status.Name
  String
  Probable
  Name of the current status of the allergy (active, historic, etc.)
- Patient.Allergies[].StartDate
  String
  Probable
  When the allergy was first noted.
  ISO 8601 Format
- Patient.Allergies[].EndDate
  String
  Probable
  When the allergy was no longer a problem (if applicable).
  ISO 8601 Format
- Patient.Allergies[].Comment
  String
  Probable
  Free text comment about the allergy.
Visit
- Visit
  Object
  Possible
  The visit that relates to this medication.
- Visit.VisitDateTime
  String
  Possible
  DateTime of visit or the arrival time of the admission.
  ISO 8601 Format
- Visit.VisitNumber
  String
  Possible
  Visit Number.
  Unique ID of a single visit
- Visit.AccountNumber
  String
  Possible
  Account Number.
  An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
- Visit.PatientClass
  String
  Possible
  Patient class is used in many EHRs to determine where to put the patient.
  Examples: Inpatient, Outpatient, Emergency
- Visit.Location
  Object
  Possible
  Location of the visit
- Visit.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Visit.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Visit.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.Location.Department
  String
  Possible
  Department
- Visit.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Visit.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Visit.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.Location.Bed
  String
  Possible
  Bed.
  Example: B
- Visit.AttendingProvider.ID
  String
  Possible
  ID of the attending provider.
  This ID is often required for Inpatient Visits.
- Visit.AttendingProvider.IDType
  String
  Possible
  ID type of the ID for the attending provider
- Visit.AttendingProvider.FirstName
  String
  Possible
  First name of the attending provider
- Visit.AttendingProvider.LastName
  String
  Possible
  Last name of the attending provider
- Visit.AttendingProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the attending provider.
  e.g. MD, PhD
- Visit.AttendingProvider.Address
  Object
  Possible
  Provider's address
- Visit.AttendingProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.AttendingProvider.Address.City
  String
  Possible
  City
- Visit.AttendingProvider.Address.State
  String
  Possible
  State
- Visit.AttendingProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.AttendingProvider.Address.County
  String
  Possible
  County
- Visit.AttendingProvider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.AttendingProvider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Visit.AttendingProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.AttendingProvider.Location
  Object
  Possible
  Provider's location
- Visit.AttendingProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.AttendingProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.AttendingProvider.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.AttendingProvider.Location.Department
  String
  Possible
  Department
- Visit.AttendingProvider.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.AttendingProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.ReferringProvider.ID
  String
  Possible
  ID of the referring provider.
  This ID is often required for Inpatient Visits.
- Visit.ReferringProvider.IDType
  String
  Possible
  ID type of the ID for the referring provider
- Visit.ReferringProvider.FirstName
  String
  Possible
  First name of the referring provider
- Visit.ReferringProvider.LastName
  String
  Possible
  Last name of the referring provider
- Visit.ReferringProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the referring provider.
  e.g. MD, PhD
- Visit.ReferringProvider.Address
  Object
  Possible
  Provider's address
- Visit.ReferringProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.ReferringProvider.Address.City
  String
  Possible
  City
- Visit.ReferringProvider.Address.State
  String
  Possible
  State
- Visit.ReferringProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.ReferringProvider.Address.County
  String
  Possible
  County
- Visit.ReferringProvider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.ReferringProvider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Visit.ReferringProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.ReferringProvider.Location
  Object
  Possible
  Provider's location
- Visit.ReferringProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.ReferringProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.ReferringProvider.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.ReferringProvider.Location.Department
  String
  Possible
  Department
- Visit.ReferringProvider.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.ReferringProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.Insurances[]
  Array of Objects
  Probable
  List of insurance coverages for the patient that should be used for the medication.
- Visit.Insurances[].Plan.ID
  String
  Probable
  Identifier of insurance plan
- Visit.Insurances[].Plan.IDType
  String
  Probable
  ID type of insurance plan
- Visit.Insurances[].Plan.Name
  String
  Probable
  Name of insurance plan
- Visit.Insurances[].Plan.Type
  String
  Possible
  Type of insurance plan
- Visit.Insurances[].MemberNumber
  String
  Possible
  Patient member number
- Visit.Insurances[].Company.ID
  String
  Probable
  ID of insurance company (payor)
- Visit.Insurances[].Company.IDType
  String
  Probable
  ID type of insurance company (payor)
- Visit.Insurances[].Company.Name
  String
  Probable
  Name of insurance company (payor)
- Visit.Insurances[].Company.Address
  Object
  Probable
  Insurance company's address
- Visit.Insurances[].Company.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Insurances[].Company.Address.City
  String
  Probable
  City
- Visit.Insurances[].Company.Address.State
  String
  Probable
  State
- Visit.Insurances[].Company.Address.ZIP
  String
  Probable
  ZIP
- Visit.Insurances[].Company.Address.County
  String
  Possible
  County
- Visit.Insurances[].Company.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Company.PhoneNumber
  String
  Probable
  Insurance companys phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Insurances[].GroupNumber
  String
  Probable
  Insurance policy group number
- Visit.Insurances[].GroupName
  String
  Probable
  Insurance policy group name
- Visit.Insurances[].EffectiveDate
  String
  Probable
  Effect date of this insurance policy.
  In YYYY-MM-DD format
- Visit.Insurances[].ExpirationDate
  String
  Probable
  Expiration date of this insurance policy.
  In YYYY-MM-DD format
- Visit.Insurances[].PolicyNumber
  String
  Probable
  Insurance policy number
- Visit.Insurances[].Priority
  String
  Possible
  ValueSet
  The insurance priority sequence.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].AgreementType
  String
  Probable
  ValueSet
  Type of insurance agreement.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].CoverageType
  String
  Probable
  ValueSet
  Type of insurance agreement.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Insured
  Object
  Possible
  Individual who has the agreement with the insurance company for the related policy
- Visit.Insurances[].Insured.Identifiers[]
  Array of Objects
  Possible
  List of IDs and ID types that identify the insured
- Visit.Insurances[].Insured.Identifiers[].ID
  String
  Possible
  ID for the insured
- Visit.Insurances[].Insured.Identifiers[].IDType
  String
  Possible
  Type of ID.
  E.g. MRN, EPI
- Visit.Insurances[].Insured.LastName
  String
  Possible
  Last name of the insured
- Visit.Insurances[].Insured.MiddleName
  String
  Possible
  Middle name of the insured
- Visit.Insurances[].Insured.FirstName
  String
  Possible
  First name of the insured
- Visit.Insurances[].Insured.SSN
  String
  Possible
  Insured's social security number
- Visit.Insurances[].Insured.Relationship
  String
  Possible
  ValueSet
  Relationship of the insured to the patient
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Insured.DOB
  String
  Possible
  Date of birth of the insured.
  In YYYY-MM-DD format
- Visit.Insurances[].Insured.Sex
  String
  Possible
  ValueSet
  Sex of the insured
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Insured.Address
  Object
  Probable
  Address of the insured
- Visit.Insurances[].Insured.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Insurances[].Insured.Address.City
  String
  Probable
  City
- Visit.Insurances[].Insured.Address.State
  String
  Probable
  State
- Visit.Insurances[].Insured.Address.ZIP
  String
  Probable
  ZIP
- Visit.Insurances[].Insured.Address.County
  String
  Possible
  County
- Visit.Insurances[].Insured.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
Order
- Order.ID
  String
  Reliable
  Required
  ID assigned by the ordering system
- Order.Notes[]
  Array of Strings
  Possible
  Order-level notes
- Order.Medication.Dose.Quantity
  Numeric
  Probable
  The size of the dose for pills, capsules, etc.
- Order.Medication.Dose.Units
  String
  Probable
  The units of the dose.
  UCUM Units of Measure
- Order.Medication.Rate.Quantity
  Numeric
  Probable
  If the medication is in liquid form, the rate at which it is administered
- Order.Medication.Rate.Units
  String
  Probable
  Units for the rate.
  UCUM Units of Measure
- Order.Medication.Route.Code
  String
  Probable
  A code describing the method by which the medication is delivered.
  Medication Route FDA Value Set
- Order.Medication.Route.CodeSystem
  String
  Probable
  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.
- Order.Medication.Route.CodeSystemName
  String
  Probable
  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.
- Order.Medication.Route.Name
  String
  Probable
  Name of the method by which the medication is delivered
- Order.Medication.Route.AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the method by which the medication is delivered
- Order.Medication.Route.AltCodes[].Code
  String
  Possible
  A code describing the method by which the medication is delivered
- Order.Medication.Route.AltCodes[].CodeSystem
  String
  Possible
  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.
- Order.Medication.Route.AltCodes[].CodeSystemName
  String
  Possible
  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.
- Order.Medication.Route.AltCodes[].Name
  String
  Possible
  Name of the method by which the medication is delivered
- Order.Medication.Components[]
  Array of Objects
  Reliable
  The components of the medication
- Order.Medication.Components[].Code
  String
  Possible
  A code describing the components of the medication
- Order.Medication.Components[].CodeSystem
  String
  Possible
  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.
- Order.Medication.Components[].CodeSystemName
  String
  Possible
  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.
- Order.Medication.Components[].Name
  String
  Possible
  Name of the components of the medication
- Order.Medication.Components[].Type
  String
  Probable
  The type of component.
  Allowed values are Base or Additive
- Order.Medication.Components[].Dose.Quantity
  Numeric
  Probable
  The size of the dose for the component.
- Order.Medication.Components[].Dose.Units
  String
  Probable
  The units of the dose.
  UCUM Units of Measure
- Order.Medication.Product.Code
  String
  Reliable
  Required
  A code describing the actual medication given.
  Redox recommends using RxNorm
- Order.Medication.Product.CodeSystem
  String
  Reliable
  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.
- Order.Medication.Product.CodeSystemName
  String
  Reliable
  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.
- Order.Medication.Product.Name
  String
  Reliable
  Name of the actual medication given
- Order.Medication.Product.AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the actual medication given
- Order.Medication.Product.AltCodes[].Code
  String
  Possible
  A code describing the actual medication given
- Order.Medication.Product.AltCodes[].CodeSystem
  String
  Possible
  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.
- Order.Medication.Product.AltCodes[].CodeSystemName
  String
  Possible
  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.
- Order.Medication.Product.AltCodes[].Name
  String
  Possible
  Name of the actual medication given
- Order.Medication.Product.Strength.Quantity
  Numeric
  Possible
  The size of the strength for the medication product.
- Order.Medication.Product.Strength.Units
  String
  Possible
  The units of the medication product strength.
  UCUM Units of Measure
- Order.Medication.Product.Type
  String
  Possible
  The type of product
- Order.Medication.FreeTextSig
  String
  Possible
  Free text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication
- Order.Medication.StartDate
  String
  Reliable
  When the medication should be started.
  ISO 8601 Format
- Order.Medication.EndDate
  String
  Probable
  When the medication should be ended.
  ISO 8601 Format
- Order.Medication.Frequency.Period
  Numeric
  Probable
  How often the patient should be taking the medication
- Order.Medication.Frequency.Unit
  String
  Probable
  Units for how often the patient should be taking the medication.
  UCUM Units of Measure
- Order.Medication.IsPRN
  Boolean
  Probable
  Whether the medication is to be taken on an as-needed basis
- Order.Medication.Dispense.Amount
  Numeric
  Probable
  The amount to be dispensed
- Order.Medication.Dispense.Units
  String
  Probable
  Units for the dispensed amount
- Order.Medication.NumberOfRefillsRemaining
  Numeric
  Probable
  The number of authorized refills remaining on the prescription
- Order.Medication.TotalRefills
  Numeric
  Probable
  The total number of refills prescribed
- Order.Medication.LastRefillDate
  String
  Probable
  The date which the refill was last filled.
  ISO 8601 Format
- Order.Indications[]
  Array of Objects
  Probable
  This field identifies the condition or problem for which the drug/treatment was prescribed.
- Order.Indications[].Code
  String
  Probable
  Code
- Order.Indications[].Codeset
  String
  Probable
  Code set
- Order.Indications[].Description
  String
  Probable
  Description
- Order.Provider.NPI
  String
  Possible
  NPI of the Ordering provider who is licensed to prescribe medications.
- Order.Provider.ID
  String
  Possible
  ID of the Ordering provider who is licensed to prescribe medications.
  This ID is often required for Inpatient Visits.
- Order.Provider.IDType
  String
  Possible
  ID type of the ID for the Ordering provider who is licensed to prescribe medications.
- Order.Provider.FirstName
  String
  Possible
  First name of the Ordering provider who is licensed to prescribe medications.
- Order.Provider.LastName
  String
  Possible
  Last name of the Ordering provider who is licensed to prescribe medications.
- Order.Provider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the Ordering provider who is licensed to prescribe medications.
  e.g. MD, PhD
- Order.Provider.Address
  Object
  Possible
  Provider's address
- Order.Provider.Address.StreetAddress
  String
  Possible
  Street address
- Order.Provider.Address.City
  String
  Possible
  City
- Order.Provider.Address.State
  String
  Possible
  State
- Order.Provider.Address.ZIP
  String
  Possible
  ZIP
- Order.Provider.Address.County
  String
  Possible
  County
- Order.Provider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.Provider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Order.Provider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Order.Provider.Location
  Object
  Possible
  Provider's location
- Order.Provider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Order.Provider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Order.Provider.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Order.Provider.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Order.Provider.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.Provider.Location.Department
  String
  Possible
  Department
- Order.Provider.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Order.Provider.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Order.Provider.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.Provider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Order.EnteredBy.ID
  String
  Possible
  ID of the The provider who actually entered the order.
  This ID is often required for Inpatient Visits.
- Order.EnteredBy.IDType
  String
  Possible
  ID type of the ID for the The provider who actually entered the order.
- Order.EnteredBy.FirstName
  String
  Possible
  First name of the The provider who actually entered the order.
- Order.EnteredBy.LastName
  String
  Possible
  Last name of the The provider who actually entered the order.
- Order.EnteredBy.Credentials[]
  Array of Strings
  Possible
  List of credentials for the The provider who actually entered the order.
  e.g. MD, PhD
- Order.EnteredBy.Address
  Object
  Possible
  Provider's address
- Order.EnteredBy.Address.StreetAddress
  String
  Possible
  Street address
- Order.EnteredBy.Address.City
  String
  Possible
  City
- Order.EnteredBy.Address.State
  String
  Possible
  State
- Order.EnteredBy.Address.ZIP
  String
  Possible
  ZIP
- Order.EnteredBy.Address.County
  String
  Possible
  County
- Order.EnteredBy.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.EnteredBy.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Order.EnteredBy.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Order.EnteredBy.Location
  Object
  Possible
  Provider's location
- Order.EnteredBy.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Order.EnteredBy.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Order.EnteredBy.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Order.EnteredBy.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Order.EnteredBy.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.EnteredBy.Location.Department
  String
  Possible
  Department
- Order.EnteredBy.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Order.EnteredBy.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Order.EnteredBy.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.EnteredBy.Location.Room
  String
  Possible
  Room.
  Example: 136
- Order.VerifiedBy.ID
  String
  Possible
  ID of the The pharmacist who verified the order.
  This ID is often required for Inpatient Visits.
- Order.VerifiedBy.IDType
  String
  Possible
  ID type of the ID for the The pharmacist who verified the order.
- Order.VerifiedBy.FirstName
  String
  Possible
  First name of the The pharmacist who verified the order.
- Order.VerifiedBy.LastName
  String
  Possible
  Last name of the The pharmacist who verified the order.
- Order.VerifiedBy.Credentials[]
  Array of Strings
  Possible
  List of credentials for the The pharmacist who verified the order.
  e.g. MD, PhD
- Order.VerifiedBy.Address
  Object
  Possible
  Provider's address
- Order.VerifiedBy.Address.StreetAddress
  String
  Possible
  Street address
- Order.VerifiedBy.Address.City
  String
  Possible
  City
- Order.VerifiedBy.Address.State
  String
  Possible
  State
- Order.VerifiedBy.Address.ZIP
  String
  Possible
  ZIP
- Order.VerifiedBy.Address.County
  String
  Possible
  County
- Order.VerifiedBy.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.VerifiedBy.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Order.VerifiedBy.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Order.VerifiedBy.Location
  Object
  Possible
  Provider's location
- Order.VerifiedBy.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Order.VerifiedBy.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Order.VerifiedBy.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Order.VerifiedBy.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Order.VerifiedBy.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.VerifiedBy.Location.Department
  String
  Possible
  Department
- Order.VerifiedBy.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Order.VerifiedBy.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Order.VerifiedBy.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.VerifiedBy.Location.Room
  String
  Possible
  Room.
  Example: 136
- Order.Priority
  String
  Reliable
  ValueSet
  Priority of the order
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.Pharmacy
  Object
  Probable
  The pharmacy at which the medication should be dispensed.
- Order.Pharmacy.Code
  String
  Probable
  Code for the pharmacy
- Order.Pharmacy.Codeset
  String
  Probable
  Code set used to identify the pharmacy
- Order.Pharmacy.Description
  String
  Probable
  Description of the pharmacy
- Order.Pharmacy.Address
  Object
  Probable
  The physical location at which the medication should be dispensed.
- Order.Pharmacy.Address.StreetAddress
  String
  Probable
  Street address
- Order.Pharmacy.Address.City
  String
  Probable
  City
- Order.Pharmacy.Address.State
  String
  Probable
  State
- Order.Pharmacy.Address.ZIP
  String
  Probable
  ZIP
- Order.Pharmacy.Address.County
  String
  Possible
  County
- Order.Pharmacy.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.Pharmacy.PhoneNumber.Office
  String
  Possible
  Pharmacy's office phone number.
  In E. 164 Format. (e.g. +16085551234)

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Medications",
      "EventType": "New",
      "EventDateTime": "2024-04-15T21:22:43.979Z",
      "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
   },
   "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": [],
      "Allergies": [
         {
            "Code": "7982",
            "CodeSystem": null,
            "CodeSystemName": null,
            "Name": "Penicillin",
            "AltCodes": [],
            "Substance": {
               "Code": null,
               "CodeSystem": null,
               "CodeSystemName": null,
               "Name": null,
               "AltCodes": []
            },
            "Reaction": [
               {
                  "Code": "28926001",
                  "CodeSystem": null,
                  "CodeSystemName": null,
                  "Name": "Rash",
                  "AltCodes": [],
                  "Severity": {
                     "Code": null,
                     "CodeSystem": null,
                     "CodeSystemName": null,
                     "Name": null
                  },
                  "Text": null
               },
               {
                  "Code": "247472004",
                  "CodeSystem": null,
                  "CodeSystemName": null,
                  "Name": "Hives",
                  "AltCodes": [],
                  "Severity": {
                     "Code": null,
                     "CodeSystem": null,
                     "CodeSystemName": null,
                     "Name": null
                  },
                  "Text": null
               }
            ],
            "Severity": {
               "Code": null,
               "CodeSystem": null,
               "CodeSystemName": null,
               "Name": null
            },
            "Criticality": {
               "Code": null,
               "CodeSystem": null,
               "CodeSystemName": null,
               "Name": null
            },
            "Status": {
               "Code": null,
               "CodeSystem": null,
               "CodeSystemName": null,
               "Name": null
            },
            "StartDate": null,
            "EndDate": null,
            "Comment": null
         }
      ]
   },
   "Visit": {
      "VisitDateTime": "2024-04-15T21:22:44.620Z",
      "VisitNumber": "1234",
      "AccountNumber": null,
      "PatientClass": null,
      "Location": {
         "Type": null,
         "Facility": null,
         "FacilityIdentifiers": [],
         "Department": null,
         "DepartmentIdentifiers": [],
         "Room": null,
         "Bed": null
      },
      "AttendingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "FacilityIdentifiers": [],
            "Department": null,
            "DepartmentIdentifiers": [],
            "Room": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "FacilityIdentifiers": [],
            "Department": null,
            "DepartmentIdentifiers": [],
            "Room": null
         }
      },
      "Insurances": []
   },
   "Order": {
      "ID": "29f541bf-5219-4979-b42d-08d55d63037d",
      "Notes": [],
      "Medication": {
         "Dose": {
            "Quantity": 4,
            "Units": "mg"
         },
         "Rate": {
            "Quantity": null,
            "Units": null
         },
         "Route": {
            "Code": "C38288",
            "CodeSystem": "2.16.840.1.113883.3.26.1.1",
            "CodeSystemName": "NCI Thesaurus",
            "Name": "Oral",
            "AltCodes": []
         },
         "Components": [],
         "Product": {
            "Code": "104894",
            "CodeSystem": "2.16.840.1.113883.6.88",
            "CodeSystemName": "RxNorm",
            "Name": "Ondansetron 4 Mg Po Tbdp",
            "AltCodes": [],
            "Strength": {
               "Quantity": 4,
               "Units": "mg"
            },
            "Type": "Tablet"
         },
         "FreeTextSig": null,
         "StartDate": "2024-04-15T21:22:43.976Z",
         "EndDate": null,
         "Frequency": {
            "Period": 8,
            "Unit": "h"
         },
         "IsPRN": null,
         "Dispense": {
            "Amount": null,
            "Units": null
         },
         "NumberOfRefillsRemaining": 4,
         "TotalRefills": 6,
         "LastRefillDate": "2024-04-15T21:22:43.976Z"
      },
      "Indications": [],
      "Provider": {
         "NPI": "4356789876",
         "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
         }
      },
      "EnteredBy": {
         "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
         }
      },
      "VerifiedBy": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "FacilityIdentifiers": [],
            "Department": null,
            "DepartmentIdentifiers": [],
            "Room": null
         }
      },
      "Priority": null,
      "Pharmacy": {
         "Code": "1234567",
         "Codeset": "NCPDP",
         "Description": "Fake Pharmacy",
         "Address": {
            "StreetAddress": "123 Fake Street",
            "City": "Madison",
            "State": "WI",
            "ZIP": 53703,
            "County": null,
            "Country": null
         },
         "PhoneNumber": {
            "Office": null
         }
      }
   }
}

Update

Indicates an updated request for medication to be dispensed for the given patient. This event type is usually triggered when some part of a medication order is changed by the ordering system.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Medications
- Meta.EventType
  String
  Reliable
  Required
  Update
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  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
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  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.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  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
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
- Patient.Identifiers[]
  Array of Objects
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- Patient.Demographics.LastName
  String
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  ValueSet
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  ValueSet
  Patient's race
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  ValueSet
  Indicates if the patient is of hispanic origin.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Religion
  String
  Possible
  ValueSet
  Patient's religious affiliation
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.MaritalStatus
  String
  Possible
  ValueSet
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  ValueSet
  Patient's primary spoken language
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  ValueSet
  Patient's nation(s) of citizenship
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes
- Patient.Allergies[]
  Array of Objects
  Probable
- Patient.Allergies[].Code
  String
  Probable
  A code describing the type of allergy intolerance this is (food, drug, etc.).
  SNOMED CT from Allergy/Adverse Event Type Value Set
- Patient.Allergies[].CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Name
  String
  Probable
  Name of the type of allergy intolerance this is (food, drug, etc.)
- Patient.Allergies[].AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the type of allergy intolerance this is (food, drug, etc.)
- Patient.Allergies[].AltCodes[].Code
  String
  Possible
  A code describing the type of allergy intolerance this is (food, drug, etc.)
- Patient.Allergies[].AltCodes[].CodeSystem
  String
  Possible
  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.
- Patient.Allergies[].AltCodes[].CodeSystemName
  String
  Possible
  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.
- Patient.Allergies[].AltCodes[].Name
  String
  Possible
  Name of the type of allergy intolerance this is (food, drug, etc.)
- Patient.Allergies[].Substance.Code
  String
  Probable
  A code describing the substance that causes the allergy/intolerance.
  RxNorm, SNOMED CT, NDF-RT, UNII
- Patient.Allergies[].Substance.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Substance.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Substance.Name
  String
  Probable
  Name of the substance that causes the allergy/intolerance
- Patient.Allergies[].Substance.AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the substance that causes the allergy/intolerance
- Patient.Allergies[].Substance.AltCodes[].Code
  String
  Possible
  A code describing the substance that causes the allergy/intolerance
- Patient.Allergies[].Substance.AltCodes[].CodeSystem
  String
  Possible
  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.
- Patient.Allergies[].Substance.AltCodes[].CodeSystemName
  String
  Possible
  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.
- Patient.Allergies[].Substance.AltCodes[].Name
  String
  Possible
  Name of the substance that causes the allergy/intolerance
- Patient.Allergies[].Reaction[]
  String
  Probable
  All the reactions caused by this particular substance.
  SNOMED CT
- Patient.Allergies[].Reaction[].Code
  String
  Probable
  A code describing the reaction caused by the allergy (dizziness, hives, etc.).
  SNOMED CT
- Patient.Allergies[].Reaction[].CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Reaction[].CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Reaction[].Name
  String
  Probable
  Name of the reaction caused by the allergy (dizziness, hives, etc.)
- Patient.Allergies[].Reaction[].AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the reaction caused by the allergy (dizziness, hives, etc.)
- Patient.Allergies[].Reaction[].AltCodes[].Code
  String
  Possible
  A code describing the reaction caused by the allergy (dizziness, hives, etc.)
- Patient.Allergies[].Reaction[].AltCodes[].CodeSystem
  String
  Possible
  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.
- Patient.Allergies[].Reaction[].AltCodes[].CodeSystemName
  String
  Possible
  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.
- Patient.Allergies[].Reaction[].AltCodes[].Name
  String
  Possible
  Name of the reaction caused by the allergy (dizziness, hives, etc.)
- Patient.Allergies[].Reaction[].Severity.Code
  String
  Probable
  A code describing a code for the severity of the reaction (moderate, severe, etc.).
  SNOMED CT
- Patient.Allergies[].Reaction[].Severity.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Reaction[].Severity.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Reaction[].Severity.Name
  String
  Probable
  Name of a code for the severity of the reaction (moderate, severe, etc.)
- Patient.Allergies[].Reaction[].Text
  String
  Probable
  Free text form of reactions to this substance, includes information that cannot be captured by coded value.
- Patient.Allergies[].Severity.Code
  String
  Probable
  A code describing a code for the severity of the reaction (moderate, severe, etc.).
  SNOMED CT. Note that when multiple reactions have different severities, the severity at the allergy[] level is generally the highest of all reaction severities. This field is no longer recommended for use, but is preserved for backwards compatibility.
- Patient.Allergies[].Severity.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Severity.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Severity.Name
  String
  Probable
  Name of a code for the severity of the reaction (moderate, severe, etc.).
- Patient.Allergies[].Criticality.Code
  String
  Probable
  A code describing a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
  SNOMED CT. Note this is a different concept than reaction severity.
- Patient.Allergies[].Criticality.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Criticality.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Criticality.Name
  String
  Probable
  Name of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
- Patient.Allergies[].Status.Code
  String
  Probable
  A code describing the current status of the allergy (active, historic, etc.).
  SNOMED CT (Active, Inactive, Resolved)
- Patient.Allergies[].Status.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Status.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Status.Name
  String
  Probable
  Name of the current status of the allergy (active, historic, etc.)
- Patient.Allergies[].StartDate
  String
  Probable
  When the allergy was first noted.
  ISO 8601 Format
- Patient.Allergies[].EndDate
  String
  Probable
  When the allergy was no longer a problem (if applicable).
  ISO 8601 Format
- Patient.Allergies[].Comment
  String
  Probable
  Free text comment about the allergy.
Visit
- Visit
  Object
  Possible
  The visit that relates to this medication.
- Visit.VisitDateTime
  String
  Possible
  DateTime of visit or the arrival time of the admission.
  ISO 8601 Format
- Visit.VisitNumber
  String
  Possible
  Visit Number.
  Unique ID of a single visit
- Visit.AccountNumber
  String
  Possible
  Account Number.
  An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
- Visit.PatientClass
  String
  Possible
  Patient class is used in many EHRs to determine where to put the patient.
  Examples: Inpatient, Outpatient, Emergency
- Visit.Location
  Object
  Possible
  Location of the visit
- Visit.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Visit.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Visit.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.Location.Department
  String
  Possible
  Department
- Visit.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Visit.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Visit.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.Location.Bed
  String
  Possible
  Bed.
  Example: B
- Visit.AttendingProvider.ID
  String
  Possible
  ID of the attending provider.
  This ID is often required for Inpatient Visits.
- Visit.AttendingProvider.IDType
  String
  Possible
  ID type of the ID for the attending provider
- Visit.AttendingProvider.FirstName
  String
  Possible
  First name of the attending provider
- Visit.AttendingProvider.LastName
  String
  Possible
  Last name of the attending provider
- Visit.AttendingProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the attending provider.
  e.g. MD, PhD
- Visit.AttendingProvider.Address
  Object
  Possible
  Provider's address
- Visit.AttendingProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.AttendingProvider.Address.City
  String
  Possible
  City
- Visit.AttendingProvider.Address.State
  String
  Possible
  State
- Visit.AttendingProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.AttendingProvider.Address.County
  String
  Possible
  County
- Visit.AttendingProvider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.AttendingProvider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Visit.AttendingProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.AttendingProvider.Location
  Object
  Possible
  Provider's location
- Visit.AttendingProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.AttendingProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.AttendingProvider.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.AttendingProvider.Location.Department
  String
  Possible
  Department
- Visit.AttendingProvider.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.AttendingProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.ReferringProvider.ID
  String
  Possible
  ID of the referring provider.
  This ID is often required for Inpatient Visits.
- Visit.ReferringProvider.IDType
  String
  Possible
  ID type of the ID for the referring provider
- Visit.ReferringProvider.FirstName
  String
  Possible
  First name of the referring provider
- Visit.ReferringProvider.LastName
  String
  Possible
  Last name of the referring provider
- Visit.ReferringProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the referring provider.
  e.g. MD, PhD
- Visit.ReferringProvider.Address
  Object
  Possible
  Provider's address
- Visit.ReferringProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.ReferringProvider.Address.City
  String
  Possible
  City
- Visit.ReferringProvider.Address.State
  String
  Possible
  State
- Visit.ReferringProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.ReferringProvider.Address.County
  String
  Possible
  County
- Visit.ReferringProvider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.ReferringProvider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Visit.ReferringProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.ReferringProvider.Location
  Object
  Possible
  Provider's location
- Visit.ReferringProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.ReferringProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.ReferringProvider.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.ReferringProvider.Location.Department
  String
  Possible
  Department
- Visit.ReferringProvider.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.ReferringProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.Insurances[]
  Array of Objects
  Probable
  List of insurance coverages for the patient that should be used for the medication.
- Visit.Insurances[].Plan.ID
  String
  Probable
  Identifier of insurance plan
- Visit.Insurances[].Plan.IDType
  String
  Probable
  ID type of insurance plan
- Visit.Insurances[].Plan.Name
  String
  Probable
  Name of insurance plan
- Visit.Insurances[].Plan.Type
  String
  Possible
  Type of insurance plan
- Visit.Insurances[].MemberNumber
  String
  Possible
  Patient member number
- Visit.Insurances[].Company.ID
  String
  Probable
  ID of insurance company (payor)
- Visit.Insurances[].Company.IDType
  String
  Probable
  ID type of insurance company (payor)
- Visit.Insurances[].Company.Name
  String
  Probable
  Name of insurance company (payor)
- Visit.Insurances[].Company.Address
  Object
  Probable
  Insurance company's address
- Visit.Insurances[].Company.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Insurances[].Company.Address.City
  String
  Probable
  City
- Visit.Insurances[].Company.Address.State
  String
  Probable
  State
- Visit.Insurances[].Company.Address.ZIP
  String
  Probable
  ZIP
- Visit.Insurances[].Company.Address.County
  String
  Possible
  County
- Visit.Insurances[].Company.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Company.PhoneNumber
  String
  Probable
  Insurance companys phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Insurances[].GroupNumber
  String
  Probable
  Insurance policy group number
- Visit.Insurances[].GroupName
  String
  Probable
  Insurance policy group name
- Visit.Insurances[].EffectiveDate
  String
  Probable
  Effect date of this insurance policy.
  In YYYY-MM-DD format
- Visit.Insurances[].ExpirationDate
  String
  Probable
  Expiration date of this insurance policy.
  In YYYY-MM-DD format
- Visit.Insurances[].PolicyNumber
  String
  Probable
  Insurance policy number
- Visit.Insurances[].Priority
  String
  Possible
  ValueSet
  The insurance priority sequence.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].AgreementType
  String
  Probable
  ValueSet
  Type of insurance agreement.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].CoverageType
  String
  Probable
  ValueSet
  Type of insurance agreement.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Insured
  Object
  Possible
  Individual who has the agreement with the insurance company for the related policy
- Visit.Insurances[].Insured.Identifiers[]
  Array of Objects
  Possible
  List of IDs and ID types that identify the insured
- Visit.Insurances[].Insured.Identifiers[].ID
  String
  Possible
  ID for the insured
- Visit.Insurances[].Insured.Identifiers[].IDType
  String
  Possible
  Type of ID.
  E.g. MRN, EPI
- Visit.Insurances[].Insured.LastName
  String
  Possible
  Last name of the insured
- Visit.Insurances[].Insured.MiddleName
  String
  Possible
  Middle name of the insured
- Visit.Insurances[].Insured.FirstName
  String
  Possible
  First name of the insured
- Visit.Insurances[].Insured.SSN
  String
  Possible
  Insured's social security number
- Visit.Insurances[].Insured.Relationship
  String
  Possible
  ValueSet
  Relationship of the insured to the patient
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Insured.DOB
  String
  Possible
  Date of birth of the insured.
  In YYYY-MM-DD format
- Visit.Insurances[].Insured.Sex
  String
  Possible
  ValueSet
  Sex of the insured
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Insured.Address
  Object
  Probable
  Address of the insured
- Visit.Insurances[].Insured.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Insurances[].Insured.Address.City
  String
  Probable
  City
- Visit.Insurances[].Insured.Address.State
  String
  Probable
  State
- Visit.Insurances[].Insured.Address.ZIP
  String
  Probable
  ZIP
- Visit.Insurances[].Insured.Address.County
  String
  Possible
  County
- Visit.Insurances[].Insured.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
Order
- Order.ID
  String
  Reliable
  Required
  ID assigned by the ordering system
- Order.Notes[]
  Array of Strings
  Possible
  Order-level notes
- Order.Medication.Dose.Quantity
  Numeric
  Probable
  The size of the dose for pills, capsules, etc.
- Order.Medication.Dose.Units
  String
  Probable
  The units of the dose.
  UCUM Units of Measure
- Order.Medication.Rate.Quantity
  Numeric
  Probable
  If the medication is in liquid form, the rate at which it is administered
- Order.Medication.Rate.Units
  String
  Probable
  Units for the rate.
  UCUM Units of Measure
- Order.Medication.Route.Code
  String
  Probable
  A code describing the method by which the medication is delivered.
  Medication Route FDA Value Set
- Order.Medication.Route.CodeSystem
  String
  Probable
  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.
- Order.Medication.Route.CodeSystemName
  String
  Probable
  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.
- Order.Medication.Route.Name
  String
  Probable
  Name of the method by which the medication is delivered
- Order.Medication.Route.AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the method by which the medication is delivered
- Order.Medication.Route.AltCodes[].Code
  String
  Possible
  A code describing the method by which the medication is delivered
- Order.Medication.Route.AltCodes[].CodeSystem
  String
  Possible
  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.
- Order.Medication.Route.AltCodes[].CodeSystemName
  String
  Possible
  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.
- Order.Medication.Route.AltCodes[].Name
  String
  Possible
  Name of the method by which the medication is delivered
- Order.Medication.Components[]
  Array of Objects
  Reliable
  The components of the medication
- Order.Medication.Components[].Code
  String
  Possible
  A code describing the components of the medication
- Order.Medication.Components[].CodeSystem
  String
  Possible
  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.
- Order.Medication.Components[].CodeSystemName
  String
  Possible
  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.
- Order.Medication.Components[].Name
  String
  Possible
  Name of the components of the medication
- Order.Medication.Components[].Type
  String
  Probable
  The type of component.
  Allowed values are Base or Additive
- Order.Medication.Components[].Dose.Quantity
  Numeric
  Probable
  The size of the dose for the component.
- Order.Medication.Components[].Dose.Units
  String
  Probable
  The units of the dose.
  UCUM Units of Measure
- Order.Medication.Product.Code
  String
  Reliable
  Required
  A code describing the actual medication given.
  Redox recommends using RxNorm
- Order.Medication.Product.CodeSystem
  String
  Reliable
  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.
- Order.Medication.Product.CodeSystemName
  String
  Reliable
  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.
- Order.Medication.Product.Name
  String
  Reliable
  Name of the actual medication given
- Order.Medication.Product.AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the actual medication given
- Order.Medication.Product.AltCodes[].Code
  String
  Possible
  A code describing the actual medication given
- Order.Medication.Product.AltCodes[].CodeSystem
  String
  Possible
  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.
- Order.Medication.Product.AltCodes[].CodeSystemName
  String
  Possible
  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.
- Order.Medication.Product.AltCodes[].Name
  String
  Possible
  Name of the actual medication given
- Order.Medication.Product.Strength.Quantity
  Numeric
  Possible
  The size of the strength for the medication product.
- Order.Medication.Product.Strength.Units
  String
  Possible
  The units of the medication product strength.
  UCUM Units of Measure
- Order.Medication.Product.Type
  String
  Possible
  The type of product
- Order.Medication.FreeTextSig
  String
  Possible
  Free text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication
- Order.Medication.StartDate
  String
  Reliable
  When the medication should be started.
  ISO 8601 Format
- Order.Medication.EndDate
  String
  Probable
  When the medication should be ended.
  ISO 8601 Format
- Order.Medication.Frequency.Period
  Numeric
  Probable
  How often the patient should be taking the medication
- Order.Medication.Frequency.Unit
  String
  Probable
  Units for how often the patient should be taking the medication.
  UCUM Units of Measure
- Order.Medication.IsPRN
  Boolean
  Probable
  Whether the medication is to be taken on an as-needed basis
- Order.Medication.Dispense.Amount
  Numeric
  Probable
  The amount to be dispensed
- Order.Medication.Dispense.Units
  String
  Probable
  Units for the dispensed amount
- Order.Medication.NumberOfRefillsRemaining
  Numeric
  Probable
  The number of authorized refills remaining on the prescription
- Order.Medication.TotalRefills
  Numeric
  Probable
  The total number of refills prescribed
- Order.Medication.LastRefillDate
  String
  Probable
  The date which the refill was last filled.
  ISO 8601 Format
- Order.Indications[]
  Array of Objects
  Probable
  This field identifies the condition or problem for which the drug/treatment was prescribed.
- Order.Indications[].Code
  String
  Probable
  Code
- Order.Indications[].Codeset
  String
  Probable
  Code set
- Order.Indications[].Description
  String
  Probable
  Description
- Order.Provider.NPI
  String
  Possible
  NPI of the Ordering provider who is licensed to prescribe medications.
- Order.Provider.ID
  String
  Possible
  ID of the Ordering provider who is licensed to prescribe medications.
  This ID is often required for Inpatient Visits.
- Order.Provider.IDType
  String
  Possible
  ID type of the ID for the Ordering provider who is licensed to prescribe medications.
- Order.Provider.FirstName
  String
  Possible
  First name of the Ordering provider who is licensed to prescribe medications.
- Order.Provider.LastName
  String
  Possible
  Last name of the Ordering provider who is licensed to prescribe medications.
- Order.Provider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the Ordering provider who is licensed to prescribe medications.
  e.g. MD, PhD
- Order.Provider.Address
  Object
  Possible
  Provider's address
- Order.Provider.Address.StreetAddress
  String
  Possible
  Street address
- Order.Provider.Address.City
  String
  Possible
  City
- Order.Provider.Address.State
  String
  Possible
  State
- Order.Provider.Address.ZIP
  String
  Possible
  ZIP
- Order.Provider.Address.County
  String
  Possible
  County
- Order.Provider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.Provider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Order.Provider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Order.Provider.Location
  Object
  Possible
  Provider's location
- Order.Provider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Order.Provider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Order.Provider.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Order.Provider.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Order.Provider.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.Provider.Location.Department
  String
  Possible
  Department
- Order.Provider.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Order.Provider.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Order.Provider.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.Provider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Order.EnteredBy.ID
  String
  Possible
  ID of the The provider who actually entered the order.
  This ID is often required for Inpatient Visits.
- Order.EnteredBy.IDType
  String
  Possible
  ID type of the ID for the The provider who actually entered the order.
- Order.EnteredBy.FirstName
  String
  Possible
  First name of the The provider who actually entered the order.
- Order.EnteredBy.LastName
  String
  Possible
  Last name of the The provider who actually entered the order.
- Order.EnteredBy.Credentials[]
  Array of Strings
  Possible
  List of credentials for the The provider who actually entered the order.
  e.g. MD, PhD
- Order.EnteredBy.Address
  Object
  Possible
  Provider's address
- Order.EnteredBy.Address.StreetAddress
  String
  Possible
  Street address
- Order.EnteredBy.Address.City
  String
  Possible
  City
- Order.EnteredBy.Address.State
  String
  Possible
  State
- Order.EnteredBy.Address.ZIP
  String
  Possible
  ZIP
- Order.EnteredBy.Address.County
  String
  Possible
  County
- Order.EnteredBy.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.EnteredBy.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Order.EnteredBy.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Order.EnteredBy.Location
  Object
  Possible
  Provider's location
- Order.EnteredBy.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Order.EnteredBy.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Order.EnteredBy.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Order.EnteredBy.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Order.EnteredBy.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.EnteredBy.Location.Department
  String
  Possible
  Department
- Order.EnteredBy.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Order.EnteredBy.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Order.EnteredBy.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.EnteredBy.Location.Room
  String
  Possible
  Room.
  Example: 136
- Order.VerifiedBy.ID
  String
  Possible
  ID of the The pharmacist who verified the order.
  This ID is often required for Inpatient Visits.
- Order.VerifiedBy.IDType
  String
  Possible
  ID type of the ID for the The pharmacist who verified the order.
- Order.VerifiedBy.FirstName
  String
  Possible
  First name of the The pharmacist who verified the order.
- Order.VerifiedBy.LastName
  String
  Possible
  Last name of the The pharmacist who verified the order.
- Order.VerifiedBy.Credentials[]
  Array of Strings
  Possible
  List of credentials for the The pharmacist who verified the order.
  e.g. MD, PhD
- Order.VerifiedBy.Address
  Object
  Possible
  Provider's address
- Order.VerifiedBy.Address.StreetAddress
  String
  Possible
  Street address
- Order.VerifiedBy.Address.City
  String
  Possible
  City
- Order.VerifiedBy.Address.State
  String
  Possible
  State
- Order.VerifiedBy.Address.ZIP
  String
  Possible
  ZIP
- Order.VerifiedBy.Address.County
  String
  Possible
  County
- Order.VerifiedBy.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.VerifiedBy.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Order.VerifiedBy.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Order.VerifiedBy.Location
  Object
  Possible
  Provider's location
- Order.VerifiedBy.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Order.VerifiedBy.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Order.VerifiedBy.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Order.VerifiedBy.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Order.VerifiedBy.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.VerifiedBy.Location.Department
  String
  Possible
  Department
- Order.VerifiedBy.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Order.VerifiedBy.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Order.VerifiedBy.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.VerifiedBy.Location.Room
  String
  Possible
  Room.
  Example: 136
- Order.Priority
  String
  Reliable
  ValueSet
  Priority of the order
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.Pharmacy
  Object
  Probable
  The pharmacy at which the medication should be dispensed.
- Order.Pharmacy.Code
  String
  Probable
  Code for the pharmacy
- Order.Pharmacy.Codeset
  String
  Probable
  Code set used to identify the pharmacy
- Order.Pharmacy.Description
  String
  Probable
  Description of the pharmacy
- Order.Pharmacy.Address
  Object
  Probable
  The physical location at which the medication should be dispensed.
- Order.Pharmacy.Address.StreetAddress
  String
  Probable
  Street address
- Order.Pharmacy.Address.City
  String
  Probable
  City
- Order.Pharmacy.Address.State
  String
  Probable
  State
- Order.Pharmacy.Address.ZIP
  String
  Probable
  ZIP
- Order.Pharmacy.Address.County
  String
  Possible
  County
- Order.Pharmacy.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.Pharmacy.PhoneNumber.Office
  String
  Possible
  Pharmacy's office phone number.
  In E. 164 Format. (e.g. +16085551234)

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Medications",
      "EventType": "Update",
      "EventDateTime": "2024-04-15T21:22:43.979Z",
      "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
   },
   "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": [],
      "Allergies": [
         {
            "Code": "7982",
            "CodeSystem": null,
            "CodeSystemName": null,
            "Name": "Penicillin",
            "AltCodes": [],
            "Substance": {
               "Code": null,
               "CodeSystem": null,
               "CodeSystemName": null,
               "Name": null,
               "AltCodes": []
            },
            "Reaction": [
               {
                  "Code": "28926001",
                  "CodeSystem": null,
                  "CodeSystemName": null,
                  "Name": "Rash",
                  "AltCodes": [],
                  "Severity": {
                     "Code": null,
                     "CodeSystem": null,
                     "CodeSystemName": null,
                     "Name": null
                  },
                  "Text": null
               },
               {
                  "Code": "247472004",
                  "CodeSystem": null,
                  "CodeSystemName": null,
                  "Name": "Hives",
                  "AltCodes": [],
                  "Severity": {
                     "Code": null,
                     "CodeSystem": null,
                     "CodeSystemName": null,
                     "Name": null
                  },
                  "Text": null
               }
            ],
            "Severity": {
               "Code": null,
               "CodeSystem": null,
               "CodeSystemName": null,
               "Name": null
            },
            "Criticality": {
               "Code": null,
               "CodeSystem": null,
               "CodeSystemName": null,
               "Name": null
            },
            "Status": {
               "Code": null,
               "CodeSystem": null,
               "CodeSystemName": null,
               "Name": null
            },
            "StartDate": null,
            "EndDate": null,
            "Comment": null
         }
      ]
   },
   "Visit": {
      "VisitDateTime": "2024-04-15T21:22:44.627Z",
      "VisitNumber": "1234",
      "AccountNumber": null,
      "PatientClass": null,
      "Location": {
         "Type": null,
         "Facility": null,
         "FacilityIdentifiers": [],
         "Department": null,
         "DepartmentIdentifiers": [],
         "Room": null,
         "Bed": null
      },
      "AttendingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "FacilityIdentifiers": [],
            "Department": null,
            "DepartmentIdentifiers": [],
            "Room": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "FacilityIdentifiers": [],
            "Department": null,
            "DepartmentIdentifiers": [],
            "Room": null
         }
      },
      "Insurances": []
   },
   "Order": {
      "ID": "8181a104-fddd-4972-8b3b-51291d4d04ba",
      "Notes": [],
      "Medication": {
         "Dose": {
            "Quantity": 4,
            "Units": "mg"
         },
         "Rate": {
            "Quantity": null,
            "Units": null
         },
         "Route": {
            "Code": "C38288",
            "CodeSystem": "2.16.840.1.113883.3.26.1.1",
            "CodeSystemName": "NCI Thesaurus",
            "Name": "Oral",
            "AltCodes": []
         },
         "Components": [],
         "Product": {
            "Code": "104894",
            "CodeSystem": "2.16.840.1.113883.6.88",
            "CodeSystemName": "RxNorm",
            "Name": "Ondansetron 4 Mg Po Tbdp",
            "AltCodes": [],
            "Strength": {
               "Quantity": 4,
               "Units": "mg"
            },
            "Type": "Tablet"
         },
         "FreeTextSig": null,
         "StartDate": "2024-04-15T21:22:43.976Z",
         "EndDate": null,
         "Frequency": {
            "Period": 8,
            "Unit": "h"
         },
         "IsPRN": null,
         "Dispense": {
            "Amount": null,
            "Units": null
         },
         "NumberOfRefillsRemaining": 4,
         "TotalRefills": 6,
         "LastRefillDate": "2024-04-15T21:22:43.976Z"
      },
      "Indications": [],
      "Provider": {
         "NPI": "4356789876",
         "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
         }
      },
      "EnteredBy": {
         "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
         }
      },
      "VerifiedBy": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "FacilityIdentifiers": [],
            "Department": null,
            "DepartmentIdentifiers": [],
            "Room": null
         }
      },
      "Priority": null,
      "Pharmacy": {
         "Code": "1234567",
         "Codeset": "NCPDP",
         "Description": "Fake Pharmacy",
         "Address": {
            "StreetAddress": "123 Fake Street",
            "City": "Madison",
            "State": "WI",
            "ZIP": 53703,
            "County": null,
            "Country": null
         },
         "PhoneNumber": {
            "Office": null
         }
      }
   }
}

Cancel

Indicates that a previous medication request has been cancelled by the ordering system.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Medications
- Meta.EventType
  String
  Reliable
  Required
  Cancel
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  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
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  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.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  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
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
- Patient.Identifiers[]
  Array of Objects
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- Patient.Demographics.LastName
  String
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  ValueSet
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  ValueSet
  Patient's race
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  ValueSet
  Indicates if the patient is of hispanic origin.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Religion
  String
  Possible
  ValueSet
  Patient's religious affiliation
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.MaritalStatus
  String
  Possible
  ValueSet
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  ValueSet
  Patient's primary spoken language
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  ValueSet
  Patient's nation(s) of citizenship
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes
- Patient.Allergies[]
  Array of Objects
  Probable
- Patient.Allergies[].Code
  String
  Probable
  A code describing the type of allergy intolerance this is (food, drug, etc.).
  SNOMED CT from Allergy/Adverse Event Type Value Set
- Patient.Allergies[].CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Name
  String
  Probable
  Name of the type of allergy intolerance this is (food, drug, etc.)
- Patient.Allergies[].AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the type of allergy intolerance this is (food, drug, etc.)
- Patient.Allergies[].AltCodes[].Code
  String
  Possible
  A code describing the type of allergy intolerance this is (food, drug, etc.)
- Patient.Allergies[].AltCodes[].CodeSystem
  String
  Possible
  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.
- Patient.Allergies[].AltCodes[].CodeSystemName
  String
  Possible
  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.
- Patient.Allergies[].AltCodes[].Name
  String
  Possible
  Name of the type of allergy intolerance this is (food, drug, etc.)
- Patient.Allergies[].Substance.Code
  String
  Probable
  A code describing the substance that causes the allergy/intolerance.
  RxNorm, SNOMED CT, NDF-RT, UNII
- Patient.Allergies[].Substance.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Substance.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Substance.Name
  String
  Probable
  Name of the substance that causes the allergy/intolerance
- Patient.Allergies[].Substance.AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the substance that causes the allergy/intolerance
- Patient.Allergies[].Substance.AltCodes[].Code
  String
  Possible
  A code describing the substance that causes the allergy/intolerance
- Patient.Allergies[].Substance.AltCodes[].CodeSystem
  String
  Possible
  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.
- Patient.Allergies[].Substance.AltCodes[].CodeSystemName
  String
  Possible
  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.
- Patient.Allergies[].Substance.AltCodes[].Name
  String
  Possible
  Name of the substance that causes the allergy/intolerance
- Patient.Allergies[].Reaction[]
  String
  Probable
  All the reactions caused by this particular substance.
  SNOMED CT
- Patient.Allergies[].Reaction[].Code
  String
  Probable
  A code describing the reaction caused by the allergy (dizziness, hives, etc.).
  SNOMED CT
- Patient.Allergies[].Reaction[].CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Reaction[].CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Reaction[].Name
  String
  Probable
  Name of the reaction caused by the allergy (dizziness, hives, etc.)
- Patient.Allergies[].Reaction[].AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the reaction caused by the allergy (dizziness, hives, etc.)
- Patient.Allergies[].Reaction[].AltCodes[].Code
  String
  Possible
  A code describing the reaction caused by the allergy (dizziness, hives, etc.)
- Patient.Allergies[].Reaction[].AltCodes[].CodeSystem
  String
  Possible
  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.
- Patient.Allergies[].Reaction[].AltCodes[].CodeSystemName
  String
  Possible
  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.
- Patient.Allergies[].Reaction[].AltCodes[].Name
  String
  Possible
  Name of the reaction caused by the allergy (dizziness, hives, etc.)
- Patient.Allergies[].Reaction[].Severity.Code
  String
  Probable
  A code describing a code for the severity of the reaction (moderate, severe, etc.).
  SNOMED CT
- Patient.Allergies[].Reaction[].Severity.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Reaction[].Severity.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Reaction[].Severity.Name
  String
  Probable
  Name of a code for the severity of the reaction (moderate, severe, etc.)
- Patient.Allergies[].Reaction[].Text
  String
  Probable
  Free text form of reactions to this substance, includes information that cannot be captured by coded value.
- Patient.Allergies[].Severity.Code
  String
  Probable
  A code describing a code for the severity of the reaction (moderate, severe, etc.).
  SNOMED CT. Note that when multiple reactions have different severities, the severity at the allergy[] level is generally the highest of all reaction severities. This field is no longer recommended for use, but is preserved for backwards compatibility.
- Patient.Allergies[].Severity.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Severity.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Severity.Name
  String
  Probable
  Name of a code for the severity of the reaction (moderate, severe, etc.).
- Patient.Allergies[].Criticality.Code
  String
  Probable
  A code describing a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
  SNOMED CT. Note this is a different concept than reaction severity.
- Patient.Allergies[].Criticality.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Criticality.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Criticality.Name
  String
  Probable
  Name of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
- Patient.Allergies[].Status.Code
  String
  Probable
  A code describing the current status of the allergy (active, historic, etc.).
  SNOMED CT (Active, Inactive, Resolved)
- Patient.Allergies[].Status.CodeSystem
  String
  Probable
  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.
- Patient.Allergies[].Status.CodeSystemName
  String
  Probable
  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.
- Patient.Allergies[].Status.Name
  String
  Probable
  Name of the current status of the allergy (active, historic, etc.)
- Patient.Allergies[].StartDate
  String
  Probable
  When the allergy was first noted.
  ISO 8601 Format
- Patient.Allergies[].EndDate
  String
  Probable
  When the allergy was no longer a problem (if applicable).
  ISO 8601 Format
- Patient.Allergies[].Comment
  String
  Probable
  Free text comment about the allergy.
Visit
- Visit
  Object
  Possible
  The visit that relates to this medication.
- Visit.VisitDateTime
  String
  Possible
  DateTime of visit or the arrival time of the admission.
  ISO 8601 Format
- Visit.VisitNumber
  String
  Possible
  Visit Number.
  Unique ID of a single visit
- Visit.AccountNumber
  String
  Possible
  Account Number.
  An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
- Visit.PatientClass
  String
  Possible
  Patient class is used in many EHRs to determine where to put the patient.
  Examples: Inpatient, Outpatient, Emergency
- Visit.Location
  Object
  Possible
  Location of the visit
- Visit.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Visit.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Visit.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.Location.Department
  String
  Possible
  Department
- Visit.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Visit.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Visit.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.Location.Bed
  String
  Possible
  Bed.
  Example: B
- Visit.AttendingProvider.ID
  String
  Possible
  ID of the attending provider.
  This ID is often required for Inpatient Visits.
- Visit.AttendingProvider.IDType
  String
  Possible
  ID type of the ID for the attending provider
- Visit.AttendingProvider.FirstName
  String
  Possible
  First name of the attending provider
- Visit.AttendingProvider.LastName
  String
  Possible
  Last name of the attending provider
- Visit.AttendingProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the attending provider.
  e.g. MD, PhD
- Visit.AttendingProvider.Address
  Object
  Possible
  Provider's address
- Visit.AttendingProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.AttendingProvider.Address.City
  String
  Possible
  City
- Visit.AttendingProvider.Address.State
  String
  Possible
  State
- Visit.AttendingProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.AttendingProvider.Address.County
  String
  Possible
  County
- Visit.AttendingProvider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.AttendingProvider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Visit.AttendingProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.AttendingProvider.Location
  Object
  Possible
  Provider's location
- Visit.AttendingProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.AttendingProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.AttendingProvider.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.AttendingProvider.Location.Department
  String
  Possible
  Department
- Visit.AttendingProvider.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.AttendingProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.ReferringProvider.ID
  String
  Possible
  ID of the referring provider.
  This ID is often required for Inpatient Visits.
- Visit.ReferringProvider.IDType
  String
  Possible
  ID type of the ID for the referring provider
- Visit.ReferringProvider.FirstName
  String
  Possible
  First name of the referring provider
- Visit.ReferringProvider.LastName
  String
  Possible
  Last name of the referring provider
- Visit.ReferringProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the referring provider.
  e.g. MD, PhD
- Visit.ReferringProvider.Address
  Object
  Possible
  Provider's address
- Visit.ReferringProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.ReferringProvider.Address.City
  String
  Possible
  City
- Visit.ReferringProvider.Address.State
  String
  Possible
  State
- Visit.ReferringProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.ReferringProvider.Address.County
  String
  Possible
  County
- Visit.ReferringProvider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.ReferringProvider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Visit.ReferringProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.ReferringProvider.Location
  Object
  Possible
  Provider's location
- Visit.ReferringProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.ReferringProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.ReferringProvider.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.ReferringProvider.Location.Department
  String
  Possible
  Department
- Visit.ReferringProvider.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.ReferringProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.Insurances[]
  Array of Objects
  Probable
  List of insurance coverages for the patient that should be used for the medication.
- Visit.Insurances[].Plan.ID
  String
  Probable
  Identifier of insurance plan
- Visit.Insurances[].Plan.IDType
  String
  Probable
  ID type of insurance plan
- Visit.Insurances[].Plan.Name
  String
  Probable
  Name of insurance plan
- Visit.Insurances[].Plan.Type
  String
  Possible
  Type of insurance plan
- Visit.Insurances[].MemberNumber
  String
  Possible
  Patient member number
- Visit.Insurances[].Company.ID
  String
  Probable
  ID of insurance company (payor)
- Visit.Insurances[].Company.IDType
  String
  Probable
  ID type of insurance company (payor)
- Visit.Insurances[].Company.Name
  String
  Probable
  Name of insurance company (payor)
- Visit.Insurances[].Company.Address
  Object
  Probable
  Insurance company's address
- Visit.Insurances[].Company.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Insurances[].Company.Address.City
  String
  Probable
  City
- Visit.Insurances[].Company.Address.State
  String
  Probable
  State
- Visit.Insurances[].Company.Address.ZIP
  String
  Probable
  ZIP
- Visit.Insurances[].Company.Address.County
  String
  Possible
  County
- Visit.Insurances[].Company.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Company.PhoneNumber
  String
  Probable
  Insurance companys phone number.
  In E. 164 Format (i.e. +16085551234)
- Visit.Insurances[].GroupNumber
  String
  Probable
  Insurance policy group number
- Visit.Insurances[].GroupName
  String
  Probable
  Insurance policy group name
- Visit.Insurances[].EffectiveDate
  String
  Probable
  Effect date of this insurance policy.
  In YYYY-MM-DD format
- Visit.Insurances[].ExpirationDate
  String
  Probable
  Expiration date of this insurance policy.
  In YYYY-MM-DD format
- Visit.Insurances[].PolicyNumber
  String
  Probable
  Insurance policy number
- Visit.Insurances[].Priority
  String
  Possible
  ValueSet
  The insurance priority sequence.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].AgreementType
  String
  Probable
  ValueSet
  Type of insurance agreement.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].CoverageType
  String
  Probable
  ValueSet
  Type of insurance agreement.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Insured
  Object
  Possible
  Individual who has the agreement with the insurance company for the related policy
- Visit.Insurances[].Insured.Identifiers[]
  Array of Objects
  Possible
  List of IDs and ID types that identify the insured
- Visit.Insurances[].Insured.Identifiers[].ID
  String
  Possible
  ID for the insured
- Visit.Insurances[].Insured.Identifiers[].IDType
  String
  Possible
  Type of ID.
  E.g. MRN, EPI
- Visit.Insurances[].Insured.LastName
  String
  Possible
  Last name of the insured
- Visit.Insurances[].Insured.MiddleName
  String
  Possible
  Middle name of the insured
- Visit.Insurances[].Insured.FirstName
  String
  Possible
  First name of the insured
- Visit.Insurances[].Insured.SSN
  String
  Possible
  Insured's social security number
- Visit.Insurances[].Insured.Relationship
  String
  Possible
  ValueSet
  Relationship of the insured to the patient
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Insured.DOB
  String
  Possible
  Date of birth of the insured.
  In YYYY-MM-DD format
- Visit.Insurances[].Insured.Sex
  String
  Possible
  ValueSet
  Sex of the insured
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.Insurances[].Insured.Address
  Object
  Probable
  Address of the insured
- Visit.Insurances[].Insured.Address.StreetAddress
  String
  Probable
  Street address
- Visit.Insurances[].Insured.Address.City
  String
  Probable
  City
- Visit.Insurances[].Insured.Address.State
  String
  Probable
  State
- Visit.Insurances[].Insured.Address.ZIP
  String
  Probable
  ZIP
- Visit.Insurances[].Insured.Address.County
  String
  Possible
  County
- Visit.Insurances[].Insured.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
Order
- Order.ID
  String
  Reliable
  Required
  ID assigned by the ordering system
- Order.Notes[]
  Array of Strings
  Possible
  Order-level notes
- Order.Medication.Dose.Quantity
  Numeric
  Probable
  The size of the dose for pills, capsules, etc.
- Order.Medication.Dose.Units
  String
  Probable
  The units of the dose.
  UCUM Units of Measure
- Order.Medication.Rate.Quantity
  Numeric
  Probable
  If the medication is in liquid form, the rate at which it is administered
- Order.Medication.Rate.Units
  String
  Probable
  Units for the rate.
  UCUM Units of Measure
- Order.Medication.Route.Code
  String
  Probable
  A code describing the method by which the medication is delivered.
  Medication Route FDA Value Set
- Order.Medication.Route.CodeSystem
  String
  Probable
  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.
- Order.Medication.Route.CodeSystemName
  String
  Probable
  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.
- Order.Medication.Route.Name
  String
  Probable
  Name of the method by which the medication is delivered
- Order.Medication.Route.AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the method by which the medication is delivered
- Order.Medication.Route.AltCodes[].Code
  String
  Possible
  A code describing the method by which the medication is delivered
- Order.Medication.Route.AltCodes[].CodeSystem
  String
  Possible
  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.
- Order.Medication.Route.AltCodes[].CodeSystemName
  String
  Possible
  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.
- Order.Medication.Route.AltCodes[].Name
  String
  Possible
  Name of the method by which the medication is delivered
- Order.Medication.Components[]
  Array of Objects
  Reliable
  The components of the medication
- Order.Medication.Components[].Code
  String
  Possible
  A code describing the components of the medication
- Order.Medication.Components[].CodeSystem
  String
  Possible
  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.
- Order.Medication.Components[].CodeSystemName
  String
  Possible
  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.
- Order.Medication.Components[].Name
  String
  Possible
  Name of the components of the medication
- Order.Medication.Components[].Type
  String
  Probable
  The type of component.
  Allowed values are Base or Additive
- Order.Medication.Components[].Dose.Quantity
  Numeric
  Probable
  The size of the dose for the component.
- Order.Medication.Components[].Dose.Units
  String
  Probable
  The units of the dose.
  UCUM Units of Measure
- Order.Medication.Product.Code
  String
  Reliable
  Required
  A code describing the actual medication given.
  Redox recommends using RxNorm
- Order.Medication.Product.CodeSystem
  String
  Reliable
  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.
- Order.Medication.Product.CodeSystemName
  String
  Reliable
  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.
- Order.Medication.Product.Name
  String
  Reliable
  Name of the actual medication given
- Order.Medication.Product.AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the actual medication given
- Order.Medication.Product.AltCodes[].Code
  String
  Possible
  A code describing the actual medication given
- Order.Medication.Product.AltCodes[].CodeSystem
  String
  Possible
  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.
- Order.Medication.Product.AltCodes[].CodeSystemName
  String
  Possible
  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.
- Order.Medication.Product.AltCodes[].Name
  String
  Possible
  Name of the actual medication given
- Order.Medication.Product.Strength.Quantity
  Numeric
  Possible
  The size of the strength for the medication product.
- Order.Medication.Product.Strength.Units
  String
  Possible
  The units of the medication product strength.
  UCUM Units of Measure
- Order.Medication.Product.Type
  String
  Possible
  The type of product
- Order.Medication.FreeTextSig
  String
  Possible
  Free text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication
- Order.Medication.StartDate
  String
  Reliable
  When the medication should be started.
  ISO 8601 Format
- Order.Medication.EndDate
  String
  Probable
  When the medication should be ended.
  ISO 8601 Format
- Order.Medication.Frequency.Period
  Numeric
  Probable
  How often the patient should be taking the medication
- Order.Medication.Frequency.Unit
  String
  Probable
  Units for how often the patient should be taking the medication.
  UCUM Units of Measure
- Order.Medication.IsPRN
  Boolean
  Probable
  Whether the medication is to be taken on an as-needed basis
- Order.Medication.Dispense.Amount
  Numeric
  Probable
  The amount to be dispensed
- Order.Medication.Dispense.Units
  String
  Probable
  Units for the dispensed amount
- Order.Medication.NumberOfRefillsRemaining
  Numeric
  Probable
  The number of authorized refills remaining on the prescription
- Order.Medication.TotalRefills
  Numeric
  Probable
  The total number of refills prescribed
- Order.Medication.LastRefillDate
  String
  Probable
  The date which the refill was last filled.
  ISO 8601 Format
- Order.Indications[]
  Array of Objects
  Probable
  This field identifies the condition or problem for which the drug/treatment was prescribed.
- Order.Indications[].Code
  String
  Probable
  Code
- Order.Indications[].Codeset
  String
  Probable
  Code set
- Order.Indications[].Description
  String
  Probable
  Description
- Order.Provider.NPI
  String
  Possible
  NPI of the Ordering provider who is licensed to prescribe medications.
- Order.Provider.ID
  String
  Possible
  ID of the Ordering provider who is licensed to prescribe medications.
  This ID is often required for Inpatient Visits.
- Order.Provider.IDType
  String
  Possible
  ID type of the ID for the Ordering provider who is licensed to prescribe medications.
- Order.Provider.FirstName
  String
  Possible
  First name of the Ordering provider who is licensed to prescribe medications.
- Order.Provider.LastName
  String
  Possible
  Last name of the Ordering provider who is licensed to prescribe medications.
- Order.Provider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the Ordering provider who is licensed to prescribe medications.
  e.g. MD, PhD
- Order.Provider.Address
  Object
  Possible
  Provider's address
- Order.Provider.Address.StreetAddress
  String
  Possible
  Street address
- Order.Provider.Address.City
  String
  Possible
  City
- Order.Provider.Address.State
  String
  Possible
  State
- Order.Provider.Address.ZIP
  String
  Possible
  ZIP
- Order.Provider.Address.County
  String
  Possible
  County
- Order.Provider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.Provider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Order.Provider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Order.Provider.Location
  Object
  Possible
  Provider's location
- Order.Provider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Order.Provider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Order.Provider.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Order.Provider.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Order.Provider.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.Provider.Location.Department
  String
  Possible
  Department
- Order.Provider.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Order.Provider.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Order.Provider.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.Provider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Order.EnteredBy.ID
  String
  Possible
  ID of the The provider who actually entered the order.
  This ID is often required for Inpatient Visits.
- Order.EnteredBy.IDType
  String
  Possible
  ID type of the ID for the The provider who actually entered the order.
- Order.EnteredBy.FirstName
  String
  Possible
  First name of the The provider who actually entered the order.
- Order.EnteredBy.LastName
  String
  Possible
  Last name of the The provider who actually entered the order.
- Order.EnteredBy.Credentials[]
  Array of Strings
  Possible
  List of credentials for the The provider who actually entered the order.
  e.g. MD, PhD
- Order.EnteredBy.Address
  Object
  Possible
  Provider's address
- Order.EnteredBy.Address.StreetAddress
  String
  Possible
  Street address
- Order.EnteredBy.Address.City
  String
  Possible
  City
- Order.EnteredBy.Address.State
  String
  Possible
  State
- Order.EnteredBy.Address.ZIP
  String
  Possible
  ZIP
- Order.EnteredBy.Address.County
  String
  Possible
  County
- Order.EnteredBy.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.EnteredBy.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Order.EnteredBy.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Order.EnteredBy.Location
  Object
  Possible
  Provider's location
- Order.EnteredBy.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Order.EnteredBy.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Order.EnteredBy.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Order.EnteredBy.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Order.EnteredBy.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.EnteredBy.Location.Department
  String
  Possible
  Department
- Order.EnteredBy.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Order.EnteredBy.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Order.EnteredBy.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.EnteredBy.Location.Room
  String
  Possible
  Room.
  Example: 136
- Order.VerifiedBy.ID
  String
  Possible
  ID of the The pharmacist who verified the order.
  This ID is often required for Inpatient Visits.
- Order.VerifiedBy.IDType
  String
  Possible
  ID type of the ID for the The pharmacist who verified the order.
- Order.VerifiedBy.FirstName
  String
  Possible
  First name of the The pharmacist who verified the order.
- Order.VerifiedBy.LastName
  String
  Possible
  Last name of the The pharmacist who verified the order.
- Order.VerifiedBy.Credentials[]
  Array of Strings
  Possible
  List of credentials for the The pharmacist who verified the order.
  e.g. MD, PhD
- Order.VerifiedBy.Address
  Object
  Possible
  Provider's address
- Order.VerifiedBy.Address.StreetAddress
  String
  Possible
  Street address
- Order.VerifiedBy.Address.City
  String
  Possible
  City
- Order.VerifiedBy.Address.State
  String
  Possible
  State
- Order.VerifiedBy.Address.ZIP
  String
  Possible
  ZIP
- Order.VerifiedBy.Address.County
  String
  Possible
  County
- Order.VerifiedBy.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.VerifiedBy.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Order.VerifiedBy.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Order.VerifiedBy.Location
  Object
  Possible
  Provider's location
- Order.VerifiedBy.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Order.VerifiedBy.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Order.VerifiedBy.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Order.VerifiedBy.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Order.VerifiedBy.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.VerifiedBy.Location.Department
  String
  Possible
  Department
- Order.VerifiedBy.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Order.VerifiedBy.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Order.VerifiedBy.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Order.VerifiedBy.Location.Room
  String
  Possible
  Room.
  Example: 136
- Order.Priority
  String
  Reliable
  ValueSet
  Priority of the order
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.Pharmacy
  Object
  Probable
  The pharmacy at which the medication should be dispensed.
- Order.Pharmacy.Code
  String
  Probable
  Code for the pharmacy
- Order.Pharmacy.Codeset
  String
  Probable
  Code set used to identify the pharmacy
- Order.Pharmacy.Description
  String
  Probable
  Description of the pharmacy
- Order.Pharmacy.Address
  Object
  Probable
  The physical location at which the medication should be dispensed.
- Order.Pharmacy.Address.StreetAddress
  String
  Probable
  Street address
- Order.Pharmacy.Address.City
  String
  Probable
  City
- Order.Pharmacy.Address.State
  String
  Probable
  State
- Order.Pharmacy.Address.ZIP
  String
  Probable
  ZIP
- Order.Pharmacy.Address.County
  String
  Possible
  County
- Order.Pharmacy.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Order.Pharmacy.PhoneNumber.Office
  String
  Possible
  Pharmacy's office phone number.
  In E. 164 Format. (e.g. +16085551234)

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Medications",
      "EventType": "Cancel",
      "EventDateTime": "2024-04-15T21:22:43.979Z",
      "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
   },
   "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": [],
      "Allergies": [
         {
            "Code": "7982",
            "CodeSystem": null,
            "CodeSystemName": null,
            "Name": "Penicillin",
            "AltCodes": [],
            "Substance": {
               "Code": null,
               "CodeSystem": null,
               "CodeSystemName": null,
               "Name": null,
               "AltCodes": []
            },
            "Reaction": [
               {
                  "Code": "28926001",
                  "CodeSystem": null,
                  "CodeSystemName": null,
                  "Name": "Rash",
                  "AltCodes": [],
                  "Severity": {
                     "Code": null,
                     "CodeSystem": null,
                     "CodeSystemName": null,
                     "Name": null
                  },
                  "Text": null
               },
               {
                  "Code": "247472004",
                  "CodeSystem": null,
                  "CodeSystemName": null,
                  "Name": "Hives",
                  "AltCodes": [],
                  "Severity": {
                     "Code": null,
                     "CodeSystem": null,
                     "CodeSystemName": null,
                     "Name": null
                  },
                  "Text": null
               }
            ],
            "Severity": {
               "Code": null,
               "CodeSystem": null,
               "CodeSystemName": null,
               "Name": null
            },
            "Criticality": {
               "Code": null,
               "CodeSystem": null,
               "CodeSystemName": null,
               "Name": null
            },
            "Status": {
               "Code": null,
               "CodeSystem": null,
               "CodeSystemName": null,
               "Name": null
            },
            "StartDate": null,
            "EndDate": null,
            "Comment": null
         }
      ]
   },
   "Visit": {
      "VisitDateTime": "2024-04-15T21:22:44.638Z",
      "VisitNumber": "1234",
      "AccountNumber": null,
      "PatientClass": null,
      "Location": {
         "Type": null,
         "Facility": null,
         "FacilityIdentifiers": [],
         "Department": null,
         "DepartmentIdentifiers": [],
         "Room": null,
         "Bed": null
      },
      "AttendingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "FacilityIdentifiers": [],
            "Department": null,
            "DepartmentIdentifiers": [],
            "Room": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "FacilityIdentifiers": [],
            "Department": null,
            "DepartmentIdentifiers": [],
            "Room": null
         }
      },
      "Insurances": []
   },
   "Order": {
      "ID": "de927687-ba7b-4b52-870e-7abecc54c6c3",
      "Notes": [],
      "Medication": {
         "Dose": {
            "Quantity": 4,
            "Units": "mg"
         },
         "Rate": {
            "Quantity": null,
            "Units": null
         },
         "Route": {
            "Code": "C38288",
            "CodeSystem": "2.16.840.1.113883.3.26.1.1",
            "CodeSystemName": "NCI Thesaurus",
            "Name": "Oral",
            "AltCodes": []
         },
         "Components": [],
         "Product": {
            "Code": "104894",
            "CodeSystem": "2.16.840.1.113883.6.88",
            "CodeSystemName": "RxNorm",
            "Name": "Ondansetron 4 Mg Po Tbdp",
            "AltCodes": [],
            "Strength": {
               "Quantity": 4,
               "Units": "mg"
            },
            "Type": "Tablet"
         },
         "FreeTextSig": null,
         "StartDate": "2024-04-15T21:22:43.976Z",
         "EndDate": null,
         "Frequency": {
            "Period": 8,
            "Unit": "h"
         },
         "IsPRN": null,
         "Dispense": {
            "Amount": null,
            "Units": null
         },
         "NumberOfRefillsRemaining": 4,
         "TotalRefills": 6,
         "LastRefillDate": "2024-04-15T21:22:43.976Z"
      },
      "Indications": [],
      "Provider": {
         "NPI": "4356789876",
         "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
         }
      },
      "EnteredBy": {
         "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
         }
      },
      "VerifiedBy": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "FacilityIdentifiers": [],
            "Department": null,
            "DepartmentIdentifiers": [],
            "Room": null
         }
      },
      "Priority": null,
      "Pharmacy": {
         "Code": "1234567",
         "Codeset": "NCPDP",
         "Description": "Fake Pharmacy",
         "Address": {
            "StreetAddress": "123 Fake Street",
            "City": "Madison",
            "State": "WI",
            "ZIP": 53703,
            "County": null,
            "Country": null
         },
         "PhoneNumber": {
            "Office": null
         }
      }
   }
}

Administration

BETA

Administration events record that a patient received a given medication.

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  Medications
- Meta.EventType
  String
  Reliable
  Required
  Administration
- Meta.EventDateTime
  DateTime
  Reliable
  Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Indicates whether the request is a test or not.
- Meta.Source
  String
  Reliable
  Contains the information for the system initiating the message, including the source ID and name.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  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
- Meta.Source.Name
  String
  Reliable
  Displays the name of the system initiating the message.
- Meta.Destinations[]
  Array of Objects
  Reliable
  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.
- Meta.Destinations[].ID
  String
  Reliable
  Identifies the endpoint that the request is directed to.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Displays the name of the endpoint that the request is directed to.
- Meta.Logs[]
  Array of Objects
  Reliable
  Contains the log identifier(s) for the request.
- Meta.Logs[].ID
  String
  Reliable
  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
- Meta.Logs[].AttemptID
  String
  Reliable
  Identifies the request log attempt value, which is useful when retries are possible.
  UUID
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
- Patient.Identifiers[]
  Array of Objects
  Reliable
  List of IDs and ID types that identify the patient
- Patient.Identifiers[].ID
  String
  Reliable
  Required
  ID for the patient
- Patient.Identifiers[].IDType
  String
  Reliable
  Required
  Type of ID.
  E.g. MRN, EPI
- Patient.Demographics.FirstName
  String
  Reliable
  Patient's first name
- Patient.Demographics.MiddleName
  String
  Possible
  Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- Patient.Demographics.LastName
  String
  Reliable
  Patient's last name
- Patient.Demographics.DOB
  String
  Reliable
  Patient's date of birth.
  In ISO 8601 format
- Patient.Demographics.SSN
  String
  Probable
  Patient's social security number
- Patient.Demographics.Sex
  String
  Reliable
  ValueSet
  Patient's sex
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Race
  String
  Possible
  ValueSet
  Patient's race
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsHispanic
  Boolean
  Possible
  ValueSet
  Indicates if the patient is of hispanic origin.
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Religion
  String
  Possible
  ValueSet
  Patient's religious affiliation
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.MaritalStatus
  String
  Possible
  ValueSet
  Patient's marital status
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.IsDeceased
  Boolean
  Possible
  Indicates if the patient is deceased
- Patient.Demographics.DeathDateTime
  DateTime
  Possible
  Date and Time the patient was proclaimed deceased.
  ISO 8601 Format
- Patient.Demographics.PhoneNumber.Home
  String
  Probable
  Patient's home phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Office
  String
  Probable
  Patient's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.PhoneNumber.Mobile
  String
  Probable
  Patient's mobile phone number.
  In E. 164 Format. (e.g. +16085551234)
- Patient.Demographics.EmailAddresses[]
  Array of Strings
  Probable
  Patient's email address(es)
- Patient.Demographics.Language
  String
  Possible
  ValueSet
  Patient's primary spoken language
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Citizenship[]
  Array of strings
  Possible
  ValueSet
  Patient's nation(s) of citizenship
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Demographics.Address
  Object
  Probable
  Patient's home address
- Patient.Demographics.Address.StreetAddress
  String
  Probable
  Street address
- Patient.Demographics.Address.City
  String
  Probable
  City
- Patient.Demographics.Address.State
  String
  Probable
  State
- Patient.Demographics.Address.ZIP
  String
  Probable
  ZIP
- Patient.Demographics.Address.County
  String
  Possible
  County
- Patient.Demographics.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Patient.Notes[]
  Array of strings
  Possible
  Patient-level notes
Visit
- Visit
  Object
  Probable
  The visit in which the medication administration was performed.
- Visit.VisitDateTime
  String
  Probable
  DateTime of visit or the arrival time of the admission.
  ISO 8601 Format
- Visit.VisitNumber
  String
  Probable
  Visit Number.
  Unique ID of a single visit
- Visit.AccountNumber
  String
  Probable
  Account Number.
  An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
- Visit.PatientClass
  String
  Probable
  Patient class is used in many EHRs to determine where to put the patient.
  Examples: Inpatient, Outpatient, Emergency
- Visit.Location
  Object
  Probable
  Location of the visit
- Visit.Location.Type
  String
  Probable
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.Location.Facility
  String
  Probable
  Facility.
  Example: Community Hospital
- Visit.Location.FacilityIdentifiers[]
  Array of Objects
  Probable
  List of IDs specific to this facility
- Visit.Location.FacilityIdentifiers[].ID
  String
  Probable
  An ID specific to this facility
- Visit.Location.FacilityIdentifiers[].IDType
  String
  Probable
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.Location.Department
  String
  Probable
  Department
- Visit.Location.DepartmentIdentifiers[]
  Array of Objects
  Probable
  List of IDs specific to this department
- Visit.Location.DepartmentIdentifiers[].ID
  String
  Probable
  An ID specific to this department
- Visit.Location.DepartmentIdentifiers[].IDType
  String
  Probable
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.Location.Room
  String
  Probable
  Room.
  Example: 136
- Visit.Location.Bed
  String
  Probable
  Bed.
  Example: B
- Visit.AttendingProvider.ID
  String
  Probable
  ID of the attending provider.
  This ID is often required for Inpatient Visits.
- Visit.AttendingProvider.IDType
  String
  Probable
  ID type of the ID for the attending provider
- Visit.AttendingProvider.FirstName
  String
  Possible
  First name of the attending provider
- Visit.AttendingProvider.LastName
  String
  Possible
  Last name of the attending provider
- Visit.AttendingProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the attending provider.
  e.g. MD, PhD
- Visit.AttendingProvider.Address
  Object
  Possible
  Provider's address
- Visit.AttendingProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.AttendingProvider.Address.City
  String
  Possible
  City
- Visit.AttendingProvider.Address.State
  String
  Possible
  State
- Visit.AttendingProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.AttendingProvider.Address.County
  String
  Possible
  County
- Visit.AttendingProvider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.AttendingProvider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Visit.AttendingProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.AttendingProvider.Location
  Object
  Possible
  Provider's location
- Visit.AttendingProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.AttendingProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.AttendingProvider.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.AttendingProvider.Location.Department
  String
  Possible
  Department
- Visit.AttendingProvider.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.AttendingProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Visit.ReferringProvider.ID
  String
  Probable
  ID of the referring provider.
  This ID is often required for Inpatient Visits.
- Visit.ReferringProvider.IDType
  String
  Probable
  ID type of the ID for the referring provider
- Visit.ReferringProvider.FirstName
  String
  Possible
  First name of the referring provider
- Visit.ReferringProvider.LastName
  String
  Possible
  Last name of the referring provider
- Visit.ReferringProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the referring provider.
  e.g. MD, PhD
- Visit.ReferringProvider.Address
  Object
  Possible
  Provider's address
- Visit.ReferringProvider.Address.StreetAddress
  String
  Possible
  Street address
- Visit.ReferringProvider.Address.City
  String
  Possible
  City
- Visit.ReferringProvider.Address.State
  String
  Possible
  State
- Visit.ReferringProvider.Address.ZIP
  String
  Possible
  ZIP
- Visit.ReferringProvider.Address.County
  String
  Possible
  County
- Visit.ReferringProvider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Visit.ReferringProvider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Visit.ReferringProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Visit.ReferringProvider.Location
  Object
  Possible
  Provider's location
- Visit.ReferringProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Visit.ReferringProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Visit.ReferringProvider.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.ReferringProvider.Location.Department
  String
  Possible
  Department
- Visit.ReferringProvider.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Visit.ReferringProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
Administrations
- Administrations[]
  Array of Objects
  Probable
  Medication Administrations documented as part of this event
- Administrations[].Status
  String
  Reliable
  Required
  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 either Complete, Refused, or Partially Administered
- Administrations[].Medication
  Object
  Probable
  Data about the particular product administered, including dose and route.
- Administrations[].Medication.Order.ID
  String
  Probable
  An identifier for the order that resulted in this administration.
- Administrations[].Medication.LotNumber
  String
  Probable
  Lot number of the medication administered.
- Administrations[].Medication.Dose.Quantity
  Numeric
  Probable
  The size of the dose for pills, capsules, etc.
- Administrations[].Medication.Dose.Units
  String
  Probable
  The units of the dose.
  UCUM Units of Measure
- Administrations[].Medication.Rate.Quantity
  Numeric
  Probable
  If the medication is in liquid form, the rate at which it is administered
- Administrations[].Medication.Rate.Units
  String
  Probable
  Units for the rate.
  UCUM Units of Measure
- Administrations[].Medication.Route.Code
  String
  Probable
  A code describing the method by which the medication is delivered.
  Medication Route FDA Value Set
- Administrations[].Medication.Route.CodeSystem
  String
  Probable
  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.
- Administrations[].Medication.Route.CodeSystemName
  String
  Probable
  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.
- Administrations[].Medication.Route.Name
  String
  Probable
  Name of the method by which the medication is delivered
- Administrations[].Medication.Route.AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the method by which the medication is delivered
- Administrations[].Medication.Route.AltCodes[].Code
  String
  Possible
  A code describing the method by which the medication is delivered
- Administrations[].Medication.Route.AltCodes[].CodeSystem
  String
  Possible
  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.
- Administrations[].Medication.Route.AltCodes[].CodeSystemName
  String
  Possible
  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.
- Administrations[].Medication.Route.AltCodes[].Name
  String
  Possible
  Name of the method by which the medication is delivered
- Administrations[].Medication.Components[]
  Array of Objects
  Reliable
  The components of the medication
- Administrations[].Medication.Components[].Code
  String
  Possible
  A code describing the components of the medication
- Administrations[].Medication.Components[].CodeSystem
  String
  Possible
  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.
- Administrations[].Medication.Components[].CodeSystemName
  String
  Possible
  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.
- Administrations[].Medication.Components[].Name
  String
  Possible
  Name of the components of the medication
- Administrations[].Medication.Components[].Type
  String
  Probable
  The type of component.
  Allowed values are Base or Additive
- Administrations[].Medication.Components[].Dose.Quantity
  Numeric
  Probable
  The size of the dose for the component.
- Administrations[].Medication.Components[].Dose.Units
  String
  Probable
  The units of the dose.
  UCUM Units of Measure
- Administrations[].Medication.Product.Code
  String
  Reliable
  Required
  A code describing the actual medication given.
  Redox recommends using RxNorm
- Administrations[].Medication.Product.CodeSystem
  String
  Reliable
  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.
- Administrations[].Medication.Product.CodeSystemName
  String
  Reliable
  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.
- Administrations[].Medication.Product.Name
  String
  Reliable
  Name of the actual medication given
- Administrations[].Medication.Product.AltCodes[]
  Array of Objects
  Possible
  Alternate or translation codes for the actual medication given
- Administrations[].Medication.Product.AltCodes[].Code
  String
  Possible
  A code describing the actual medication given
- Administrations[].Medication.Product.AltCodes[].CodeSystem
  String
  Possible
  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.
- Administrations[].Medication.Product.AltCodes[].CodeSystemName
  String
  Possible
  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.
- Administrations[].Medication.Product.AltCodes[].Name
  String
  Possible
  Name of the actual medication given
- Administrations[].Medication.Product.Strength.Quantity
  Numeric
  Possible
  The size of the strength for the medication product.
- Administrations[].Medication.Product.Strength.Units
  String
  Possible
  The units of the medication product strength.
  UCUM Units of Measure
- Administrations[].Medication.Product.Type
  String
  Possible
  The type of product
- Administrations[].Medication.Indications[]
  Array of Objects
  Probable
  This field identifies the condition or problem for which the drug/treatment was prescribed.
- Administrations[].Medication.Indications[].Code
  String
  Probable
  Code
- Administrations[].Medication.Indications[].Codeset
  String
  Probable
  Code set
- Administrations[].Medication.Indications[].Description
  String
  Probable
  Description
- Administrations[].StartDate
  String
  Reliable
  When the administration started.
  ISO 8601 Format. In the event that the administration was
- Administrations[].EndDate
  String
  Probable
  When the administration ended.
  ISO 8601 Format
- Administrations[].AdministeringProvider.NPI
  String
  Possible
  NPI of the The provider who actually administered the medication.
- Administrations[].AdministeringProvider.ID
  String
  Possible
  ID of the The provider who actually administered the medication.
  This ID is often required for Inpatient Visits.
- Administrations[].AdministeringProvider.IDType
  String
  Possible
  ID type of the ID for the The provider who actually administered the medication.
- Administrations[].AdministeringProvider.FirstName
  String
  Possible
  First name of the The provider who actually administered the medication.
- Administrations[].AdministeringProvider.LastName
  String
  Possible
  Last name of the The provider who actually administered the medication.
- Administrations[].AdministeringProvider.Credentials[]
  Array of Strings
  Possible
  List of credentials for the The provider who actually administered the medication.
  e.g. MD, PhD
- Administrations[].AdministeringProvider.Address
  Object
  Possible
  Provider's address
- Administrations[].AdministeringProvider.Address.StreetAddress
  String
  Possible
  Street address
- Administrations[].AdministeringProvider.Address.City
  String
  Possible
  City
- Administrations[].AdministeringProvider.Address.State
  String
  Possible
  State
- Administrations[].AdministeringProvider.Address.ZIP
  String
  Possible
  ZIP
- Administrations[].AdministeringProvider.Address.County
  String
  Possible
  County
- Administrations[].AdministeringProvider.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Administrations[].AdministeringProvider.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Administrations[].AdministeringProvider.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Administrations[].AdministeringProvider.Location
  Object
  Possible
  Provider's location
- Administrations[].AdministeringProvider.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Administrations[].AdministeringProvider.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Administrations[].AdministeringProvider.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Administrations[].AdministeringProvider.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Administrations[].AdministeringProvider.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Administrations[].AdministeringProvider.Location.Department
  String
  Possible
  Department
- Administrations[].AdministeringProvider.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Administrations[].AdministeringProvider.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Administrations[].AdministeringProvider.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Administrations[].AdministeringProvider.Location.Room
  String
  Possible
  Room.
  Example: 136
- Administrations[].OrderedBy.ID
  String
  Possible
  ID of the The provider who actually entered the order.
  This ID is often required for Inpatient Visits.
- Administrations[].OrderedBy.IDType
  String
  Possible
  ID type of the ID for the The provider who actually entered the order.
- Administrations[].OrderedBy.FirstName
  String
  Possible
  First name of the The provider who actually entered the order.
- Administrations[].OrderedBy.LastName
  String
  Possible
  Last name of the The provider who actually entered the order.
- Administrations[].OrderedBy.Credentials[]
  Array of Strings
  Possible
  List of credentials for the The provider who actually entered the order.
  e.g. MD, PhD
- Administrations[].OrderedBy.Address
  Object
  Possible
  Provider's address
- Administrations[].OrderedBy.Address.StreetAddress
  String
  Possible
  Street address
- Administrations[].OrderedBy.Address.City
  String
  Possible
  City
- Administrations[].OrderedBy.Address.State
  String
  Possible
  State
- Administrations[].OrderedBy.Address.ZIP
  String
  Possible
  ZIP
- Administrations[].OrderedBy.Address.County
  String
  Possible
  County
- Administrations[].OrderedBy.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Administrations[].OrderedBy.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Administrations[].OrderedBy.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Administrations[].OrderedBy.Location
  Object
  Possible
  Provider's location
- Administrations[].OrderedBy.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Administrations[].OrderedBy.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Administrations[].OrderedBy.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Administrations[].OrderedBy.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Administrations[].OrderedBy.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Administrations[].OrderedBy.Location.Department
  String
  Possible
  Department
- Administrations[].OrderedBy.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Administrations[].OrderedBy.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Administrations[].OrderedBy.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Administrations[].OrderedBy.Location.Room
  String
  Possible
  Room.
  Example: 136
- Administrations[].VerifiedBy.ID
  String
  Possible
  ID of the The pharmacist who verified the order.
  This ID is often required for Inpatient Visits.
- Administrations[].VerifiedBy.IDType
  String
  Possible
  ID type of the ID for the The pharmacist who verified the order.
- Administrations[].VerifiedBy.FirstName
  String
  Possible
  First name of the The pharmacist who verified the order.
- Administrations[].VerifiedBy.LastName
  String
  Possible
  Last name of the The pharmacist who verified the order.
- Administrations[].VerifiedBy.Credentials[]
  Array of Strings
  Possible
  List of credentials for the The pharmacist who verified the order.
  e.g. MD, PhD
- Administrations[].VerifiedBy.Address
  Object
  Possible
  Provider's address
- Administrations[].VerifiedBy.Address.StreetAddress
  String
  Possible
  Street address
- Administrations[].VerifiedBy.Address.City
  String
  Possible
  City
- Administrations[].VerifiedBy.Address.State
  String
  Possible
  State
- Administrations[].VerifiedBy.Address.ZIP
  String
  Possible
  ZIP
- Administrations[].VerifiedBy.Address.County
  String
  Possible
  County
- Administrations[].VerifiedBy.Address.Country
  String
  Possible
  ValueSet
  Country
  
  Supported Values
  
  Additional values may be added by Redox in the future.
- Administrations[].VerifiedBy.EmailAddresses[]
  Array of Strings
  Probable
  Provider's email address(es)
- Administrations[].VerifiedBy.PhoneNumber.Office
  String
  Possible
  Provider's office phone number.
  In E. 164 Format. (e.g. +16085551234)
- Administrations[].VerifiedBy.Location
  Object
  Possible
  Provider's location
- Administrations[].VerifiedBy.Location.Type
  String
  Possible
  Type of location.
  Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
- Administrations[].VerifiedBy.Location.Facility
  String
  Possible
  Facility.
  Example: Community Hospital
- Administrations[].VerifiedBy.Location.FacilityIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this facility
- Administrations[].VerifiedBy.Location.FacilityIdentifiers[].ID
  String
  Possible
  An ID specific to this facility
- Administrations[].VerifiedBy.Location.FacilityIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Administrations[].VerifiedBy.Location.Department
  String
  Possible
  Department
- Administrations[].VerifiedBy.Location.DepartmentIdentifiers[]
  Array of Objects
  Possible
  List of IDs specific to this department
- Administrations[].VerifiedBy.Location.DepartmentIdentifiers[].ID
  String
  Possible
  An ID specific to this department
- Administrations[].VerifiedBy.Location.DepartmentIdentifiers[].IDType
  String
  Possible
  The source or system to which this ID pertains.
  Could be an OID or a human-readable name
- Administrations[].VerifiedBy.Location.Room
  String
  Possible
  Room.
  Example: 136

Sample MessageDownload JSON Schema

{
   "Meta": {
      "DataModel": "Medications",
      "EventType": "Administration",
      "EventDateTime": "2024-04-15T21:22:43.979Z",
      "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
   },
   "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": []
   },
   "Visit": {
      "VisitDateTime": "2024-04-15T21:22:44.644Z",
      "VisitNumber": "1234",
      "AccountNumber": null,
      "PatientClass": null,
      "Location": {
         "Type": null,
         "Facility": null,
         "FacilityIdentifiers": [],
         "Department": null,
         "DepartmentIdentifiers": [],
         "Room": null,
         "Bed": null
      },
      "AttendingProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "FacilityIdentifiers": [],
            "Department": null,
            "DepartmentIdentifiers": [],
            "Room": null
         }
      },
      "ReferringProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "FacilityIdentifiers": [],
            "Department": null,
            "DepartmentIdentifiers": [],
            "Room": null
         }
      }
   },
   "Administrations": [
      {
         "Status": "Complete",
         "Medication": {
            "Order": {
               "ID": "f122aaf1-792f-436f-af38-4ab662bdc87e"
            },
            "LotNumber": null,
            "Dose": {
               "Quantity": 4,
               "Units": "mg"
            },
            "Rate": {
               "Quantity": null,
               "Units": null
            },
            "Route": {
               "Code": "C38288",
               "CodeSystem": "2.16.840.1.113883.3.26.1.1",
               "CodeSystemName": "NCI Thesaurus",
               "Name": "Oral",
               "AltCodes": []
            },
            "Components": [],
            "Product": {
               "Code": "104894",
               "CodeSystem": "2.16.840.1.113883.6.88",
               "CodeSystemName": "RxNorm",
               "Name": "Ondansetron 4 Mg Po Tbdp",
               "AltCodes": [],
               "Strength": {
                  "Quantity": 4,
                  "Units": "mg"
               },
               "Type": "Tablet"
            },
            "Indications": []
         },
         "StartDate": "2024-04-15T21:22:43.976Z",
         "EndDate": null,
         "AdministeringProvider": {
            "NPI": "4356789876",
            "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
            }
         },
         "OrderedBy": {
            "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
            }
         },
         "VerifiedBy": {
            "ID": null,
            "IDType": null,
            "FirstName": null,
            "LastName": null,
            "Credentials": [],
            "Address": {
               "StreetAddress": null,
               "City": null,
               "State": null,
               "ZIP": null,
               "County": null,
               "Country": null
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": null
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "FacilityIdentifiers": [],
               "Department": null,
               "DepartmentIdentifiers": [],
               "Room": null
            }
         }
      }
   ]
}

Medications

Newlink

Fields

Meta

Patient

Visit

Order

Updatelink

Fields

Meta

Patient

Visit

Order

Cancellink

Fields

Meta

Patient

Visit

Order

Administrationlink

Fields

Meta

Patient

Visit

Administrations

New

Update

Cancel

Administration