Medication (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.Medication

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class Medication
extends BaseResource
implements IResource
```
HAPI/FHIR Medication Resource (Definition of a Medication)
Definition: Primarily used for identification and definition of Medication, but also covers ingredients and packaging

Requirements:

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Medication.Product` Block class for child element: Medication.product (Administrable medication details)
`static class`	`Medication.ProductIngredient` Block class for child element: Medication.product.ingredient (Active or inactive ingredient)

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`CODE` Fluent Client search parameter constant for code
`static TokenClientParam`	`CONTAINER` Fluent Client search parameter constant for container
`static ReferenceClientParam`	`CONTENT` Fluent Client search parameter constant for content
`static TokenClientParam`	`FORM` Fluent Client search parameter constant for form
`static Include`	`INCLUDE_MANUFACTURER` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PACKAGE_CONTENT_ITEM` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PRODUCT_INGREDIENT_ITEM` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`INGREDIENT` Fluent Client search parameter constant for ingredient
`static ReferenceClientParam`	`MANUFACTURER` Fluent Client search parameter constant for manufacturer
`static StringClientParam`	`NAME` Fluent Client search parameter constant for name
`static String`	`SP_CODE` Search parameter constant for code
`static String`	`SP_CONTAINER` Search parameter constant for container
`static String`	`SP_CONTENT` Search parameter constant for content
`static String`	`SP_FORM` Search parameter constant for form
`static String`	`SP_INGREDIENT` Search parameter constant for ingredient
`static String`	`SP_MANUFACTURER` Search parameter constant for manufacturer
`static String`	`SP_NAME` Search parameter constant for name

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

Medication()

Constructors
Constructor and Description
`Medication()`

Method Summary

Methods
Modifier and Type	Method and Description
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`CodeableConceptDt`	`getCode()` Gets the value(s) for code (Codes that identify this medication).
`BooleanDt`	`getIsBrand()` Gets the value(s) for isBrand (True if a brand).
`BoundCodeDt<MedicationKindEnum>`	`getKind()` Gets the value(s) for kind (product \| package).
`ResourceReferenceDt`	`getManufacturer()` Gets the value(s) for manufacturer (Manufacturer of the item).
`StringDt`	`getName()` Gets the value(s) for name (Common / Commercial name).
`CodeDt`	`getPackage()` Gets the value(s) for package (Details about packaged medications).
`Medication.Product`	`getProduct()` Gets the value(s) for product (Administrable medication details).
`boolean`	`isEmpty()`
`Medication`	`setCode(CodeableConceptDt theValue)` Sets the value(s) for code (Codes that identify this medication)
`Medication`	`setIsBrand(boolean theBoolean)` Sets the value for isBrand (True if a brand)
`Medication`	`setIsBrand(BooleanDt theValue)` Sets the value(s) for isBrand (True if a brand)
`Medication`	`setKind(BoundCodeDt<MedicationKindEnum> theValue)` Sets the value(s) for kind (product \| package)
`Medication`	`setKind(MedicationKindEnum theValue)` Sets the value(s) for kind (product \| package)
`Medication`	`setManufacturer(ResourceReferenceDt theValue)` Sets the value(s) for manufacturer (Manufacturer of the item)
`Medication`	`setName(String theString)` Sets the value for name (Common / Commercial name)
`Medication`	`setName(StringDt theValue)` Sets the value(s) for name (Common / Commercial name)
`Medication`	`setPackage(CodeDt theValue)` Sets the value(s) for package (Details about packaged medications)
`Medication`	`setPackage(String theCode)` Sets the value for package (Details about packaged medications)
`Medication`	`setProduct(Medication.Product theValue)` Sets the value(s) for product (Administrable medication details)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

- Field Detail
  - 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 TokenClientParam CODE
```
    Fluent Client search parameter constant for code
    Description:
    Type: token
    Path: Medication.code
  - SP_NAME
```
public static final String SP_NAME
```
    Search parameter constant for name
    Description:
    Type: string
    Path: Medication.name
    
    See Also:
    Constant Field Values
  - NAME
```
public static final StringClientParam NAME
```
    Fluent Client search parameter constant for name
    Description:
    Type: string
    Path: Medication.name
  - 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 ReferenceClientParam MANUFACTURER
```
    Fluent Client search parameter constant for manufacturer
    Description:
    Type: reference
    Path: Medication.manufacturer
  - INCLUDE_MANUFACTURER
```
public static final Include INCLUDE_MANUFACTURER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "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 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 ReferenceClientParam INGREDIENT
```
    Fluent Client search parameter constant for ingredient
    Description:
    Type: reference
    Path: Medication.product.ingredient.item
  - INCLUDE_PRODUCT_INGREDIENT_ITEM
```
public static final Include INCLUDE_PRODUCT_INGREDIENT_ITEM
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "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 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 ReferenceClientParam CONTENT
```
    Fluent Client search parameter constant for content
    Description:
    Type: reference
    Path: Medication.package.content.item
  - INCLUDE_PACKAGE_CONTENT_ITEM
```
public static final Include INCLUDE_PACKAGE_CONTENT_ITEM
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Medication.package.content.item".
- Constructor Detail
  - Medication
```
public Medication()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getName
```
public StringDt getName()
```
    Gets the value(s) for name (Common / Commercial name). creating it if it does not exist. Will not return null.
    Definition: The common/commercial name of the medication absent information such as strength, form, etc. E.g. Acetaminophen, Tylenol 3, etc. The fully coordinated name is communicated as the display of Medication.code
  - setName
```
public Medication setName(StringDt theValue)
```
    Sets the value(s) for name (Common / Commercial name)
    Definition: The common/commercial name of the medication absent information such as strength, form, etc. E.g. Acetaminophen, Tylenol 3, etc. The fully coordinated name is communicated as the display of Medication.code
  - setName
```
public Medication setName(String theString)
```
    Sets the value for name (Common / Commercial name)
    Definition: The common/commercial name of the medication absent information such as strength, form, etc. E.g. Acetaminophen, Tylenol 3, etc. The fully coordinated name is communicated as the display of Medication.code
  - getCode
```
public CodeableConceptDt getCode()
```
    Gets the value(s) for code (Codes that identify this medication). creating it if it does not exist. Will not return null.
    Definition: A code (or set of codes) that identify this medication. Usage note: This could be a standard drug code such as a drug regulator code, RxNorm code, SNOMED CT code, etc. It could also be a local formulary code, optionally with translations to the standard drug codes
  - setCode
```
public Medication setCode(CodeableConceptDt theValue)
```
    Sets the value(s) for code (Codes that identify this medication)
    Definition: A code (or set of codes) that identify this medication. Usage note: This could be a standard drug code such as a drug regulator code, RxNorm code, SNOMED CT code, etc. It could also be a local formulary code, optionally with translations to the standard drug codes
  - getIsBrand
```
public BooleanDt getIsBrand()
```
    Gets the value(s) for isBrand (True if a brand). creating it if it does not exist. Will not return null.
    Definition: Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is)
  - setIsBrand
