Home
API reference
Redox Data Models
Medications
Cancel

Medications

This data model allows real-time notifications of medication information for patients, whether for new or existing prescriptions.

Mediation data varies across healthcare organizations. We normalize some of these differences for you, but you may see that one provider provides more or less details than another. We recommend being flexible with differences and do extensive testing during implementation to verify that you don't have any issues with the varying levels of medication data.

If you're looking for a list of current medications, review the ClinicalSummary data model.

This data model has event types that allow you to:

  • request a new medication for a patient;
  • update or cancel an existing prescription for a patient; or
  • record when a patient receives a medication.

Cancel

Send a request to cancel an existing medication request.

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Medications

    • EventType
      required, string
      Reliable

      Cancel

    • EventDateTime
      string, null
      Reliable

      Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
      ISO 8601 Format

    • Test
      boolean, null
      Reliable

      Indicates whether the request is a test or not.

    • Source
      object

      Contains the information for the system initiating the message, including the source ID and name.
      Included in messages from Redox

      • ID
        string, null
        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

      • Name
        string, null
        Reliable

        Displays the name of the system initiating the message.

    • Destinations
      Array of object

      Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
      Required when sending data to Redox.

      • ID
        string, null
        Reliable

        Identifies the endpoint that the request is directed to.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the endpoint that the request is directed to.

    • Logs
      Array of object

      Contains the log identifier(s) for the request.

      • ID
        string, null
        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

      • AttemptID
        string, null
        Reliable

        Identifies the request log attempt value, which is useful when retries are possible.
        UUID

    • FacilityCode
      string, null
      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
    required, object
    • Identifiers
      required, Array of object

      List of IDs and ID types that identify the patient

      • ID
        required, string
        Reliable

        ID for the patient

      • IDType
        required, string
        Reliable

        Type of ID.
        E.g. MRN, EPI

    • Demographics
      object
      • FirstName
        string, null
        Reliable

        Patient's first name

      • MiddleName
        string, null
        Possible

        Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.

      • LastName
        string, null
        Reliable

        Patient's last name

      • DOB
        string, null
        Reliable

        Patient's date of birth.
        In ISO 8601 format

      • SSN
        string, null
        Probable

        Patient's social security number

      • Sex
        string, null
        Reliable
        Value Set

        Patient's sex

      • Race
        string, null
        Possible
        Value Set

        Patient's race

      • IsHispanic
        boolean, null
        Possible
        Value Set

        Indicates if the patient is of hispanic origin.

      • Religion
        string, null
        Possible
        Value Set

        Patient's religious affiliation

      • MaritalStatus
        string, null
        Possible
        Value Set

        Patient's marital status

      • IsDeceased
        boolean, null
        Possible

        Indicates if the patient is deceased

      • DeathDateTime
        string, null
        Possible

        Date and Time the patient was proclaimed deceased.
        ISO 8601 Format

      • PhoneNumber
        object
        • Home
          string, null
          Probable

          Patient's home phone number.
          In E. 164 Format. (e.g. +16085551234)

        • Office
          string, null
          Probable

          Patient's office phone number.
          In E. 164 Format. (e.g. +16085551234)

        • Mobile
          string, null
          Probable

          Patient's mobile phone number.
          In E. 164 Format. (e.g. +16085551234)

      • EmailAddresses
        Array of string

        Patient's email address(es)

      • Language
        string, null
        Possible
        Value Set

        Patient's primary spoken language.
        In ISO 639-1 alpha values (e.g. 'en'). Supported Values

      • Citizenship
        Array of string

        Patient's nation(s) of citizenship.
        In ISO 3166 alpha 2 format (e.g. 'US').

      • Address
        object

        Patient's home address

        • StreetAddress
          string, null
          Probable

          Street address

        • City
          string, null
          Probable

          City

        • State
          string, null
          Probable

          State

        • ZIP
          string, null
          Probable

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

    • Notes
      Array of string

      Patient-level notes

    • Allergies
      Array of object
      • Code
        string, null
        Probable

        A code describing the type of allergy intolerance this is (food, drug, etc.).
        SNOMED CT from Allergy/Adverse Event Type Value Set

      • CodeSystem
        string, null
        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.

      • CodeSystemName
        string, null
        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.

      • Name
        string, null
        Probable

        Name of the type of allergy intolerance this is (food, drug, etc.)

      • AltCodes
        Array of object

        Alternate or translation codes for the type of allergy intolerance this is (food, drug, etc.)

        • Code
          string, null
          Possible

          A code describing the type of allergy intolerance this is (food, drug, etc.)

        • CodeSystem
          string, null
          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.

        • CodeSystemName
          string, null
          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.

        • Name
          string, null
          Possible

          Name of the type of allergy intolerance this is (food, drug, etc.)

      • Substance
        object
        • Code
          string, null
          Probable

          A code describing the substance that causes the allergy/intolerance.
          RxNorm, SNOMED CT, NDF-RT, UNII

        • CodeSystem
          string, null
          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.

        • CodeSystemName
          string, null
          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.

        • Name
          string, null
          Probable

          Name of the substance that causes the allergy/intolerance

        • AltCodes
          Array of object

          Alternate or translation codes for the substance that causes the allergy/intolerance

          • Code
            string, null
            Possible

            A code describing the substance that causes the allergy/intolerance

          • CodeSystem
            string, null
            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.

          • CodeSystemName
            string, null
            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.

          • Name
            string, null
            Possible

            Name of the substance that causes the allergy/intolerance

      • Reaction
        Array of object

        All the reactions caused by this particular substance.
        SNOMED CT

        • Code
          string, null
          Probable

          A code describing the reaction caused by the allergy (dizziness, hives, etc.).
          SNOMED CT

        • CodeSystem
          string, null
          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.

        • CodeSystemName
          string, null
          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.

        • Name
          string, null
          Probable

          Name of the reaction caused by the allergy (dizziness, hives, etc.)

        • AltCodes
          Array of object

          Alternate or translation codes for the reaction caused by the allergy (dizziness, hives, etc.)

          • Code
            string, null
            Possible

            A code describing the reaction caused by the allergy (dizziness, hives, etc.)

          • CodeSystem
            string, null
            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.

          • CodeSystemName
            string, null
            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.

          • Name
            string, null
            Possible

            Name of the reaction caused by the allergy (dizziness, hives, etc.)

        • Severity
          object
          • Code
            string, null
            Probable

            A code describing a code for the severity of the reaction (moderate, severe, etc.).
            SNOMED CT

          • CodeSystem
            string, null
            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.

          • CodeSystemName
            string, null
            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.

          • Name
            string, null
            Probable

            Name of a code for the severity of the reaction (moderate, severe, etc.)

        • Text
          string, null
          Probable

          Free text form of reactions to this substance, includes information that cannot be captured by coded value.

      • Severity
        object
        • Code
          string, null
          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.

        • CodeSystem
          string, null
          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.

        • CodeSystemName
          string, null
          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.

        • Name
          string, null
          Probable

          Name of a code for the severity of the reaction (moderate, severe, etc.).

      • Criticality
        object
        • Code
          string, null
          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.

        • CodeSystem
          string, null
          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.

        • CodeSystemName
          string, null
          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.

        • Name
          string, null
          Probable

          Name of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).

      • Status
        object
        • Code
          string, null
          Probable

          A code describing the current status of the allergy (active, historic, etc.).
          SNOMED CT (Active, Inactive, Resolved)

        • CodeSystem
          string, null
          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.

        • CodeSystemName
          string, null
          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.

        • Name
          string, null
          Probable

          Name of the current status of the allergy (active, historic, etc.)

      • StartDate
        string, null
        Probable

        When the allergy was first noted.
        ISO 8601 Format

      • EndDate
        string, null
        Probable

        When the allergy was no longer a problem (if applicable).
        ISO 8601 Format

      • Comment
        string, null
        Probable

        Free text comment about the allergy.

  • Order
    required, object
    • ID
      required, string
      Reliable

      ID assigned by the ordering system

    • Medication
      required, object
      • Product
        required, object
        • Code
          required, string
          Reliable

          A code describing the actual medication given.
          Redox recommends using RxNorm

        • CodeSystem
          string, null
          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.

        • CodeSystemName
          string, null
          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.

        • Name
          string, null
          Reliable

          Name of the actual medication given

        • AltCodes
          Array of object

          Alternate or translation codes for the actual medication given

          • Code
            string, null
            Possible

            A code describing the actual medication given

          • CodeSystem
            string, null
            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.

          • CodeSystemName
            string, null
            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.

          • Name
            string, null
            Possible

            Name of the actual medication given

        • Strength
          object
          • Quantity
            number, null
            Possible

            The size of the strength for the medication product.

          • Units
            string, null
            Possible

            The units of the medication product strength.
            UCUM Units of Measure

        • Type
          string, null
          Possible

          The type of product

      • Dose
        object
        • Quantity
          number, null
          Probable

          The size of the dose for pills, capsules, etc.

        • Units
          string, null
          Probable

          The units of the dose.
          UCUM Units of Measure

      • Rate
        object
        • Quantity
          number, null
          Probable

          If the medication is in liquid form, the rate at which it is administered

        • Units
          string, null
          Probable

          Units for the rate.
          UCUM Units of Measure

      • Route
        object
        • Code
          string, null
          Probable

          A code describing the method by which the medication is delivered.
          Medication Route FDA Value Set

        • CodeSystem
          string, null
          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.

        • CodeSystemName
          string, null
          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.

        • Name
          string, null
          Probable

          Name of the method by which the medication is delivered

        • AltCodes
          Array of object

          Alternate or translation codes for the method by which the medication is delivered

          • Code
            string, null
            Possible

            A code describing the method by which the medication is delivered

          • CodeSystem
            string, null
            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.

          • CodeSystemName
            string, null
            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.

          • Name
            string, null
            Possible

            Name of the method by which the medication is delivered

      • Components
        Array of object

        The components of the medication

        • Code
          string, null
          Possible

          A code describing the components of the medication

        • CodeSystem
          string, null
          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.

        • CodeSystemName
          string, null
          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.

        • Name
          string, null
          Possible

          Name of the components of the medication

        • Type
          string, null
          Probable

          The type of component.
          Allowed values are Base or Additive

        • Dose
          object
          • Quantity
            number, null
            Probable

            The size of the dose for the component.

          • Units
            string, null
            Probable

            The units of the dose.
            UCUM Units of Measure

      • FreeTextSig
        string, null
        Possible

        Free text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication

      • StartDate
        string, null
        Reliable

        When the medication should be started.
        ISO 8601 Format

      • EndDate
        string, null
        Probable

        When the medication should be ended.
        ISO 8601 Format

      • Frequency
        object
        • Period
          number, null
          Probable

          How often the patient should be taking the medication

        • Unit
          string, null
          Probable

          Units for how often the patient should be taking the medication.
          UCUM Units of Measure

      • IsPRN
        boolean, null
        Probable

        Whether the medication is to be taken on an as-needed basis

      • Dispense
        object
        • Amount
          number, null
          Probable

          The amount to be dispensed

        • Units
          string, null
          Probable

          Units for the dispensed amount

      • NumberOfRefillsRemaining
        number, null
        Probable

        The number of authorized refills remaining on the prescription

      • TotalRefills
        number, null
        Probable

        The total number of refills prescribed

      • LastRefillDate
        string, null
        Probable

        The date which the refill was last filled.
        ISO 8601 Format

    • Notes
      Array of string

      Order-level notes

    • Indications
      Array of object

      This field identifies the condition or problem for which the drug/treatment was prescribed.

      • Code
        string, null
        Probable

        Code

      • Codeset
        string, null
        Probable

        Code set

      • Description
        string, null
        Probable

        Description

    • Provider
      object
      • NPI
        string, null
        Possible

        NPI of the Ordering provider who is licensed to prescribe medications.

      • ID
        string, null
        Possible

        ID of the Ordering provider who is licensed to prescribe medications.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Possible

        ID type of the ID for the Ordering provider who is licensed to prescribe medications.

      • FirstName
        string, null
        Possible

        First name of the Ordering provider who is licensed to prescribe medications.

      • LastName
        string, null
        Possible

        Last name of the Ordering provider who is licensed to prescribe medications.

      • Credentials
        Array of string

        List of credentials for the Ordering provider who is licensed to prescribe medications.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • EnteredBy
      object
      • ID
        string, null
        Possible

        ID of the The provider who actually entered the order.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Possible

        ID type of the ID for the The provider who actually entered the order.

      • FirstName
        string, null
        Possible

        First name of the The provider who actually entered the order.

      • LastName
        string, null
        Possible

        Last name of the The provider who actually entered the order.

      • Credentials
        Array of string

        List of credentials for the The provider who actually entered the order.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • VerifiedBy
      object
      • ID
        string, null
        Possible

        ID of the The pharmacist who verified the order.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Possible

        ID type of the ID for the The pharmacist who verified the order.

      • FirstName
        string, null
        Possible

        First name of the The pharmacist who verified the order.

      • LastName
        string, null
        Possible

        Last name of the The pharmacist who verified the order.

      • Credentials
        Array of string

        List of credentials for the The pharmacist who verified the order.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • Priority
      string, null
      Reliable
      Value Set

      Priority of the order.
      One of the following: "Stat", "ASAP", "Routine"

    • Pharmacy
      object

      The pharmacy at which the medication should be dispensed.

      • Code
        string, null
        Probable

        Code for the pharmacy

      • Codeset
        string, null
        Probable

        Code set used to identify the pharmacy

      • Description
        string, null
        Probable

        Description of the pharmacy

      • Address
        object

        The physical location at which the medication should be dispensed.

        • StreetAddress
          string, null
          Probable

          Street address

        • City
          string, null
          Probable

          City

        • State
          string, null
          Probable

          State

        • ZIP
          string, null
          Probable

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Pharmacy's office phone number.
          In E. 164 Format. (e.g. +16085551234)

  • Visit
    object

    The visit that relates to this medication.

    • VisitDateTime
      string, null
      Possible

      DateTime of visit or the arrival time of the admission.
      ISO 8601 Format

    • VisitNumber
      string, null
      Possible

      Visit Number.
      Unique ID of a single visit

    • AccountNumber
      string, null
      Possible

      Account Number.
      An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.

    • PatientClass
      string, null
      Possible

      Patient class is used in many EHRs to determine where to put the patient.
      Examples: Inpatient, Outpatient, Emergency

    • Location
      object

      Location of the visit

      • Type
        string, null
        Possible

        Type of location.
        Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

      • Facility
        string, null
        Possible

        Facility.
        Example: Community Hospital

      • FacilityIdentifiers
        Array of object

        List of IDs specific to this facility

        • ID
          string, null
          Possible

          An ID specific to this facility

        • IDType
          string, null
          Possible

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Department
        string, null
        Possible

        Department

      • DepartmentIdentifiers
        Array of object

        List of IDs specific to this department

        • ID
          string, null
          Possible

          An ID specific to this department

        • IDType
          string, null
          Possible

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Room
        string, null
        Possible

        Room.
        Example: 136

      • Bed
        string, null
        Possible

        Bed.
        Example: B

    • AttendingProvider
      object
      • ID
        string, null
        Possible

        ID of the attending provider.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Possible

        ID type of the ID for the attending provider

      • FirstName
        string, null
        Possible

        First name of the attending provider

      • LastName
        string, null
        Possible

        Last name of the attending provider

      • Credentials
        Array of string

        List of credentials for the attending provider.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • ReferringProvider
      object
      • ID
        string, null
        Possible

        ID of the referring provider.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Possible

        ID type of the ID for the referring provider

      • FirstName
        string, null
        Possible

        First name of the referring provider

      • LastName
        string, null
        Possible

        Last name of the referring provider

      • Credentials
        Array of string

        List of credentials for the referring provider.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • Insurances
      Array of object

      List of insurance coverages for the patient that should be used for the medication.

      • Plan
        object
        • ID
          string, null
          Probable

          Identifier of insurance plan

        • IDType
          string, null
          Probable

          ID type of insurance plan

        • Name
          string, null
          Probable

          Name of insurance plan

        • Type
          string, null
          Possible

          Type of insurance plan

      • MemberNumber
        string, null
        Possible

        Patient member number

      • Company
        object
        • ID
          string, null
          Probable

          ID of insurance company (payor)

        • IDType
          string, null
          Probable

          ID type of insurance company (payor)

        • Name
          string, null
          Probable

          Name of insurance company (payor)

        • Address
          object

          Insurance company's address

          • StreetAddress
            string, null
            Probable

            Street address

          • City
            string, null
            Probable

            City

          • State
            string, null
            Probable

            State

          • ZIP
            string, null
            Probable

            ZIP

          • County
            string, null
            Possible

            County

          • Country
            string, null
            Possible
            Value Set

            Country

        • PhoneNumber
          string, null
          Probable

          Insurance companys phone number.
          In E. 164 Format (i.e. +16085551234)

      • GroupNumber
        string, null
        Probable

        Insurance policy group number

      • GroupName
        string, null
        Probable

        Insurance policy group name

      • EffectiveDate
        string, null
        Probable

        Effect date of this insurance policy.
        In YYYY-MM-DD format

      • ExpirationDate
        string, null
        Probable

        Expiration date of this insurance policy.
        In YYYY-MM-DD format

      • PolicyNumber
        string, null
        Probable

        Insurance policy number

      • Priority
        string, null
        Possible
        Value Set

        The insurance priority sequence.
        If the insurance works in conjunction with other insurance plans, this field contains priority sequence.

      • AgreementType
        string, null
        Probable
        Value Set

        Type of insurance agreement.

      • CoverageType
        string, null
        Probable
        Value Set

        Type of insurance agreement.
        Indicates who will be receiving the bill for the service.

      • Insured
        object

        Individual who has the agreement with the insurance company for the related policy

        • Identifiers
          Array of object

          List of IDs and ID types that identify the insured

          • ID
            string, null
            Possible

            ID for the insured

          • IDType
            string, null
            Possible

            Type of ID.
            E.g. MRN, EPI

        • LastName
          string, null
          Possible

          Last name of the insured

        • MiddleName
          string, null
          Possible

          Middle name of the insured

        • FirstName
          string, null
          Possible

          First name of the insured

        • SSN
          string, null
          Possible

          Insured's social security number

        • Relationship
          string, null
          Possible
          Value Set

          Relationship of the insured to the patient

        • DOB
          string, null
          Possible

          Date of birth of the insured.
          In YYYY-MM-DD format

        • Sex
          string, null
          Possible
          Value Set

          Sex of the insured

        • Address
          object

          Address of the insured

          • StreetAddress
            string, null
            Probable

            Street address

          • City
            string, null
            Probable

            City

          • State
            string, null
            Probable

            State

          • ZIP
            string, null
            Probable

            ZIP

          • County
            string, null
            Possible

            County

          • Country
            string, null
            Possible
            Value Set

            Country

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Medications",
4
    "EventType": "Cancel",
