Package org.hl7.fhir.r5.model

Class AdministrableProductDefinition

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.AdministrableProductDefinition

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 AdministrableProductDefinition
extends DomainResource

A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent
static class	AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent
static class	AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponent
static class	AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesWithdrawalPeriodComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	administrableDoseForm	The dose form of the final product after necessary reconstitution or processing.
protected MarkdownType	description	A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed.
protected Reference	device	A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DEVICE	Fluent Client search parameter constant for device
static final ca.uhn.fhir.rest.gclient.TokenClientParam	DOSE_FORM	Fluent Client search parameter constant for dose-form
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	FORM_OF	Fluent Client search parameter constant for form-of
protected List<Reference>	formOf	References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product.
protected List<Identifier>	identifier	An identifier for the administrable product.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_DEVICE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_FORM_OF	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_MANUFACTURED_ITEM	Constant for fluent queries to be used to add include statements.
protected List<CodeableConcept>	ingredient	The ingredients of this administrable medicinal product.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	INGREDIENT	Fluent Client search parameter constant for ingredient
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	MANUFACTURED_ITEM	Fluent Client search parameter constant for manufactured-item
protected List<Reference>	producedFrom	Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form.
protected List<AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent>	property	Characteristics e.g. a product's onset of action.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ROUTE	Fluent Client search parameter constant for route
protected List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent>	routeOfAdministration	The path by which the product is taken into or makes contact with the body.
static final String	SP_DEVICE	Search parameter: device
static final String	SP_DOSE_FORM	Search parameter: dose-form
static final String	SP_FORM_OF	Search parameter: form-of
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_INGREDIENT	Search parameter: ingredient
static final String	SP_MANUFACTURED_ITEM	Search parameter: manufactured-item
static final String	SP_ROUTE	Search parameter: route
static final String	SP_STATUS	Search parameter: status
static final String	SP_TARGET_SPECIES	Search parameter: target-species
protected Enumeration<Enumerations.PublicationStatus>	status	The status of this administrable product.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TARGET_SPECIES	Fluent Client search parameter constant for target-species
protected CodeableConcept	unitOfPresentation	The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' (as in 'contains 100 mcg per puff'), or for a liquid - 'vial' (as in 'contains 5 ml per vial').

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

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

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
AdministrableProductDefinition()	Constructor
AdministrableProductDefinition(Enumerations.PublicationStatus status, AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent routeOfAdministration)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Reference	addFormOf()
AdministrableProductDefinition	addFormOf(Reference t)
Identifier	addIdentifier()
AdministrableProductDefinition	addIdentifier(Identifier t)
CodeableConcept	addIngredient()
AdministrableProductDefinition	addIngredient(CodeableConcept t)
Reference	addProducedFrom()
AdministrableProductDefinition	addProducedFrom(Reference t)
AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent	addProperty()
AdministrableProductDefinition	addProperty(AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent t)
AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent	addRouteOfAdministration()
AdministrableProductDefinition	addRouteOfAdministration(AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent t)
AdministrableProductDefinition	copy()
void	copyValues(AdministrableProductDefinition dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableConcept	getAdministrableDoseForm()
String	getDescription()
MarkdownType	getDescriptionElement()
Reference	getDevice()
List<Reference>	getFormOf()
Reference	getFormOfFirstRep()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CodeableConcept>	getIngredient()
CodeableConcept	getIngredientFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Reference>	getProducedFrom()
Reference	getProducedFromFirstRep()
List<AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent>	getProperty()
Base[]	getProperty(int hash, String name, boolean checkValid)
AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent	getPropertyFirstRep()
ResourceType	getResourceType()
List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent>	getRouteOfAdministration()
AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent	getRouteOfAdministrationFirstRep()
Enumerations.PublicationStatus	getStatus()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
String[]	getTypesForProperty(int hash, String name)
CodeableConcept	getUnitOfPresentation()
boolean	hasAdministrableDoseForm()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDevice()
boolean	hasFormOf()
boolean	hasIdentifier()
boolean	hasIngredient()
boolean	hasProducedFrom()
boolean	hasProperty()
boolean	hasRouteOfAdministration()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasUnitOfPresentation()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
AdministrableProductDefinition	setAdministrableDoseForm(CodeableConcept value)
AdministrableProductDefinition	setDescription(String value)
AdministrableProductDefinition	setDescriptionElement(MarkdownType value)
AdministrableProductDefinition	setDevice(Reference value)
AdministrableProductDefinition	setFormOf(List<Reference> theFormOf)
AdministrableProductDefinition	setIdentifier(List<Identifier> theIdentifier)
AdministrableProductDefinition	setIngredient(List<CodeableConcept> theIngredient)
AdministrableProductDefinition	setProducedFrom(List<Reference> theProducedFrom)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
AdministrableProductDefinition	setProperty(List<AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent> theProperty)
AdministrableProductDefinition	setRouteOfAdministration(List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent> theRouteOfAdministration)
AdministrableProductDefinition	setStatus(Enumerations.PublicationStatus value)
AdministrableProductDefinition	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
AdministrableProductDefinition	setUnitOfPresentation(CodeableConcept value)
protected AdministrableProductDefinition	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

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

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

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

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

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, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

An identifier for the administrable product.

status

protected Enumeration<Enumerations.PublicationStatus> status

The status of this administrable product. Enables tracking the life-cycle of the content.

formOf

protected List<Reference> formOf

References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product. If this administrable product describes the administration of a crushed tablet, the 'formOf' would be the product representing a distribution containing tablets and possibly also a cream. This is distinct from the 'producedFrom' which refers to the specific components of the product that are used in this preparation, rather than the product as a whole.

administrableDoseForm

protected CodeableConcept administrableDoseForm

The dose form of the final product after necessary reconstitution or processing. Contrasts to the manufactured dose form (see ManufacturedItemDefinition). If the manufactured form was 'powder for solution for injection', the administrable dose form could be 'solution for injection' (once mixed with another item having manufactured form 'solvent for solution for injection').

unitOfPresentation

protected CodeableConcept unitOfPresentation

The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' (as in 'contains 100 mcg per puff'), or for a liquid - 'vial' (as in 'contains 5 ml per vial').

producedFrom

protected List<Reference> producedFrom

Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form. In some cases, an administrable form might use all of the items from the overall product (or there might only be one item), while in other cases, an administrable form might use only a subset of the items available in the overall product. For example, an administrable form might involve combining a liquid and a powder available as part of an overall product, but not involve applying the also supplied cream.

ingredient

protected List<CodeableConcept> ingredient

The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton (via AdministrableProductDefinition.producedFrom) to state which component items are used to make this, or using by incoming references from the Ingredient resource, to state in detail which substances exist within this. This element allows a basic coded ingredient to be used.

device

protected Reference device

A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product. This is not intended for devices that are just co-packaged.

description

protected MarkdownType description

A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed. Intended to be used when the other structured properties of this resource are insufficient or cannot be supported. It is not intended to duplicate information already carried elswehere.

property

protected List<AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent> property

Characteristics e.g. a product's onset of action.

routeOfAdministration

protected List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent> routeOfAdministration

The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa).