```
public Medication setIsBrand(BooleanDt theValue)
```
    Sets the value(s) for isBrand (True if a brand)
    Definition: Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is)
  - setIsBrand
```
public Medication setIsBrand(boolean theBoolean)
```
    Sets the value for isBrand (True if a brand)
    Definition: Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is)
  - getManufacturer
```
public ResourceReferenceDt getManufacturer()
```
    Gets the value(s) for manufacturer (Manufacturer of the item). creating it if it does not exist. Will not return null.
    Definition: Describes the details of the manufacturer
  - setManufacturer
```
public Medication setManufacturer(ResourceReferenceDt theValue)
```
    Sets the value(s) for manufacturer (Manufacturer of the item)
    Definition: Describes the details of the manufacturer
  - getKind
```
public BoundCodeDt<MedicationKindEnum> getKind()
```
    Gets the value(s) for kind (product | package). creating it if it does not exist. Will not return null.
    Definition: Medications are either a single administrable product or a package that contains one or more products.
  - setKind
```
public Medication setKind(BoundCodeDt<MedicationKindEnum> theValue)
```
    Sets the value(s) for kind (product | package)
    Definition: Medications are either a single administrable product or a package that contains one or more products.
  - setKind
```
public Medication setKind(MedicationKindEnum theValue)
```
    Sets the value(s) for kind (product | package)
    Definition: Medications are either a single administrable product or a package that contains one or more products.
  - getProduct
```
public Medication.Product getProduct()
```
    Gets the value(s) for product (Administrable medication details). creating it if it does not exist. Will not return null.
    Definition: Information that only applies to products (not packages)
  - setProduct
```
public Medication setProduct(Medication.Product theValue)
```
    Sets the value(s) for product (Administrable medication details)
    Definition: Information that only applies to products (not packages)
  - getPackage
```
public CodeDt getPackage()
```
    Gets the value(s) for package (Details about packaged medications). creating it if it does not exist. Will not return null.
    Definition: Information that only applies to packages (not products)
  - setPackage
```
public Medication setPackage(CodeDt theValue)
```
    Sets the value(s) for package (Details about packaged medications)
    Definition: Information that only applies to packages (not products)
  - setPackage
```
public Medication setPackage(String theCode)
```
    Sets the value for package (Details about packaged medications)
    Definition: Information that only applies to packages (not products)

Class Medication

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Field Detail

SP_CODE

CODE

SP_NAME

NAME

SP_MANUFACTURER

MANUFACTURER

INCLUDE_MANUFACTURER

SP_FORM

FORM

SP_INGREDIENT

INGREDIENT

INCLUDE_PRODUCT_INGREDIENT_ITEM

SP_CONTAINER

CONTAINER

SP_CONTENT

CONTENT

INCLUDE_PACKAGE_CONTENT_ITEM

Constructor Detail

Medication

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getName

setName

setName

getCode

setCode

getIsBrand

setIsBrand

setIsBrand

getManufacturer

setManufacturer

getKind

setKind

setKind

getProduct

setProduct

getPackage

setPackage

setPackage