Package org.hl7.fhir.r4.model

Class MedicinalProductPharmaceutical

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.MedicinalProductPharmaceutical

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 MedicinalProductPharmaceutical
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 class	MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent
static class	MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent
static class	MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesComponent
static class	MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesWithdrawalPeriodComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	administrableDoseForm	The administrable dose form, after necessary reconstitution.
protected List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent>	characteristics	Characteristics e.g.
protected List<Reference>	device	Accompanying device.
protected List<DeviceDefinition>	deviceTarget	The actual objects that are the target of the reference (Accompanying device.)
protected List<Identifier>	identifier	An identifier for the pharmaceutical medicinal product.
static ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
protected List<Reference>	ingredient	Ingredient.
protected List<MedicinalProductIngredient>	ingredientTarget	The actual objects that are the target of the reference (Ingredient.)
static ca.uhn.fhir.rest.gclient.TokenClientParam	ROUTE	Fluent Client search parameter constant for route
protected List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent>	routeOfAdministration	The path by which the pharmaceutical product is taken into or makes contact with the body.
static String	SP_IDENTIFIER	Search parameter: identifier
static String	SP_ROUTE	Search parameter: route
static String	SP_TARGET_SPECIES	Search parameter: target-species
static ca.uhn.fhir.rest.gclient.TokenClientParam	TARGET_SPECIES	Fluent Client search parameter constant for target-species
protected CodeableConcept	unitOfPresentation	Todo.

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

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.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
MedicinalProductPharmaceutical()	Constructor
MedicinalProductPharmaceutical(CodeableConcept administrableDoseForm)	Constructor

Method Summary