SP_DEVICE

public static final String SP_DEVICE

Search parameter: device

Description: A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product. This is not intended for devices that are just co-packaged
Type: reference
Path: AdministrableProductDefinition.device

See Also:

• Constant Field Values

DEVICE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEVICE

Fluent Client search parameter constant for device

Description: A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product. This is not intended for devices that are just co-packaged
Type: reference
Path: AdministrableProductDefinition.device

INCLUDE_DEVICE

public static final ca.uhn.fhir.model.api.Include INCLUDE_DEVICE

Constant for fluent queries to be used to add include statements. Specifies the path value of "AdministrableProductDefinition:device".

SP_DOSE_FORM

public static final String SP_DOSE_FORM

Search parameter: dose-form

Description: The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing
Type: token
Path: AdministrableProductDefinition.administrableDoseForm

See Also:

• Constant Field Values

DOSE_FORM

public static final ca.uhn.fhir.rest.gclient.TokenClientParam DOSE_FORM

Fluent Client search parameter constant for dose-form

Description: The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing
Type: token
Path: AdministrableProductDefinition.administrableDoseForm

SP_FORM_OF

public static final String SP_FORM_OF

Search parameter: form-of

Description: The medicinal product that this is an administrable form of. This is not a reference to the item(s) that make up this administrable form - it is the whole product
Type: reference
Path: AdministrableProductDefinition.formOf

See Also:

• Constant Field Values

FORM_OF

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam FORM_OF

Fluent Client search parameter constant for form-of

Description: The medicinal product that this is an administrable form of. This is not a reference to the item(s) that make up this administrable form - it is the whole product
Type: reference
Path: AdministrableProductDefinition.formOf

INCLUDE_FORM_OF

public static final ca.uhn.fhir.model.api.Include INCLUDE_FORM_OF

Constant for fluent queries to be used to add include statements. Specifies the path value of "AdministrableProductDefinition:form-of".

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: An identifier for the administrable product
Type: token
Path: AdministrableProductDefinition.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: An identifier for the administrable product
Type: token
Path: AdministrableProductDefinition.identifier

SP_INGREDIENT

public static final String SP_INGREDIENT

Search parameter: ingredient

Description: The ingredients of this administrable medicinal product
Type: token
Path: AdministrableProductDefinition.ingredient

See Also:

• Constant Field Values

INGREDIENT

public static final ca.uhn.fhir.rest.gclient.TokenClientParam INGREDIENT

Fluent Client search parameter constant for ingredient

Description: The ingredients of this administrable medicinal product
Type: token
Path: AdministrableProductDefinition.ingredient

SP_MANUFACTURED_ITEM

public static final String SP_MANUFACTURED_ITEM

Search parameter: manufactured-item

Description: The manufactured item(s) that this administrable product is produced from. Either a single item, or several that are mixed before administration (e.g. a power item and a solution item). Note that these are not raw ingredients
Type: reference
Path: AdministrableProductDefinition.producedFrom

See Also:

• Constant Field Values

MANUFACTURED_ITEM

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MANUFACTURED_ITEM

Fluent Client search parameter constant for manufactured-item

Description: The manufactured item(s) that this administrable product is produced from. Either a single item, or several that are mixed before administration (e.g. a power item and a solution item). Note that these are not raw ingredients
Type: reference
Path: AdministrableProductDefinition.producedFrom

INCLUDE_MANUFACTURED_ITEM

public static final ca.uhn.fhir.model.api.Include INCLUDE_MANUFACTURED_ITEM

Constant for fluent queries to be used to add include statements. Specifies the path value of "AdministrableProductDefinition:manufactured-item".

SP_ROUTE

public static final String SP_ROUTE

Search parameter: route

Description: Coded expression for the route
Type: token
Path: AdministrableProductDefinition.routeOfAdministration.code

See Also:

• Constant Field Values

ROUTE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam ROUTE

Fluent Client search parameter constant for route

Description: Coded expression for the route
Type: token
Path: AdministrableProductDefinition.routeOfAdministration.code

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The status of this administrable product. Enables tracking the life-cycle of the content.
Type: token
Path: AdministrableProductDefinition.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: The status of this administrable product. Enables tracking the life-cycle of the content.
Type: token
Path: AdministrableProductDefinition.status

SP_TARGET_SPECIES

public static final String SP_TARGET_SPECIES

Search parameter: target-species

Description: Coded expression for the species
Type: token
Path: AdministrableProductDefinition.routeOfAdministration.targetSpecies.code

See Also:

• Constant Field Values

TARGET_SPECIES

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TARGET_SPECIES

Fluent Client search parameter constant for target-species

Description: Coded expression for the species
Type: token
Path: AdministrableProductDefinition.routeOfAdministration.targetSpecies.code

Constructor Details

AdministrableProductDefinition

public AdministrableProductDefinition()

Constructor

AdministrableProductDefinition

public AdministrableProductDefinition(Enumerations.PublicationStatus status,
 AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent routeOfAdministration)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (An identifier for the administrable product.)

setIdentifier

public AdministrableProductDefinition setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public AdministrableProductDefinition addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist {3}

getStatusElement

public Enumeration<Enumerations.PublicationStatus> getStatusElement()

Returns:

status (The status of this administrable product. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public AdministrableProductDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

Parameters:

value - status (The status of this administrable product. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Enumerations.PublicationStatus getStatus()

Returns:

The status of this administrable product. Enables tracking the life-cycle of the content.

setStatus

public AdministrableProductDefinition setStatus(Enumerations.PublicationStatus value)

Parameters:

value - The status of this administrable product. Enables tracking the life-cycle of the content.

getFormOf

public List<Reference> getFormOf()

Returns:

formOf (References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product. If this administrable product describes the administration of a crushed tablet, the 'formOf' would be the product representing a distribution containing tablets and possibly also a cream. This is distinct from the 'producedFrom' which refers to the specific components of the product that are used in this preparation, rather than the product as a whole.)

setFormOf

public AdministrableProductDefinition setFormOf(List<Reference> theFormOf)

Returns:

Returns a reference to this for easy method chaining

hasFormOf

public boolean hasFormOf()

addFormOf

public Reference addFormOf()

addFormOf

public AdministrableProductDefinition addFormOf(Reference t)

getFormOfFirstRep

public Reference getFormOfFirstRep()

Returns:

The first repetition of repeating field formOf, creating it if it does not already exist {3}

getAdministrableDoseForm

public CodeableConcept getAdministrableDoseForm()

Returns:

administrableDoseForm (The dose form of the final product after necessary reconstitution or processing. Contrasts to the manufactured dose form (see ManufacturedItemDefinition). If the manufactured form was 'powder for solution for injection', the administrable dose form could be 'solution for injection' (once mixed with another item having manufactured form 'solvent for solution for injection').)

hasAdministrableDoseForm

public boolean hasAdministrableDoseForm()

setAdministrableDoseForm

public AdministrableProductDefinition setAdministrableDoseForm(CodeableConcept value)

Parameters:

value - administrableDoseForm (The dose form of the final product after necessary reconstitution or processing. Contrasts to the manufactured dose form (see ManufacturedItemDefinition). If the manufactured form was 'powder for solution for injection', the administrable dose form could be 'solution for injection' (once mixed with another item having manufactured form 'solvent for solution for injection').)

getUnitOfPresentation

public CodeableConcept getUnitOfPresentation()

Returns:

unitOfPresentation (The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' (as in 'contains 100 mcg per puff'), or for a liquid - 'vial' (as in 'contains 5 ml per vial').)

hasUnitOfPresentation

public boolean hasUnitOfPresentation()

setUnitOfPresentation

public AdministrableProductDefinition setUnitOfPresentation(CodeableConcept value)

Parameters:

value - unitOfPresentation (The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' (as in 'contains 100 mcg per puff'), or for a liquid - 'vial' (as in 'contains 5 ml per vial').)

getProducedFrom

public List<Reference> getProducedFrom()

Returns:

producedFrom (Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form. In some cases, an administrable form might use all of the items from the overall product (or there might only be one item), while in other cases, an administrable form might use only a subset of the items available in the overall product. For example, an administrable form might involve combining a liquid and a powder available as part of an overall product, but not involve applying the also supplied cream.)

setProducedFrom

public AdministrableProductDefinition setProducedFrom(List<Reference> theProducedFrom)

Returns:

Returns a reference to this for easy method chaining

hasProducedFrom

public boolean hasProducedFrom()

addProducedFrom

public Reference addProducedFrom()

addProducedFrom

public AdministrableProductDefinition addProducedFrom(Reference t)

getProducedFromFirstRep

public Reference getProducedFromFirstRep()

Returns:

The first repetition of repeating field producedFrom, creating it if it does not already exist {3}

getIngredient

public List<CodeableConcept> getIngredient()

Returns:

ingredient (The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton (via AdministrableProductDefinition.producedFrom) to state which component items are used to make this, or using by incoming references from the Ingredient resource, to state in detail which substances exist within this. This element allows a basic coded ingredient to be used.)

setIngredient

public AdministrableProductDefinition setIngredient(List<CodeableConcept> theIngredient)

Returns:

Returns a reference to this for easy method chaining

hasIngredient

public boolean hasIngredient()

addIngredient

public CodeableConcept addIngredient()

addIngredient

public AdministrableProductDefinition addIngredient(CodeableConcept t)

getIngredientFirstRep

public CodeableConcept getIngredientFirstRep()

Returns:

The first repetition of repeating field ingredient, creating it if it does not already exist {3}

getDevice

public Reference getDevice()

Returns:

device (A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product. This is not intended for devices that are just co-packaged.)

hasDevice

public boolean hasDevice()

setDevice

public AdministrableProductDefinition setDevice(Reference value)

Parameters:

value - device (A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product. This is not intended for devices that are just co-packaged.)

getDescriptionElement

public MarkdownType getDescriptionElement()

Returns:

description (A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed. Intended to be used when the other structured properties of this resource are insufficient or cannot be supported. It is not intended to duplicate information already carried elswehere.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public AdministrableProductDefinition setDescriptionElement(MarkdownType value)

Parameters:

value - description (A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed. Intended to be used when the other structured properties of this resource are insufficient or cannot be supported. It is not intended to duplicate information already carried elswehere.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed. Intended to be used when the other structured properties of this resource are insufficient or cannot be supported. It is not intended to duplicate information already carried elswehere.

setDescription

public AdministrableProductDefinition setDescription(String value)

Parameters:

value - A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed. Intended to be used when the other structured properties of this resource are insufficient or cannot be supported. It is not intended to duplicate information already carried elswehere.

getProperty

public List<AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent> getProperty()

Returns:

property (Characteristics e.g. a product's onset of action.)

setProperty

public AdministrableProductDefinition setProperty(List<AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent> theProperty)

Returns:

Returns a reference to this for easy method chaining

hasProperty

public boolean hasProperty()

addProperty

public AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent addProperty()

addProperty

public AdministrableProductDefinition addProperty(AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent t)

getPropertyFirstRep

public AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent getPropertyFirstRep()

Returns:

The first repetition of repeating field property, creating it if it does not already exist {3}

getRouteOfAdministration

public List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent> getRouteOfAdministration()

Returns:

routeOfAdministration (The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa).)

setRouteOfAdministration

public AdministrableProductDefinition setRouteOfAdministration(List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent> theRouteOfAdministration)

Returns:

Returns a reference to this for easy method chaining

hasRouteOfAdministration

public boolean hasRouteOfAdministration()

addRouteOfAdministration

public AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent addRouteOfAdministration()

addRouteOfAdministration

public AdministrableProductDefinition addRouteOfAdministration(AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent t)

getRouteOfAdministrationFirstRep

public AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent getRouteOfAdministrationFirstRep()

Returns:

The first repetition of repeating field routeOfAdministration, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

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 Base 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 Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

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

Returns:

the FHIR type name of the instance (not the java class name)

copy

public AdministrableProductDefinition copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(AdministrableProductDefinition dst)

typedCopy

protected AdministrableProductDefinition 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