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, including ingredients, for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.
See Also:
Serialized Form
  • Field Details

    • identifier

      Business identifier for this medication.
    • 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.
    • status

      A code to indicate if the medication is in active use.
    • marketingAuthorizationHolder

      Describes the organization that is responsible for the manufacturing of the item and holds the registration to market the product in a jurisdiction. This might not be the company that physically manufactures the product.  May be known as "Sponsor" and is commonly called "Manufacturer".
    • doseForm

      Describes the form of the item. Powder; tablets; capsule.
    • totalVolume

      protected Ratio totalVolume
      When the specified product code does not infer a package size, this is the specific amount of drug in the 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.).
    • ingredient

      Identifies a particular constituent of interest in the product.
    • batch

      Information that only applies to packages (not products).
    • 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: null

      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: null

    • 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.concept

      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.concept

    • SP_INGREDIENT

      public static final String SP_INGREDIENT
      Search parameter: ingredient

      Description: Returns medications for this ingredient reference
      Type: reference
      Path: Medication.ingredient.item.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.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_MARKETINGAUTHORIZATIONHOLDER

      Search parameter: marketingauthorizationholder

      Description: Returns medications made or sold for this marketing authorization holder
      Type: reference
      Path: Medication.marketingAuthorizationHolder

      See Also:
      Constant Field Values
    • MARKETINGAUTHORIZATIONHOLDER

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

      Description: Returns medications made or sold for this marketing authorization holder
      Type: reference
      Path: Medication.marketingAuthorizationHolder

    • INCLUDE_MARKETINGAUTHORIZATIONHOLDER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_MARKETINGAUTHORIZATIONHOLDER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Medication:marketingauthorizationholder".
    • 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 [MedicationUsage](medicationusage.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.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationUsage.medication.concept | 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 [MedicationUsage](medicationusage.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.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationUsage.medication.concept | Observation.code | Procedure.code | ServiceRequest.code

  • Constructor Details

  • Method Details