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`

Field Summary

Fields
Modifier and Type	Field	Description
`protected CodeableConcept`	`administrableDoseForm`	The dose form of the final product after necessary reconstitution or processing.
`protected Reference`	`device`	A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`DEVICE`	Fluent Client search parameter constant for device
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`DOSE_FORM`	Fluent Client search parameter constant for dose-form
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`FORM_OF`	Fluent Client search parameter constant for form-of
`protected List<Reference>`	`formOf`	The medicinal product that this is a prepared administrable form of.
`protected List<Identifier>`	`identifier`	An identifier for the administrable product.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER`	Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_DEVICE`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_FORM_OF`	Constant for fluent queries to be used to add include statements.
`static 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 ca.uhn.fhir.rest.gclient.TokenClientParam`	`INGREDIENT`	Fluent Client search parameter constant for ingredient
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`MANUFACTURED_ITEM`	Fluent Client search parameter constant for manufactured-item
`protected List<Reference>`	`producedFrom`	The constituent manufactured item(s) that this administrable product is produced from.
`protected List<AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent>`	`property`	Characteristics e.g.
`static 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 String`	`SP_DEVICE`	Search parameter: device
`static String`	`SP_DOSE_FORM`	Search parameter: dose-form
`static String`	`SP_FORM_OF`	Search parameter: form-of
`static String`	`SP_IDENTIFIER`	Search parameter: identifier
`static String`	`SP_INGREDIENT`	Search parameter: ingredient
`static String`	`SP_MANUFACTURED_ITEM`	Search parameter: manufactured-item
`static String`	`SP_ROUTE`	Search parameter: route
`static String`	`SP_TARGET_SPECIES`	Search parameter: target-species
`protected Enumeration<Enumerations.PublicationStatus>`	`status`	The status of this administrable product.
`static 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.

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, 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
`AdministrableProductDefinition()`	Constructor
`AdministrableProductDefinition(Enumerations.PublicationStatus status, AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent routeOfAdministration)`	Constructor

Method Summary

All Methods Instance Methods Concrete Methods
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()`
`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`	`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)`
`AdministrableProductDefinition`	`setAdministrableDoseForm(CodeableConcept 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, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
  - 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
```
    The medicinal product that this is a prepared administrable form of. This element is not a reference to the item(s) that make up this administrable form (for which see AdministrableProductDefinition.producedFrom). It is medicinal product as a whole, which may have several components (as well as packaging, devices etc.), that are given to the patient in this final administrable form. A single medicinal product may have several different administrable products (e.g. a tablet and a cream), and these could have different administrable forms (e.g. tablet as oral solid, or tablet crushed).
  - 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
```
    The constituent 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 solvent item, to make a consumable solution). Note the items this is produced from are not raw ingredients (see AdministrableProductDefinition.ingredient), but manufactured medication items (ManufacturedItemDefinitions), which may be combined or prepared and transformed for patient use. The constituent items that this administrable form is produced from are all part of the product (for which see AdministrableProductDefinition.formOf).
  - 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.
  - property
```
protected List<AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent> property
```
    Characteristics e.g. a products 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.
  - 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_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 Detail
  - AdministrableProductDefinition
```
public AdministrableProductDefinition()
```
    Constructor
  - AdministrableProductDefinition
```
public AdministrableProductDefinition(Enumerations.PublicationStatus status,
                                      AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent routeOfAdministration)
```
    Constructor
- Method Detail
  - 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 (The medicinal product that this is a prepared administrable form of. This element is not a reference to the item(s) that make up this administrable form (for which see AdministrableProductDefinition.producedFrom). It is medicinal product as a whole, which may have several components (as well as packaging, devices etc.), that are given to the patient in this final administrable form. A single medicinal product may have several different administrable products (e.g. a tablet and a cream), and these could have different administrable forms (e.g. tablet as oral solid, or tablet crushed).)
  - 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 (The constituent 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 solvent item, to make a consumable solution). Note the items this is produced from are not raw ingredients (see AdministrableProductDefinition.ingredient), but manufactured medication items (ManufacturedItemDefinitions), which may be combined or prepared and transformed for patient use. The constituent items that this administrable form is produced from are all part of the product (for which see AdministrableProductDefinition.formOf).)
  - 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.)
  - getProperty
```
public List<AdministrableProductDefinition.AdministrableProductDefinitionPropertyComponent> getProperty()
```
    Returns:
    
    property (Characteristics e.g. a products 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.)
  - 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
  - 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
  - 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

Class AdministrableProductDefinition

Nested Class Summary

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

identifier

status

formOf

administrableDoseForm

unitOfPresentation

producedFrom

ingredient

device

property

routeOfAdministration

SP_DEVICE

DEVICE

INCLUDE_DEVICE

SP_DOSE_FORM

DOSE_FORM

SP_FORM_OF

FORM_OF

INCLUDE_FORM_OF

SP_IDENTIFIER

IDENTIFIER

SP_INGREDIENT

INGREDIENT

SP_MANUFACTURED_ITEM

MANUFACTURED_ITEM

INCLUDE_MANUFACTURED_ITEM

SP_ROUTE

ROUTE

SP_TARGET_SPECIES

TARGET_SPECIES

Constructor Detail

AdministrableProductDefinition

AdministrableProductDefinition

Method Detail

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getFormOf

setFormOf

hasFormOf

addFormOf

addFormOf

getFormOfFirstRep

getAdministrableDoseForm

hasAdministrableDoseForm

setAdministrableDoseForm

getUnitOfPresentation

hasUnitOfPresentation

setUnitOfPresentation

getProducedFrom

setProducedFrom

hasProducedFrom

addProducedFrom

addProducedFrom