Class Medication

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.Medication
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class Medication extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR Medication Resource (clinical.medication)

Definition: This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Medication

See Also:
Serialized Form
  • Field Details

    • SP_CODE

      public static final String SP_CODE
      Search parameter constant for code

      Description:
      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:
      Type: token
      Path: Medication.code

    • SP_MANUFACTURER

      public static final String SP_MANUFACTURER
      Search parameter constant for manufacturer

      Description:
      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:
      Type: reference
      Path: Medication.manufacturer

    • SP_FORM

      public static final String SP_FORM
      Search parameter constant for form

      Description:
      Type: token
      Path: Medication.product.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:
      Type: token
      Path: Medication.product.form

    • SP_INGREDIENT

      public static final String SP_INGREDIENT
      Search parameter constant for ingredient

      Description:
      Type: reference
      Path: Medication.product.ingredient.item

      See Also:
      Constant Field Values
    • INGREDIENT

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

      Description:
      Type: reference
      Path: Medication.product.ingredient.item

    • SP_CONTAINER

      public static final String SP_CONTAINER
      Search parameter constant for container

      Description:
      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:
      Type: token
      Path: Medication.package.container

    • SP_CONTENT

      public static final String SP_CONTENT
      Search parameter constant for content

      Description:
      Type: reference
      Path: Medication.package.content.item

      See Also:
      Constant Field Values
    • CONTENT

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

      Description:
      Type: reference
      Path: Medication.package.content.item

    • INCLUDE_CONTENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Medication:content".
    • 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".
    • 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".
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getCode

      Gets the value(s) for code (class). creating it if it does not exist. Will not return null.

      Definition: 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.

    • setCode

      public Medication setCode(CodeableConceptDt theValue)
      Sets the value(s) for code (class)

      Definition: 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.

    • getIsBrandElement

      public ca.uhn.fhir.model.primitive.BooleanDt getIsBrandElement()
      Gets the value(s) for isBrand (class). creating it if it does not exist. Will not return null.

      Definition: Set to true if the item is attributable to a specific manufacturer.

    • getIsBrand

      public Boolean getIsBrand()
      Gets the value(s) for isBrand (class). creating it if it does not exist. This method may return null.

      Definition: Set to true if the item is attributable to a specific manufacturer.

    • setIsBrand

      public Medication setIsBrand(ca.uhn.fhir.model.primitive.BooleanDt theValue)
      Sets the value(s) for isBrand (class)

      Definition: Set to true if the item is attributable to a specific manufacturer.

    • setIsBrand

      public Medication setIsBrand(boolean theBoolean)
      Sets the value for isBrand (class)

      Definition: Set to true if the item is attributable to a specific manufacturer.

    • getManufacturer

      Gets the value(s) for manufacturer (who.actor). creating it if it does not exist. Will not return null.

      Definition: Describes the details of the manufacturer

    • setManufacturer

      Sets the value(s) for manufacturer (who.actor)

      Definition: Describes the details of the manufacturer

    • getProduct

      Gets the value(s) for product (). creating it if it does not exist. Will not return null.

      Definition: Information that only applies to products (not packages)

    • setProduct

      Sets the value(s) for product ()

      Definition: Information that only applies to products (not packages)

    • getPackage

      Gets the value(s) for package (). creating it if it does not exist. Will not return null.

      Definition: Information that only applies to packages (not products)

    • setPackage

      Sets the value(s) for package ()

      Definition: Information that only applies to packages (not products)

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource