Class AdministrableProductDefinition
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.AdministrableProductDefinition
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") 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).Maturity level: FMM1 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AdministrableProductDefinition.Builder
static class
AdministrableProductDefinition.Property
Characteristics e.g.static class
AdministrableProductDefinition.RouteOfAdministration
The path by which the product is taken into or makes contact with the body.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static AdministrableProductDefinition.Builder
builder()
boolean
equals(java.lang.Object obj)
CodeableConcept
getAdministrableDoseForm()
The dose form of the final product after necessary reconstitution or processing.Reference
getDevice()
A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product.java.util.List<Reference>
getFormOf()
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.java.util.List<Identifier>
getIdentifier()
An identifier for the administrable product.java.util.List<CodeableConcept>
getIngredient()
The ingredients of this administrable medicinal product.java.util.List<Reference>
getProducedFrom()
Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form.java.util.List<AdministrableProductDefinition.Property>
getProperty()
Characteristics e.g.java.util.List<AdministrableProductDefinition.RouteOfAdministration>
getRouteOfAdministration()
The path by which the product is taken into or makes contact with the body.PublicationStatus
getStatus()
The status of this administrable product.CodeableConcept
getUnitOfPresentation()
The presentation type in which this item is given to a patient.boolean
hasChildren()
int
hashCode()
AdministrableProductDefinition.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
An identifier for the administrable product.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getStatus
public PublicationStatus getStatus()
The status of this administrable product. Enables tracking the life-cycle of the content.- Returns:
- An immutable object of type
PublicationStatus
that is non-null.
-
getFormOf
public java.util.List<Reference> getFormOf()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getAdministrableDoseForm
public CodeableConcept getAdministrableDoseForm()
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').- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getUnitOfPresentation
public CodeableConcept getUnitOfPresentation()
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').- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getProducedFrom
public java.util.List<Reference> getProducedFrom()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getIngredient
public java.util.List<CodeableConcept> getIngredient()
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.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getDevice
public Reference getDevice()
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.- Returns:
- An immutable object of type
Reference
that may be null.
-
getProperty
public java.util.List<AdministrableProductDefinition.Property> getProperty()
Characteristics e.g. a product's onset of action.- Returns:
- An unmodifiable list containing immutable objects of type
AdministrableProductDefinition.Property
that may be empty.
-
getRouteOfAdministration
public java.util.List<AdministrableProductDefinition.RouteOfAdministration> getRouteOfAdministration()
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).- Returns:
- An unmodifiable list containing immutable objects of type
AdministrableProductDefinition.RouteOfAdministration
that is non-empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public AdministrableProductDefinition.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static AdministrableProductDefinition.Builder builder()
-
-