Class Medication

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

    public class Medication
    extends DomainResource
    This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
    See Also:
    Serialized Form
    • Field Detail

      • code

        protected CodeableConcept code
        A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
      • isBrand

        protected BooleanType isBrand
        Set to true if the item is attributable to a specific manufacturer.
      • isOverTheCounter

        protected BooleanType isOverTheCounter
        Set to true if the medication can be obtained without an order from a prescriber.
      • manufacturer

        protected Reference manufacturer
        Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
      • manufacturerTarget

        protected Organization manufacturerTarget
        The actual object that is the target of the reference (Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.)
      • form

        protected CodeableConcept form
        Describes the form of the item. Powder; tablets; capsule.
      • image

        protected List<Attachment> image
        Photo(s) or graphic representation(s) of the medication.
      • SP_INGREDIENT_CODE

        public static final String SP_INGREDIENT_CODE
        Search parameter: ingredient-code

        Description: The product contained
        Type: token
        Path: Medication.ingredient.itemCodeableConcept

        See Also:
        Constant Field Values
      • INGREDIENT_CODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam INGREDIENT_CODE
        Fluent Client search parameter constant for ingredient-code

        Description: The product contained
        Type: token
        Path: Medication.ingredient.itemCodeableConcept

      • SP_CONTAINER

        public static final String SP_CONTAINER
        Search parameter: container

        Description: E.g. box, vial, blister-pack
        Type: token
        Path: Medication.package.container

        See Also:
        Constant Field Values
      • CONTAINER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTAINER
        Fluent Client search parameter constant for container

        Description: E.g. box, vial, blister-pack
        Type: token
        Path: Medication.package.container

      • SP_PACKAGE_ITEM

        public static final String SP_PACKAGE_ITEM
        Search parameter: package-item

        Description: The item in the package
        Type: reference
        Path: Medication.package.content.itemReference

        See Also:
        Constant Field Values
      • PACKAGE_ITEM

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PACKAGE_ITEM
        Fluent Client search parameter constant for package-item

        Description: The item in the package
        Type: reference
        Path: Medication.package.content.itemReference

      • INCLUDE_PACKAGE_ITEM

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PACKAGE_ITEM
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Medication:package-item".
      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: Codes that identify this medication
        Type: token
        Path: Medication.code

        See Also:
        Constant Field Values
      • CODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
        Fluent Client search parameter constant for code

        Description: Codes that identify this medication
        Type: token
        Path: Medication.code

      • SP_INGREDIENT

        public static final String SP_INGREDIENT
        Search parameter: ingredient

        Description: The product contained
        Type: reference
        Path: Medication.ingredient.itemReference

        See Also:
        Constant Field Values
      • INGREDIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INGREDIENT
        Fluent Client search parameter constant for ingredient

        Description: The product contained
        Type: reference
        Path: Medication.ingredient.itemReference

      • INCLUDE_INGREDIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_INGREDIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Medication:ingredient".
      • SP_FORM

        public static final String SP_FORM
        Search parameter: form

        Description: powder | tablets | capsule +
        Type: token
        Path: Medication.form

        See Also:
        Constant Field Values
      • FORM

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam FORM
        Fluent Client search parameter constant for form

        Description: powder | tablets | capsule +
        Type: token
        Path: Medication.form

      • SP_PACKAGE_ITEM_CODE

        public static final String SP_PACKAGE_ITEM_CODE
        Search parameter: package-item-code

        Description: The item in the package
        Type: token
        Path: Medication.package.content.itemCodeableConcept

        See Also:
        Constant Field Values
      • PACKAGE_ITEM_CODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam PACKAGE_ITEM_CODE
        Fluent Client search parameter constant for package-item-code

        Description: The item in the package
        Type: token
        Path: Medication.package.content.itemCodeableConcept

      • MANUFACTURER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MANUFACTURER
        Fluent Client search parameter constant for manufacturer

        Description: Manufacturer of the item
        Type: reference
        Path: Medication.manufacturer

      • INCLUDE_MANUFACTURER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_MANUFACTURER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Medication:manufacturer".
      • SP_OVER_THE_COUNTER

        public static final String SP_OVER_THE_COUNTER
        Search parameter: over-the-counter

        Description: True if medication does not require a prescription
        Type: token
        Path: Medication.isOverTheCounter

        See Also:
        Constant Field Values
      • OVER_THE_COUNTER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam OVER_THE_COUNTER
        Fluent Client search parameter constant for over-the-counter

        Description: True if medication does not require a prescription
        Type: token
        Path: Medication.isOverTheCounter

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: active | inactive | entered-in-error
        Type: token
        Path: Medication.status

        See Also:
        Constant Field Values
      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: active | inactive | entered-in-error
        Type: token
        Path: Medication.status

    • Constructor Detail