5
    "EventDateTime": "2024-11-18T21:23:08.746Z",
6
    "Test": true,
7
    "Source": {
8
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
9
      "Name": "Redox Dev Tools"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
14
        "Name": "Redox EMR"
15
      }
16
    ],
17
    "Logs": [
18
      {
19
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
20
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
21
      }
22
    ],
23
    "FacilityCode": null
24
  },
25
  "Patient": {
26
    "Identifiers": [
27
      {
28
        "ID": "0000000001",
29
        "IDType": "MR"
30
      },
31
      {
32
        "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
33
        "IDType": "EHRID"
34
      },
35
      {
36
        "ID": "a1d4ee8aba494ca",
37
        "IDType": "NIST"
38
      }
39
    ],
40
    "Demographics": {
41
      "FirstName": "Timothy",
42
      "MiddleName": "Paul",
43
      "LastName": "Bixby",
44
      "DOB": "2008-01-06",
45
      "SSN": "101-01-0001",
46
      "Sex": "Male",
47
      "Race": "White",
48
      "IsHispanic": null,
49
      "Religion": null,
50
      "MaritalStatus": "Single",
51
      "IsDeceased": null,
52
      "DeathDateTime": null,
53
      "PhoneNumber": {
54
        "Home": "+18088675301",
55
        "Office": null,
56
        "Mobile": null
57
      },
58
      "EmailAddresses": [],
59
      "Language": "en",
60
      "Citizenship": [],
61
      "Address": {
62
        "StreetAddress": "4762 Hickory Street",
63
        "City": "Monroe",
64
        "State": "WI",
65
        "ZIP": "53566",
66
        "County": "Green",
67
        "Country": "US"
68
      }
69
    },
70
    "Notes": [],
71
    "Allergies": [
72
      {
73
        "Code": "7982",
74
        "CodeSystem": null,
75
        "CodeSystemName": null,
76
        "Name": "Penicillin",
77
        "AltCodes": [],
78
        "Substance": {
79
          "Code": null,
80
          "CodeSystem": null,
81
          "CodeSystemName": null,
82
          "Name": null,
83
          "AltCodes": []
84
        },
85
        "Reaction": [
86
          {
87
            "Code": "28926001",
88
            "CodeSystem": null,
89
            "CodeSystemName": null,
90
            "Name": "Rash",
91
            "AltCodes": [],
92
            "Severity": {
93
              "Code": null,
94
              "CodeSystem": null,
95
              "CodeSystemName": null,
96
              "Name": null
97
            },
98
            "Text": null
99
          },
100
          {
101
            "Code": "247472004",
102
            "CodeSystem": null,
103
            "CodeSystemName": null,
104
            "Name": "Hives",
105
            "AltCodes": [],
106
            "Severity": {
107
              "Code": null,
108
              "CodeSystem": null,
109
              "CodeSystemName": null,
110
              "Name": null
111
            },
112
            "Text": null
113
          }
114
        ],
115
        "Severity": {
116
          "Code": null,
117
          "CodeSystem": null,
118
          "CodeSystemName": null,
119
          "Name": null
120
        },
121
        "Criticality": {
122
          "Code": null,
123
          "CodeSystem": null,
124
          "CodeSystemName": null,
125
          "Name": null
126
        },
127
        "Status": {
128
          "Code": null,
129
          "CodeSystem": null,
130
          "CodeSystemName": null,
131
          "Name": null
132
        },
133
        "StartDate": null,
134
        "EndDate": null,
135
        "Comment": null
136
      }
137
    ]
138
  },
