Package org.hl7.fhir.dstu2016may.model

Class Medication

java.lang.Object

org.hl7.fhir.dstu2016may.model.Base

org.hl7.fhir.dstu2016may.model.BaseResource

org.hl7.fhir.dstu2016may.model.Resource

org.hl7.fhir.dstu2016may.model.DomainResource

org.hl7.fhir.dstu2016may.model.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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Medication.MedicationPackageComponent
static class	Medication.MedicationPackageContentComponent
static class	Medication.MedicationProductBatchComponent
static class	Medication.MedicationProductComponent
static class	Medication.MedicationProductIngredientComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	code	A code (or set of codes) that specify this medication, or a textual description if no code is available.
static ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
static ca.uhn.fhir.rest.gclient.TokenClientParam	CONTAINER	Fluent Client search parameter constant for container
static ca.uhn.fhir.rest.gclient.TokenClientParam	FORM	Fluent Client search parameter constant for form
static ca.uhn.fhir.model.api.Include	INCLUDE_INGREDIENT	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_MANUFACTURER	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.model.api.Include	INCLUDE_PACKAGE_ITEM	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	INGREDIENT	Fluent Client search parameter constant for ingredient
static ca.uhn.fhir.rest.gclient.TokenClientParam	INGREDIENT_CODE	Fluent Client search parameter constant for ingredient-code
protected BooleanType	isBrand	Set to true if the item is attributable to a specific manufacturer.
protected Reference	manufacturer	Describes the details of the manufacturer.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	MANUFACTURER	Fluent Client search parameter constant for manufacturer
protected Organization	manufacturerTarget	The actual object that is the target of the reference (Describes the details of the manufacturer.)
protected Medication.MedicationPackageComponent	package_	Information that only applies to packages (not products).
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	PACKAGE_ITEM	Fluent Client search parameter constant for package-item
static ca.uhn.fhir.rest.gclient.TokenClientParam	PACKAGE_ITEM_CODE	Fluent Client search parameter constant for package-item-code
protected Medication.MedicationProductComponent	product	Information that only applies to products (not packages).
static String	SP_CODE	Search parameter: code
static String	SP_CONTAINER	Search parameter: container
static String	SP_FORM	Search parameter: form
static String	SP_INGREDIENT	Search parameter: ingredient
static String	SP_INGREDIENT_CODE	Search parameter: ingredient-code
static String	SP_MANUFACTURER	Search parameter: manufacturer
static String	SP_PACKAGE_ITEM	Search parameter: package-item
static String	SP_PACKAGE_ITEM_CODE	Search parameter: package-item-code

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Medication()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Medication	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
CodeableConcept	getCode()
boolean	getIsBrand()
BooleanType	getIsBrandElement()
Reference	getManufacturer()
Organization	getManufacturerTarget()
Medication.MedicationPackageComponent	getPackage()
Medication.MedicationProductComponent	getProduct()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
boolean	hasCode()
boolean	hasIsBrand()
boolean	hasIsBrandElement()
boolean	hasManufacturer()
boolean	hasPackage()
boolean	hasProduct()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Base	makeProperty(int hash, String name)	make an instance of a property.
Medication	setCode(CodeableConcept value)
Medication	setIsBrand(boolean value)
Medication	setIsBrandElement(BooleanType value)
Medication	setManufacturer(Reference value)
Medication	setManufacturerTarget(Organization value)
Medication	setPackage(Medication.MedicationPackageComponent value)
Medication	setProduct(Medication.MedicationProductComponent value)
void	setProperty(int hash, String name, Base value)
void	setProperty(String name, Base value)
protected Medication	typedCopy()

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource

copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource

getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, setId

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.

manufacturer

protected Reference manufacturer

Describes the details of the manufacturer.

manufacturerTarget

protected Organization manufacturerTarget

The actual object that is the target of the reference (Describes the details of the manufacturer.)

product

protected Medication.MedicationProductComponent product

Information that only applies to products (not packages).

package_

protected Medication.MedicationPackageComponent package_

Information that only applies to packages (not products).

SP_FORM

public static final String SP_FORM

Search parameter: form

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

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_MANUFACTURER

public static final String SP_MANUFACTURER

Search parameter: manufacturer

Description: Manufacturer of the item
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: 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_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

SP_INGREDIENT

public static final String SP_INGREDIENT

Search parameter: ingredient

Description: The product contained
Type: reference
Path: Medication.product.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.product.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_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_CODE

public static final String SP_INGREDIENT_CODE

Search parameter: ingredient-code

Description: The product contained
Type: token
Path: Medication.product.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.product.ingredient.itemCodeableConcept

Constructor Detail

Medication

public Medication()

Constructor

Method Detail

getCode

public CodeableConcept getCode()

Returns:

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

hasCode

public boolean hasCode()

setCode

public Medication setCode(CodeableConcept value)

Parameters:

value - 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.)

getIsBrandElement

public BooleanType getIsBrandElement()

Returns:

isBrand (Set to true if the item is attributable to a specific manufacturer.). This is the underlying object with id, value and extensions. The accessor "getIsBrand" gives direct access to the value

hasIsBrandElement

public boolean hasIsBrandElement()

hasIsBrand

public boolean hasIsBrand()

setIsBrandElement

public Medication setIsBrandElement(BooleanType value)

Parameters:

value - isBrand (Set to true if the item is attributable to a specific manufacturer.). This is the underlying object with id, value and extensions. The accessor "getIsBrand" gives direct access to the value

getIsBrand

public boolean getIsBrand()

Returns:

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

setIsBrand

public Medication setIsBrand(boolean value)

Parameters:

value - Set to true if the item is attributable to a specific manufacturer.

getManufacturer

public Reference getManufacturer()

Returns:

manufacturer (Describes the details of the manufacturer.)

hasManufacturer

public boolean hasManufacturer()

setManufacturer

public Medication setManufacturer(Reference value)

Parameters:

value - manufacturer (Describes the details of the manufacturer.)

getManufacturerTarget

public Organization getManufacturerTarget()

Returns:

manufacturer The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Describes the details of the manufacturer.)

setManufacturerTarget

public Medication setManufacturerTarget(Organization value)

Parameters:

value - manufacturer The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Describes the details of the manufacturer.)

getProduct

public Medication.MedicationProductComponent getProduct()

Returns:

product (Information that only applies to products (not packages).)

hasProduct

public boolean hasProduct()

setProduct

public Medication setProduct(Medication.MedicationProductComponent value)

Parameters:

value - product (Information that only applies to products (not packages).)

getPackage

public Medication.MedicationPackageComponent getPackage()

Returns:

package_ (Information that only applies to packages (not products).)

hasPackage

public boolean hasPackage()

setPackage

public Medication setPackage(Medication.MedicationPackageComponent value)

Parameters:

value - package_ (Information that only applies to packages (not products).)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Description copied from class: Base

make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property

Overrides:

makeProperty in class DomainResource

Returns:

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public Medication copy()

Specified by:

copy in class DomainResource

typedCopy

protected Medication typedCopy()

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource