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 pharmaceutical product described in terms of its composition and dose form.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAdministrableProductDefinition.AdministrableProductDefinitionCharacteristicComponentstatic classAdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponentstatic classAdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesComponentstatic classAdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesWithdrawalPeriodComponent
-
Field Summary
Fields Modifier and Type Field Description protected CodeableConceptadministrableDoseFormThe administrable dose form, after necessary reconstitution.protected List<AdministrableProductDefinition.AdministrableProductDefinitionCharacteristicComponent>characteristicCharacteristics e.g.protected List<Reference>deviceAccompanying device.static ca.uhn.fhir.rest.gclient.TokenClientParamDOSE_FORMFluent Client search parameter constant for dose-formprotected List<Identifier>identifierAn identifier for the pharmaceutical medicinal product.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.protected List<Reference>ingredientThe ingredients of this administrable pharmaceutical product.protected List<Reference>producedFromThe manufactured item(s) that this administrable product is produced from.static ca.uhn.fhir.rest.gclient.TokenClientParamROUTEFluent Client search parameter constant for routeprotected List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent>routeOfAdministrationThe path by which the pharmaceutical product is taken into or makes contact with the body.static StringSP_DOSE_FORMSearch parameter: dose-formstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_ROUTESearch parameter: routestatic StringSP_SUBJECTSearch parameter: subjectstatic StringSP_TARGET_SPECIESSearch parameter: target-speciesprotected List<Reference>subjectThe product that this is a pharmaceutical product of.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectstatic ca.uhn.fhir.rest.gclient.TokenClientParamTARGET_SPECIESFluent Client search parameter constant for target-speciesprotected CodeableConceptunitOfPresentationTodo.-
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
-
-
Constructor Summary
Constructors Constructor Description AdministrableProductDefinition()ConstructorAdministrableProductDefinition(CodeableConcept administrableDoseForm, AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent routeOfAdministration)Constructor
-
Method Summary
-
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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
An identifier for the pharmaceutical medicinal product.
-
administrableDoseForm
protected CodeableConcept administrableDoseForm
The administrable dose form, after necessary reconstitution.
-
unitOfPresentation
protected CodeableConcept unitOfPresentation
Todo.
-
producedFrom
protected List<Reference> producedFrom
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.
-
ingredient
protected List<Reference> ingredient
The ingredients of this administrable pharmaceutical product.
-
characteristic
protected List<AdministrableProductDefinition.AdministrableProductDefinitionCharacteristicComponent> characteristic
Characteristics e.g. a products onset of action.
-
routeOfAdministration
protected List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent> routeOfAdministration
The path by which the pharmaceutical product is taken into or makes contact with the body.
-
SP_DOSE_FORM
public static final String SP_DOSE_FORM
Search parameter: dose-formDescription: The administrable dose form, after necessary reconstitution
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-formDescription: The administrable dose form, after necessary reconstitution
Type: token
Path: AdministrableProductDefinition.administrableDoseForm
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: An identifier for the pharmaceutical medicinal 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 identifierDescription: An identifier for the pharmaceutical medicinal product
Type: token
Path: AdministrableProductDefinition.identifier
-
SP_ROUTE
public static final String SP_ROUTE
Search parameter: routeDescription: 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 routeDescription: Coded expression for the route
Type: token
Path: AdministrableProductDefinition.routeOfAdministration.code
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: The product that this is a pharmaceutical product of
Type: reference
Path: AdministrableProductDefinition.subject
- See Also:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Fluent Client search parameter constant for subjectDescription: The product that this is a pharmaceutical product of
Type: reference
Path: AdministrableProductDefinition.subject
-
INCLUDE_SUBJECT
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "AdministrableProductDefinition:subject".
-
SP_TARGET_SPECIES
public static final String SP_TARGET_SPECIES
Search parameter: target-speciesDescription: 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-speciesDescription: Coded expression for the species
Type: token
Path: AdministrableProductDefinition.routeOfAdministration.targetSpecies.code
-
-
Constructor Detail
-
AdministrableProductDefinition
public AdministrableProductDefinition()
Constructor
-
AdministrableProductDefinition
public AdministrableProductDefinition(CodeableConcept administrableDoseForm, AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent routeOfAdministration)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(An identifier for the pharmaceutical medicinal product.)
-
setIdentifier
public AdministrableProductDefinition setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor 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}
-
getSubject
public List<Reference> getSubject()
- Returns:
subject(The product that this is a pharmaceutical product of.)
-
setSubject
public AdministrableProductDefinition setSubject(List<Reference> theSubject)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSubject
public boolean hasSubject()
-
addSubject
public Reference addSubject()
-
addSubject
public AdministrableProductDefinition addSubject(Reference t)
-
getSubjectFirstRep
public Reference getSubjectFirstRep()
- Returns:
- The first repetition of repeating field
subject, creating it if it does not already exist {3}
-
getAdministrableDoseForm
public CodeableConcept getAdministrableDoseForm()
- Returns:
administrableDoseForm(The administrable dose form, after necessary reconstitution.)
-
hasAdministrableDoseForm
public boolean hasAdministrableDoseForm()
-
setAdministrableDoseForm
public AdministrableProductDefinition setAdministrableDoseForm(CodeableConcept value)
- Parameters:
value-administrableDoseForm(The administrable dose form, after necessary reconstitution.)
-
getUnitOfPresentation
public CodeableConcept getUnitOfPresentation()
- Returns:
unitOfPresentation(Todo.)
-
hasUnitOfPresentation
public boolean hasUnitOfPresentation()
-
setUnitOfPresentation
public AdministrableProductDefinition setUnitOfPresentation(CodeableConcept value)
- Parameters:
value-unitOfPresentation(Todo.)
-
getProducedFrom
public List<Reference> getProducedFrom()
- Returns:
producedFrom(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.)
-
setProducedFrom
public AdministrableProductDefinition setProducedFrom(List<Reference> theProducedFrom)
- Returns:
- Returns a reference to
thisfor 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<Reference> getIngredient()
- Returns:
ingredient(The ingredients of this administrable pharmaceutical product.)
-
setIngredient
public AdministrableProductDefinition setIngredient(List<Reference> theIngredient)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIngredient
public boolean hasIngredient()
-
addIngredient
public Reference addIngredient()
-
addIngredient
public AdministrableProductDefinition addIngredient(Reference t)
-
getIngredientFirstRep
public Reference getIngredientFirstRep()
- Returns:
- The first repetition of repeating field
ingredient, creating it if it does not already exist {3}
-
setDevice
public AdministrableProductDefinition setDevice(List<Reference> theDevice)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDevice
public boolean hasDevice()
-
addDevice
public AdministrableProductDefinition addDevice(Reference t)
-
getDeviceFirstRep
public Reference getDeviceFirstRep()
- Returns:
- The first repetition of repeating field
device, creating it if it does not already exist {3}
-
getCharacteristic
public List<AdministrableProductDefinition.AdministrableProductDefinitionCharacteristicComponent> getCharacteristic()
- Returns:
characteristic(Characteristics e.g. a products onset of action.)
-
setCharacteristic
public AdministrableProductDefinition setCharacteristic(List<AdministrableProductDefinition.AdministrableProductDefinitionCharacteristicComponent> theCharacteristic)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCharacteristic
public boolean hasCharacteristic()
-
addCharacteristic
public AdministrableProductDefinition.AdministrableProductDefinitionCharacteristicComponent addCharacteristic()
-
addCharacteristic
public AdministrableProductDefinition addCharacteristic(AdministrableProductDefinition.AdministrableProductDefinitionCharacteristicComponent t)
-
getCharacteristicFirstRep
public AdministrableProductDefinition.AdministrableProductDefinitionCharacteristicComponent getCharacteristicFirstRep()
- Returns:
- The first repetition of repeating field
characteristic, creating it if it does not already exist {3}
-
getRouteOfAdministration
public List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent> getRouteOfAdministration()
- Returns:
routeOfAdministration(The path by which the pharmaceutical product is taken into or makes contact with the body.)
-
setRouteOfAdministration
public AdministrableProductDefinition setRouteOfAdministration(List<AdministrableProductDefinition.AdministrableProductDefinitionRouteOfAdministrationComponent> theRouteOfAdministration)
- Returns:
- Returns a reference to
thisfor 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:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public AdministrableProductDefinition copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(AdministrableProductDefinition dst)
-
typedCopy
protected AdministrableProductDefinition typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-