139
  "Visit": {
140
    "VisitDateTime": "2024-11-18T21:23:08.973Z",
141
    "VisitNumber": "1234",
142
    "AccountNumber": null,
143
    "PatientClass": null,
144
    "Location": {
145
      "Type": null,
146
      "Facility": null,
147
      "FacilityIdentifiers": [],
148
      "Department": null,
149
      "DepartmentIdentifiers": [],
150
      "Room": null,
151
      "Bed": null
152
    },
153
    "AttendingProvider": {
154
      "ID": null,
155
      "IDType": null,
156
      "FirstName": null,
157
      "LastName": null,
158
      "Credentials": [],
159
      "Address": {
160
        "StreetAddress": null,
161
        "City": null,
162
        "State": null,
163
        "ZIP": null,
164
        "County": null,
165
        "Country": null
166
      },
167
      "EmailAddresses": [],
168
      "PhoneNumber": {
169
        "Office": null
170
      },
171
      "Location": {
172
        "Type": null,
173
        "Facility": null,
174
        "FacilityIdentifiers": [],
175
        "Department": null,
176
        "DepartmentIdentifiers": [],
177
        "Room": null
178
      }
179
    },
180
    "ReferringProvider": {
181
      "ID": null,
182
      "IDType": null,
183
      "FirstName": null,
184
      "LastName": null,
185
      "Credentials": [],
186
      "Address": {
187
        "StreetAddress": null,
188
        "City": null,
189
        "State": null,
190
        "ZIP": null,
191
        "County": null,
192
        "Country": null
193
      },
194
      "EmailAddresses": [],
195
      "PhoneNumber": {
196
        "Office": null
197
      },
198
      "Location": {
199
        "Type": null,
200
        "Facility": null,
201
        "FacilityIdentifiers": [],
202
        "Department": null,
203
        "DepartmentIdentifiers": [],
204
        "Room": null
205
      }
206
    },
207
    "Insurances": []
208
  },