Modifier and Type	Method	Description
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent	addCharacteristics()
MedicinalProductPharmaceutical	addCharacteristics(MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent t)
Base	addChild(String name)
Reference	addDevice()
MedicinalProductPharmaceutical	addDevice(Reference t)
DeviceDefinition	addDeviceTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Identifier	addIdentifier()
MedicinalProductPharmaceutical	addIdentifier(Identifier t)
Reference	addIngredient()
MedicinalProductPharmaceutical	addIngredient(Reference t)
MedicinalProductIngredient	addIngredientTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent	addRouteOfAdministration()
MedicinalProductPharmaceutical	addRouteOfAdministration(MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent t)
MedicinalProductPharmaceutical	copy()
void	copyValues(MedicinalProductPharmaceutical dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableConcept	getAdministrableDoseForm()
List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent>	getCharacteristics()
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent	getCharacteristicsFirstRep()
List<Reference>	getDevice()
Reference	getDeviceFirstRep()
List<DeviceDefinition>	getDeviceTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Reference>	getIngredient()
Reference	getIngredientFirstRep()
List<MedicinalProductIngredient>	getIngredientTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent>	getRouteOfAdministration()
MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent	getRouteOfAdministrationFirstRep()
String[]	getTypesForProperty(int hash, String name)
CodeableConcept	getUnitOfPresentation()
boolean	hasAdministrableDoseForm()
boolean	hasCharacteristics()
boolean	hasDevice()
boolean	hasIdentifier()
boolean	hasIngredient()
boolean	hasRouteOfAdministration()
boolean	hasUnitOfPresentation()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
MedicinalProductPharmaceutical	setAdministrableDoseForm(CodeableConcept value)
MedicinalProductPharmaceutical	setCharacteristics(List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent> theCharacteristics)
MedicinalProductPharmaceutical	setDevice(List<Reference> theDevice)
MedicinalProductPharmaceutical	setIdentifier(List<Identifier> theIdentifier)
MedicinalProductPharmaceutical	setIngredient(List<Reference> theIngredient)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
MedicinalProductPharmaceutical	setRouteOfAdministration(List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent> theRouteOfAdministration)
MedicinalProductPharmaceutical	setUnitOfPresentation(CodeableConcept value)
protected MedicinalProductPharmaceutical	typedCopy()

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

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

Methods inherited from class org.hl7.fhir.r4.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.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, 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

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 pharmaceutical medicinal product.

administrableDoseForm

protected CodeableConcept administrableDoseForm

The administrable dose form, after necessary reconstitution.

unitOfPresentation

protected CodeableConcept unitOfPresentation

Todo.

ingredient

protected List<Reference> ingredient

Ingredient.

ingredientTarget

protected List<MedicinalProductIngredient> ingredientTarget

The actual objects that are the target of the reference (Ingredient.)

device

protected List<Reference> device

Accompanying device.

deviceTarget

protected List<DeviceDefinition> deviceTarget

The actual objects that are the target of the reference (Accompanying device.)

characteristics

protected List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent> characteristics

Characteristics e.g. a products onset of action.

routeOfAdministration

protected List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent> routeOfAdministration

The path by which the pharmaceutical product is taken into or makes contact with the body.

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: An identifier for the pharmaceutical medicinal product
Type: token
Path: MedicinalProductPharmaceutical.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 pharmaceutical medicinal product
Type: token
Path: MedicinalProductPharmaceutical.identifier

SP_ROUTE

public static final String SP_ROUTE

Search parameter: route

Description: Coded expression for the route
Type: token
Path: MedicinalProductPharmaceutical.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: MedicinalProductPharmaceutical.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: MedicinalProductPharmaceutical.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: MedicinalProductPharmaceutical.routeOfAdministration.targetSpecies.code

Constructor Detail

MedicinalProductPharmaceutical

public MedicinalProductPharmaceutical()

Constructor

MedicinalProductPharmaceutical

public MedicinalProductPharmaceutical(CodeableConcept administrableDoseForm)

Constructor

Method Detail

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (An identifier for the pharmaceutical medicinal product.)

setIdentifier

public MedicinalProductPharmaceutical setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public MedicinalProductPharmaceutical addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

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

getAdministrableDoseForm

public CodeableConcept getAdministrableDoseForm()

Returns:

administrableDoseForm (The administrable dose form, after necessary reconstitution.)

hasAdministrableDoseForm

public boolean hasAdministrableDoseForm()

setAdministrableDoseForm

public MedicinalProductPharmaceutical 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 MedicinalProductPharmaceutical setUnitOfPresentation(CodeableConcept value)

Parameters:

value - unitOfPresentation (Todo.)

getIngredient

public List<Reference> getIngredient()

Returns:

ingredient (Ingredient.)

setIngredient

public MedicinalProductPharmaceutical setIngredient(List<Reference> theIngredient)

Returns:

Returns a reference to this for easy method chaining

hasIngredient

public boolean hasIngredient()

addIngredient

public Reference addIngredient()

addIngredient

public MedicinalProductPharmaceutical addIngredient(Reference t)

getIngredientFirstRep

public Reference getIngredientFirstRep()

Returns:

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

getIngredientTarget

@Deprecated
public List<MedicinalProductIngredient> getIngredientTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addIngredientTarget

@Deprecated
public MedicinalProductIngredient addIngredientTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getDevice

public List<Reference> getDevice()

Returns:

device (Accompanying device.)

setDevice

public MedicinalProductPharmaceutical setDevice(List<Reference> theDevice)

Returns:

Returns a reference to this for easy method chaining

hasDevice

public boolean hasDevice()

addDevice

public Reference addDevice()

addDevice

public MedicinalProductPharmaceutical addDevice(Reference t)

getDeviceFirstRep

public Reference getDeviceFirstRep()

Returns:

The first repetition of repeating field device, creating it if it does not already exist

getDeviceTarget

@Deprecated
public List<DeviceDefinition> getDeviceTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addDeviceTarget

@Deprecated
public DeviceDefinition addDeviceTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getCharacteristics

public List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent> getCharacteristics()

Returns:

characteristics (Characteristics e.g. a products onset of action.)

setCharacteristics

public MedicinalProductPharmaceutical setCharacteristics(List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent> theCharacteristics)

Returns:

Returns a reference to this for easy method chaining

hasCharacteristics

public boolean hasCharacteristics()

addCharacteristics

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent addCharacteristics()

addCharacteristics

public MedicinalProductPharmaceutical addCharacteristics(MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent t)

getCharacteristicsFirstRep

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalCharacteristicsComponent getCharacteristicsFirstRep()

Returns:

The first repetition of repeating field characteristics, creating it if it does not already exist

getRouteOfAdministration

public List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent> getRouteOfAdministration()

Returns:

routeOfAdministration (The path by which the pharmaceutical product is taken into or makes contact with the body.)

setRouteOfAdministration

public MedicinalProductPharmaceutical setRouteOfAdministration(List<MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent> theRouteOfAdministration)

Returns:

Returns a reference to this for easy method chaining

hasRouteOfAdministration

public boolean hasRouteOfAdministration()

addRouteOfAdministration

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent addRouteOfAdministration()

addRouteOfAdministration

public MedicinalProductPharmaceutical addRouteOfAdministration(MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent t)

getRouteOfAdministrationFirstRep

public MedicinalProductPharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationComponent getRouteOfAdministrationFirstRep()

Returns:

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

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 MedicinalProductPharmaceutical copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(MedicinalProductPharmaceutical dst)

typedCopy

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