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 for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.
    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.
      • 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.
      • form

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

        protected Ratio amount
        Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
      • SP_EXPIRATION_DATE

        public static final String SP_EXPIRATION_DATE
        Search parameter: expiration-date

        Description: Returns medications in a batch with this expiration date
        Type: date
        Path: Medication.batch.expirationDate

        See Also:
        Constant Field Values
      • EXPIRATION_DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam EXPIRATION_DATE
        Fluent Client search parameter constant for expiration-date

        Description: Returns medications in a batch with this expiration date
        Type: date
        Path: Medication.batch.expirationDate

      • SP_FORM

        public static final String SP_FORM
        Search parameter: form

        Description: Returns medications for a specific dose form
        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: Returns medications for a specific dose form
        Type: token
        Path: Medication.form

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: Returns medications with this external identifier
        Type: token
        Path: Medication.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

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

        Description: Returns medications with this external identifier
        Type: token
        Path: Medication.identifier

      • SP_INGREDIENT_CODE

        public static final String SP_INGREDIENT_CODE
        Search parameter: ingredient-code

        Description: Returns medications for this ingredient code
        Type: token
        Path: (Medication.ingredient.item as CodeableConcept)

        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: Returns medications for this ingredient code
        Type: token
        Path: (Medication.ingredient.item as CodeableConcept)

      • SP_INGREDIENT

        public static final String SP_INGREDIENT
        Search parameter: ingredient

        Description: Returns medications for this ingredient reference
        Type: reference
        Path: (Medication.ingredient.item as Reference)

        See Also:
        Constant Field Values
      • INGREDIENT

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

        Description: Returns medications for this ingredient reference
        Type: reference
        Path: (Medication.ingredient.item as Reference)

      • 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_LOT_NUMBER

        public static final String SP_LOT_NUMBER
        Search parameter: lot-number

        Description: Returns medications in a batch with this lot number
        Type: token
        Path: Medication.batch.lotNumber

        See Also:
        Constant Field Values
      • LOT_NUMBER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam LOT_NUMBER
        Fluent Client search parameter constant for lot-number

        Description: Returns medications in a batch with this lot number
        Type: token
        Path: Medication.batch.lotNumber

      • SP_MANUFACTURER

        public static final String SP_MANUFACTURER
        Search parameter: manufacturer

        Description: Returns medications made or sold for this manufacturer
        Type: reference
        Path: Medication.manufacturer

        See Also:
        Constant Field Values
      • MANUFACTURER

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

        Description: Returns medications made or sold for this manufacturer
        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_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: Returns medications for this status
        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: Returns medications for this status
        Type: token
        Path: Medication.status

      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [Condition](condition.html): Code for the condition [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationStatement](medicationstatement.html): Return statements of this medication code [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [ServiceRequest](servicerequest.html): What is being requested/ordered
        Type: token
        Path: AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Condition.code | (DeviceRequest.code as CodeableConcept) | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | (MedicationAdministration.medication as CodeableConcept) | (MedicationDispense.medication as CodeableConcept) | (MedicationRequest.medication as CodeableConcept) | (MedicationStatement.medication as CodeableConcept) | Observation.code | Procedure.code | ServiceRequest.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: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [Condition](condition.html): Code for the condition [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationStatement](medicationstatement.html): Return statements of this medication code [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [ServiceRequest](servicerequest.html): What is being requested/ordered
        Type: token
        Path: AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Condition.code | (DeviceRequest.code as CodeableConcept) | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | (MedicationAdministration.medication as CodeableConcept) | (MedicationDispense.medication as CodeableConcept) | (MedicationRequest.medication as CodeableConcept) | (MedicationStatement.medication as CodeableConcept) | Observation.code | Procedure.code | ServiceRequest.code

    • Constructor Detail