209
  "Order": {
210
    "ID": "73b5faad-9312-49f1-83d0-d99309b5c671",
211
    "Notes": [],
212
    "Medication": {
213
      "Dose": {
214
        "Quantity": 4,
215
        "Units": "mg"
216
      },
217
      "Rate": {
218
        "Quantity": null,
219
        "Units": null
220
      },
221
      "Route": {
222
        "Code": "C38288",
223
        "CodeSystem": "2.16.840.1.113883.3.26.1.1",
224
        "CodeSystemName": "NCI Thesaurus",
225
        "Name": "Oral",
226
        "AltCodes": []
227
      },
228
      "Components": [],
229
      "Product": {
230
        "Code": "104894",
231
        "CodeSystem": "2.16.840.1.113883.6.88",
232
        "CodeSystemName": "RxNorm",
233
        "Name": "Ondansetron 4 Mg Po Tbdp",
234
        "AltCodes": [],
235
        "Strength": {
236
          "Quantity": 4,
237
          "Units": "mg"
238
        },
239
        "Type": "Tablet"
240
      },
241
      "FreeTextSig": null,
242
      "StartDate": "2024-11-18T21:23:08.744Z",
243
      "EndDate": null,
244
      "Frequency": {
245
        "Period": 8,
246
        "Unit": "h"
247
      },
248
      "IsPRN": null,
249
      "Dispense": {
250
        "Amount": null,
251
        "Units": null
252
      },
253
      "NumberOfRefillsRemaining": 4,
254
      "TotalRefills": 6,
255
      "LastRefillDate": "2024-11-18T21:23:08.744Z"
256
    },
257
    "Indications": [],
258
    "Provider": {
259
      "NPI": "4356789876",
260
      "ID": "4356789876",
261
      "IDType": "NPI",
262
      "FirstName": "Pat",
263
      "LastName": "Granite",
264
      "Credentials": [
265
        "MD"
266
      ],
267
      "Address": {
268
        "StreetAddress": "123 Main St.",
269
        "City": "Madison",
270
        "State": "WI",
271
        "ZIP": "53703",
272
        "County": "Dane",
273
        "Country": "USA"
274
      },
275
      "EmailAddresses": [],
276
      "PhoneNumber": {
277
        "Office": "+16085551234"
278
      },
279
      "Location": {
280
        "Type": null,
281
        "Facility": null,
282
        "FacilityIdentifiers": [],
283
        "Department": null,
284
        "DepartmentIdentifiers": [],
285
        "Room": null
286
      }
287
    },
288
    "EnteredBy": {
289
      "ID": "4356789876",
290
      "IDType": "NPI",
291
      "FirstName": "Pat",
292
      "LastName": "Granite",
293
      "Credentials": [
294
        "MD"
295
      ],
296
      "Address": {
297
        "StreetAddress": "123 Main St.",
298
        "City": "Madison",
299
        "State": "WI",
300
        "ZIP": "53703",
301
        "County": "Dane",
302
        "Country": "USA"
303
      },
304
      "EmailAddresses": [],
305
      "PhoneNumber": {
306
        "Office": "+16085551234"
307
      },
308
      "Location": {
309
        "Type": null,
310
        "Facility": null,
311
        "FacilityIdentifiers": [],
312
        "Department": null,
313
        "DepartmentIdentifiers": [],
314
        "Room": null
315
      }
316
    },
317
    "VerifiedBy": {
318
      "ID": null,
319
      "IDType": null,
320
      "FirstName": null,
321
      "LastName": null,
322
      "Credentials": [],
323
      "Address": {
324
        "StreetAddress": null,
325
        "City": null,
326
        "State": null,
327
        "ZIP": null,
328
        "County": null,
329
        "Country": null
330
      },
331
      "EmailAddresses": [],
332
      "PhoneNumber": {
333
        "Office": null
334
      },
335
      "Location": {
336
        "Type": null,
337
        "Facility": null,
338
        "FacilityIdentifiers": [],
339
        "Department": null,
340
        "DepartmentIdentifiers": [],
341
        "Room": null
342
      }
343
    },
344
    "Priority": null,
345
    "Pharmacy": {
346
      "Code": "1234567",
347
      "Codeset": "NCPDP",
348
      "Description": "Fake Pharmacy",
349
      "Address": {
350
        "StreetAddress": "123 Fake Street",
351
        "City": "Madison",
352
        "State": "WI",
353
        "ZIP": 53703,
354
        "County": null,
355
        "Country": null
356
      },
357
      "PhoneNumber": {
358
        "Office": null
359
      }
360
    }
361
  }
362
}