Class MedicinalProductDefinition
- 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
static class
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
Modifier and TypeFieldDescriptionprotected CodeableConcept
Whether the Medicinal Product is subject to additional monitoring for regulatory reasons, such as heightened reporting requirements.Additional information or supporting documentation about the medicinal product.Allows the key product features to be recorded, such as "sugar free", "modified release", "parallel import".static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for characteristicstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for characteristic-typeprotected List
<CodeableConcept> Allows the product to be classified by various systems, commonly WHO ATC.Clinical trials or studies that this product is involved in.A code that this product is known by, usually within some formal terminology, perhaps assigned by a third party (i.e.protected CodeableConcept
The dose form for a single part product, or combined form of a multiple part product.Types of medicinal manufactured items and/or devices that this product consists of, such as tablets, capsule, or syringes.A product specific contact, person (in a role), or an organization.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for contactReference to another product, e.g.protected MarkdownType
General description of this product.protected CodeableConcept
If this medicine applies to human or veterinary uses.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for domainprotected List
<Identifier> Business identifier for this product.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierprotected List
<CodeableReference> Any component of the drug product which is not the chemical entity defined as the drug substance, or an excipient in the drug product.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected MarkdownType
Description of indication(s) for this product, used when structured indications are not required.protected List
<CodeableConcept> The ingredients of this medicinal product - when not detailed in other resources.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for ingredientprotected CodeableConcept
The legal status of supply of the medicinal product as classified by the regulator.protected List
<MarketingStatus> Marketing status of the medicinal product, in contrast to marketing authorization.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for master-fileA master file for the medicinal product (e.g.The product's name, including full name and possibly coded parts.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for namestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for name-languageA manufacturing or administrative process or step associated with (or performed on) the medicinal product.protected List
<CodeableConcept> Package type for the product.protected CodeableConcept
If authorised for use in children, or infants, neonates etc.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for product-classificationprotected List
<CodeableConcept> The path by which the product is taken into or makes contact with the body.static final String
Search parameter: characteristicstatic final String
Search parameter: characteristic-typestatic final String
Search parameter: contactstatic final String
Search parameter: domainstatic final String
Search parameter: identifierstatic final String
Search parameter: ingredientstatic final String
Search parameter: master-filestatic final String
Search parameter: namestatic final String
Search parameter: name-languagestatic final String
Search parameter: product-classificationstatic final String
Search parameter: statusstatic final String
Search parameter: typeprotected List
<CodeableConcept> Whether the Medicinal Product is subject to special measures for regulatory reasons, such as a requirement to conduct post-authorization studies.protected CodeableConcept
The status within the lifecycle of this product record.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected DateTimeType
The date at which the given status became applicable.protected CodeableConcept
Regulatory type, e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for typeprotected StringType
A business identifier relating to a specific version of the product, this is commonly used to support revisions to an existing product.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
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionaddCode()
addName()
addRoute()
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getRoute()
getType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
boolean
hasRoute()
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAttachedDocument
(List<Reference> theAttachedDocument) setCharacteristic
(List<MedicinalProductDefinition.MedicinalProductDefinitionCharacteristicComponent> theCharacteristic) setClassification
(List<CodeableConcept> theClassification) setClinicalTrial
(List<Reference> theClinicalTrial) setComprisedOf
(List<Reference> theComprisedOf) setCrossReference
(List<MedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponent> theCrossReference) setDescription
(String value) setDomain
(CodeableConcept value) setIdentifier
(List<Identifier> theIdentifier) setImpurity
(List<CodeableReference> theImpurity) setIndication
(String value) setIndicationElement
(MarkdownType value) setIngredient
(List<CodeableConcept> theIngredient) setMarketingStatus
(List<MarketingStatus> theMarketingStatus) setMasterFile
(List<Reference> theMasterFile) setOperation
(List<MedicinalProductDefinition.MedicinalProductDefinitionOperationComponent> theOperation) setPackagedMedicinalProduct
(List<CodeableConcept> thePackagedMedicinalProduct) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setRoute
(List<CodeableConcept> theRoute) setSpecialMeasures
(List<CodeableConcept> theSpecialMeasures) setStatus
(CodeableConcept value) setStatusDate
(Date value) setStatusDateElement
(DateTimeType value) setType
(CodeableConcept value) setVersion
(String value) setVersionElement
(StringType value) protected MedicinalProductDefinition
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, 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, 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
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
Business identifier for this product. Could be an MPID. When in development or being regulated, products are typically referenced by official identifiers, assigned by a manufacturer or regulator, and unique to a product (which, when compared to a product instance being prescribed, is actually a product type). See also MedicinalProductDefinition.code. -
type
Regulatory type, e.g. Investigational or Authorized. -
domain
If this medicine applies to human or veterinary uses. -
version
A business identifier relating to a specific version of the product, this is commonly used to support revisions to an existing product. -
status
The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status. -
statusDate
The date at which the given status became applicable. -
description
General description of this product. -
combinedPharmaceuticalDoseForm
The dose form for a single part product, or combined form of a multiple part product. This is one concept that describes all the components. It does not represent the form with components physically mixed, if that might be necessary, for which see (AdministrableProductDefinition.administrableDoseForm). -
route
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. See also AdministrableProductDefinition resource. MedicinalProductDefinition.route is the same concept as AdministrableProductDefinition.routeOfAdministration.code, and they cannot be used together. -
indication
Description of indication(s) for this product, used when structured indications are not required. In cases where structured indications are required, they are captured using the ClinicalUseDefinition resource. An indication is a medical situation for which using the product is appropriate. -
legalStatusOfSupply
The legal status of supply of the medicinal product as classified by the regulator. -
additionalMonitoringIndicator
Whether the Medicinal Product is subject to additional monitoring for regulatory reasons, such as heightened reporting requirements. -
specialMeasures
Whether the Medicinal Product is subject to special measures for regulatory reasons, such as a requirement to conduct post-authorization studies. -
pediatricUseIndicator
If authorised for use in children, or infants, neonates etc. -
classification
Allows the product to be classified by various systems, commonly WHO ATC. -
marketingStatus
Marketing status of the medicinal product, in contrast to marketing authorization. This refers to the product being actually 'on the market' as opposed to being allowed to be on the market (which is an authorization). -
packagedMedicinalProduct
Package type for the product. See also the PackagedProductDefinition resource. -
comprisedOf
Types of medicinal manufactured items and/or devices that this product consists of, such as tablets, capsule, or syringes. Used as a direct link when the item's packaging is not being recorded (see also PackagedProductDefinition.package.containedItem.item). -
ingredient
The ingredients of this medicinal product - when not detailed in other resources. This is only needed if the ingredients are not specified by incoming references from the Ingredient resource, or indirectly via incoming AdministrableProductDefinition, PackagedProductDefinition or ManufacturedItemDefinition references. In cases where those levels of detail are not used, the ingredients may be specified directly here as codes. -
impurity
Any component of the drug product which is not the chemical entity defined as the drug substance, or an excipient in the drug product. This includes process-related impurities and contaminants, product-related impurities including degradation products. -
attachedDocument
Additional information or supporting documentation about the medicinal product. -
masterFile
A master file for the medicinal product (e.g. Pharmacovigilance System Master File). Drug master files (DMFs) are documents submitted to regulatory agencies to provide confidential detailed information about facilities, processes or articles used in the manufacturing, processing, packaging and storing of drug products. -
contact
A product specific contact, person (in a role), or an organization. -
clinicalTrial
Clinical trials or studies that this product is involved in. -
code
A code that this product is known by, usually within some formal terminology, perhaps assigned by a third party (i.e. not the manufacturer or regulator). Products (types of medications) tend to be known by identifiers during development and within regulatory process. However when they are prescribed they tend to be identified by codes. The same product may be have multiple codes, applied to it by multiple organizations. -
name
The product's name, including full name and possibly coded parts. -
crossReference
protected List<MedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponent> crossReferenceReference to another product, e.g. for linking authorised to investigational product, or a virtual product. -
operation
A manufacturing or administrative process or step associated with (or performed on) the medicinal product. -
characteristic
protected List<MedicinalProductDefinition.MedicinalProductDefinitionCharacteristicComponent> characteristicAllows the key product features to be recorded, such as "sugar free", "modified release", "parallel import". -
SP_CHARACTERISTIC_TYPE
Search parameter: characteristic-typeDescription: A category for the characteristic
Type: token
Path: MedicinalProductDefinition.characteristic.type
- See Also:
-
CHARACTERISTIC_TYPE
Fluent Client search parameter constant for characteristic-typeDescription: A category for the characteristic
Type: token
Path: MedicinalProductDefinition.characteristic.type
-
SP_CHARACTERISTIC
Search parameter: characteristicDescription: Allows the key product features to be recorded, such as "sugar free", "modified release", "parallel import"
Type: token
Path: MedicinalProductDefinition.characteristic.value.ofType(Quantity) | MedicinalProductDefinition.characteristic.value.ofType(CodeableConcept)
- See Also:
-
CHARACTERISTIC
Fluent Client search parameter constant for characteristicDescription: Allows the key product features to be recorded, such as "sugar free", "modified release", "parallel import"
Type: token
Path: MedicinalProductDefinition.characteristic.value.ofType(Quantity) | MedicinalProductDefinition.characteristic.value.ofType(CodeableConcept)
-
SP_CONTACT
Search parameter: contactDescription: A product specific contact, person (in a role), or an organization
Type: reference
Path: MedicinalProductDefinition.contact.contact
- See Also:
-
CONTACT
Fluent Client search parameter constant for contactDescription: A product specific contact, person (in a role), or an organization
Type: reference
Path: MedicinalProductDefinition.contact.contact
-
INCLUDE_CONTACT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicinalProductDefinition:contact". -
SP_DOMAIN
Search parameter: domainDescription: If this medicine applies to human or veterinary uses
Type: token
Path: MedicinalProductDefinition.domain
- See Also:
-
DOMAIN
Fluent Client search parameter constant for domainDescription: If this medicine applies to human or veterinary uses
Type: token
Path: MedicinalProductDefinition.domain
-
SP_IDENTIFIER
Search parameter: identifierDescription: Business identifier for this product. Could be an MPID
Type: token
Path: MedicinalProductDefinition.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Business identifier for this product. Could be an MPID
Type: token
Path: MedicinalProductDefinition.identifier
-
SP_INGREDIENT
Search parameter: ingredientDescription: An ingredient of this product
Type: token
Path: MedicinalProductDefinition.ingredient
- See Also:
-
INGREDIENT
Fluent Client search parameter constant for ingredientDescription: An ingredient of this product
Type: token
Path: MedicinalProductDefinition.ingredient
-
SP_MASTER_FILE
Search parameter: master-fileDescription: A master file for to the medicinal product (e.g. Pharmacovigilance System Master File)
Type: reference
Path: MedicinalProductDefinition.masterFile
- See Also:
-
MASTER_FILE
Fluent Client search parameter constant for master-fileDescription: A master file for to the medicinal product (e.g. Pharmacovigilance System Master File)
Type: reference
Path: MedicinalProductDefinition.masterFile
-
INCLUDE_MASTER_FILE
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicinalProductDefinition:master-file". -
SP_NAME_LANGUAGE
Search parameter: name-languageDescription: Language code for this name
Type: token
Path: MedicinalProductDefinition.name.usage.language
- See Also:
-
NAME_LANGUAGE
Fluent Client search parameter constant for name-languageDescription: Language code for this name
Type: token
Path: MedicinalProductDefinition.name.usage.language
-
SP_NAME
Search parameter: nameDescription: The full product name
Type: string
Path: MedicinalProductDefinition.name.productName
- See Also:
-
NAME
Fluent Client search parameter constant for nameDescription: The full product name
Type: string
Path: MedicinalProductDefinition.name.productName
-
SP_PRODUCT_CLASSIFICATION
Search parameter: product-classificationDescription: Allows the product to be classified by various systems
Type: token
Path: MedicinalProductDefinition.classification
- See Also:
-
PRODUCT_CLASSIFICATION
Fluent Client search parameter constant for product-classificationDescription: Allows the product to be classified by various systems
Type: token
Path: MedicinalProductDefinition.classification
-
SP_STATUS
Search parameter: statusDescription: The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status
Type: token
Path: MedicinalProductDefinition.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status
Type: token
Path: MedicinalProductDefinition.status
-
SP_TYPE
Search parameter: typeDescription: Regulatory type, e.g. Investigational or Authorized
Type: token
Path: MedicinalProductDefinition.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: Regulatory type, e.g. Investigational or Authorized
Type: token
Path: MedicinalProductDefinition.type
-
-
Constructor Details
-
MedicinalProductDefinition
public MedicinalProductDefinition()Constructor -
MedicinalProductDefinition
public MedicinalProductDefinition(MedicinalProductDefinition.MedicinalProductDefinitionNameComponent name) Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Business identifier for this product. Could be an MPID. When in development or being regulated, products are typically referenced by official identifiers, assigned by a manufacturer or regulator, and unique to a product (which, when compared to a product instance being prescribed, is actually a product type). See also MedicinalProductDefinition.code.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist {3}
-
getType
- Returns:
type
(Regulatory type, e.g. Investigational or Authorized.)
-
hasType
-
setType
- Parameters:
value
-type
(Regulatory type, e.g. Investigational or Authorized.)
-
getDomain
- Returns:
domain
(If this medicine applies to human or veterinary uses.)
-
hasDomain
-
setDomain
- Parameters:
value
-domain
(If this medicine applies to human or veterinary uses.)
-
getVersionElement
- Returns:
version
(A business identifier relating to a specific version of the product, this is commonly used to support revisions to an existing product.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
-
hasVersion
-
setVersionElement
- Parameters:
value
-version
(A business identifier relating to a specific version of the product, this is commonly used to support revisions to an existing product.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
- Returns:
- A business identifier relating to a specific version of the product, this is commonly used to support revisions to an existing product.
-
setVersion
- Parameters:
value
- A business identifier relating to a specific version of the product, this is commonly used to support revisions to an existing product.
-
getStatus
- Returns:
status
(The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status.)
-
hasStatus
-
setStatus
- Parameters:
value
-status
(The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status.)
-
getStatusDateElement
- Returns:
statusDate
(The date at which the given status became applicable.). This is the underlying object with id, value and extensions. The accessor "getStatusDate" gives direct access to the value
-
hasStatusDateElement
-
hasStatusDate
-
setStatusDateElement
- Parameters:
value
-statusDate
(The date at which the given status became applicable.). This is the underlying object with id, value and extensions. The accessor "getStatusDate" gives direct access to the value
-
getStatusDate
- Returns:
- The date at which the given status became applicable.
-
setStatusDate
- Parameters:
value
- The date at which the given status became applicable.
-
getDescriptionElement
- Returns:
description
(General description of this product.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
-
hasDescription
-
setDescriptionElement
- Parameters:
value
-description
(General description of this product.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
- Returns:
- General description of this product.
-
setDescription
- Parameters:
value
- General description of this product.
-
getCombinedPharmaceuticalDoseForm
- Returns:
combinedPharmaceuticalDoseForm
(The dose form for a single part product, or combined form of a multiple part product. This is one concept that describes all the components. It does not represent the form with components physically mixed, if that might be necessary, for which see (AdministrableProductDefinition.administrableDoseForm).)
-
hasCombinedPharmaceuticalDoseForm
-
setCombinedPharmaceuticalDoseForm
- Parameters:
value
-combinedPharmaceuticalDoseForm
(The dose form for a single part product, or combined form of a multiple part product. This is one concept that describes all the components. It does not represent the form with components physically mixed, if that might be necessary, for which see (AdministrableProductDefinition.administrableDoseForm).)
-
getRoute
- Returns:
route
(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. See also AdministrableProductDefinition resource. MedicinalProductDefinition.route is the same concept as AdministrableProductDefinition.routeOfAdministration.code, and they cannot be used together.)
-
setRoute
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRoute
-
addRoute
-
addRoute
-
getRouteFirstRep
- Returns:
- The first repetition of repeating field
route
, creating it if it does not already exist {3}
-
getIndicationElement
- Returns:
indication
(Description of indication(s) for this product, used when structured indications are not required. In cases where structured indications are required, they are captured using the ClinicalUseDefinition resource. An indication is a medical situation for which using the product is appropriate.). This is the underlying object with id, value and extensions. The accessor "getIndication" gives direct access to the value
-
hasIndicationElement
-
hasIndication
-
setIndicationElement
- Parameters:
value
-indication
(Description of indication(s) for this product, used when structured indications are not required. In cases where structured indications are required, they are captured using the ClinicalUseDefinition resource. An indication is a medical situation for which using the product is appropriate.). This is the underlying object with id, value and extensions. The accessor "getIndication" gives direct access to the value
-
getIndication
- Returns:
- Description of indication(s) for this product, used when structured indications are not required. In cases where structured indications are required, they are captured using the ClinicalUseDefinition resource. An indication is a medical situation for which using the product is appropriate.
-
setIndication
- Parameters:
value
- Description of indication(s) for this product, used when structured indications are not required. In cases where structured indications are required, they are captured using the ClinicalUseDefinition resource. An indication is a medical situation for which using the product is appropriate.
-
getLegalStatusOfSupply
- Returns:
legalStatusOfSupply
(The legal status of supply of the medicinal product as classified by the regulator.)
-
hasLegalStatusOfSupply
-
setLegalStatusOfSupply
- Parameters:
value
-legalStatusOfSupply
(The legal status of supply of the medicinal product as classified by the regulator.)
-
getAdditionalMonitoringIndicator
- Returns:
additionalMonitoringIndicator
(Whether the Medicinal Product is subject to additional monitoring for regulatory reasons, such as heightened reporting requirements.)
-
hasAdditionalMonitoringIndicator
-
setAdditionalMonitoringIndicator
- Parameters:
value
-additionalMonitoringIndicator
(Whether the Medicinal Product is subject to additional monitoring for regulatory reasons, such as heightened reporting requirements.)
-
getSpecialMeasures
- Returns:
specialMeasures
(Whether the Medicinal Product is subject to special measures for regulatory reasons, such as a requirement to conduct post-authorization studies.)
-
setSpecialMeasures
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSpecialMeasures
-
addSpecialMeasures
-
addSpecialMeasures
-
getSpecialMeasuresFirstRep
- Returns:
- The first repetition of repeating field
specialMeasures
, creating it if it does not already exist {3}
-
getPediatricUseIndicator
- Returns:
pediatricUseIndicator
(If authorised for use in children, or infants, neonates etc.)
-
hasPediatricUseIndicator
-
setPediatricUseIndicator
- Parameters:
value
-pediatricUseIndicator
(If authorised for use in children, or infants, neonates etc.)
-
getClassification
- Returns:
classification
(Allows the product to be classified by various systems, commonly WHO ATC.)
-
setClassification
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasClassification
-
addClassification
-
addClassification
-
getClassificationFirstRep
- Returns:
- The first repetition of repeating field
classification
, creating it if it does not already exist {3}
-
getMarketingStatus
- Returns:
marketingStatus
(Marketing status of the medicinal product, in contrast to marketing authorization. This refers to the product being actually 'on the market' as opposed to being allowed to be on the market (which is an authorization).)
-
setMarketingStatus
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasMarketingStatus
-
addMarketingStatus
-
addMarketingStatus
-
getMarketingStatusFirstRep
- Returns:
- The first repetition of repeating field
marketingStatus
, creating it if it does not already exist {3}
-
getPackagedMedicinalProduct
- Returns:
packagedMedicinalProduct
(Package type for the product. See also the PackagedProductDefinition resource.)
-
setPackagedMedicinalProduct
public MedicinalProductDefinition setPackagedMedicinalProduct(List<CodeableConcept> thePackagedMedicinalProduct) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasPackagedMedicinalProduct
-
addPackagedMedicinalProduct
-
addPackagedMedicinalProduct
-
getPackagedMedicinalProductFirstRep
- Returns:
- The first repetition of repeating field
packagedMedicinalProduct
, creating it if it does not already exist {3}
-
getComprisedOf
- Returns:
comprisedOf
(Types of medicinal manufactured items and/or devices that this product consists of, such as tablets, capsule, or syringes. Used as a direct link when the item's packaging is not being recorded (see also PackagedProductDefinition.package.containedItem.item).)
-
setComprisedOf
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasComprisedOf
-
addComprisedOf
-
addComprisedOf
-
getComprisedOfFirstRep
- Returns:
- The first repetition of repeating field
comprisedOf
, creating it if it does not already exist {3}
-
getIngredient
- Returns:
ingredient
(The ingredients of this medicinal product - when not detailed in other resources. This is only needed if the ingredients are not specified by incoming references from the Ingredient resource, or indirectly via incoming AdministrableProductDefinition, PackagedProductDefinition or ManufacturedItemDefinition references. In cases where those levels of detail are not used, the ingredients may be specified directly here as codes.)
-
setIngredient
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIngredient
-
addIngredient
-
addIngredient
-
getIngredientFirstRep
- Returns:
- The first repetition of repeating field
ingredient
, creating it if it does not already exist {3}
-
getImpurity
- Returns:
impurity
(Any component of the drug product which is not the chemical entity defined as the drug substance, or an excipient in the drug product. This includes process-related impurities and contaminants, product-related impurities including degradation products.)
-
setImpurity
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasImpurity
-
addImpurity
-
addImpurity
-
getImpurityFirstRep
- Returns:
- The first repetition of repeating field
impurity
, creating it if it does not already exist {3}
-
getAttachedDocument
- Returns:
attachedDocument
(Additional information or supporting documentation about the medicinal product.)
-
setAttachedDocument
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAttachedDocument
-
addAttachedDocument
-
addAttachedDocument
-
getAttachedDocumentFirstRep
- Returns:
- The first repetition of repeating field
attachedDocument
, creating it if it does not already exist {3}
-
getMasterFile
- Returns:
masterFile
(A master file for the medicinal product (e.g. Pharmacovigilance System Master File). Drug master files (DMFs) are documents submitted to regulatory agencies to provide confidential detailed information about facilities, processes or articles used in the manufacturing, processing, packaging and storing of drug products.)
-
setMasterFile
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasMasterFile
-
addMasterFile
-
addMasterFile
-
getMasterFileFirstRep
- Returns:
- The first repetition of repeating field
masterFile
, creating it if it does not already exist {3}
-
getContact
- Returns:
contact
(A product specific contact, person (in a role), or an organization.)
-
setContact
public MedicinalProductDefinition setContact(List<MedicinalProductDefinition.MedicinalProductDefinitionContactComponent> theContact) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
-
addContact
-
addContact
-
getContactFirstRep
- Returns:
- The first repetition of repeating field
contact
, creating it if it does not already exist {3}
-
getClinicalTrial
- Returns:
clinicalTrial
(Clinical trials or studies that this product is involved in.)
-
setClinicalTrial
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasClinicalTrial
-
addClinicalTrial
-
addClinicalTrial
-
getClinicalTrialFirstRep
- Returns:
- The first repetition of repeating field
clinicalTrial
, creating it if it does not already exist {3}
-
getCode
- Returns:
code
(A code that this product is known by, usually within some formal terminology, perhaps assigned by a third party (i.e. not the manufacturer or regulator). Products (types of medications) tend to be known by identifiers during development and within regulatory process. However when they are prescribed they tend to be identified by codes. The same product may be have multiple codes, applied to it by multiple organizations.)
-
setCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCode
-
addCode
-
addCode
-
getCodeFirstRep
- Returns:
- The first repetition of repeating field
code
, creating it if it does not already exist {3}
-
getName
- Returns:
name
(The product's name, including full name and possibly coded parts.)
-
setName
public MedicinalProductDefinition setName(List<MedicinalProductDefinition.MedicinalProductDefinitionNameComponent> theName) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasName
-
addName
-
addName
-
getNameFirstRep
- Returns:
- The first repetition of repeating field
name
, creating it if it does not already exist {3}
-
getCrossReference
public List<MedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponent> getCrossReference()- Returns:
crossReference
(Reference to another product, e.g. for linking authorised to investigational product, or a virtual product.)
-
setCrossReference
public MedicinalProductDefinition setCrossReference(List<MedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponent> theCrossReference) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasCrossReference
-
addCrossReference
-
addCrossReference
-
getCrossReferenceFirstRep
public MedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponent getCrossReferenceFirstRep()- Returns:
- The first repetition of repeating field
crossReference
, creating it if it does not already exist {3}
-
getOperation
- Returns:
operation
(A manufacturing or administrative process or step associated with (or performed on) the medicinal product.)
-
setOperation
public MedicinalProductDefinition setOperation(List<MedicinalProductDefinition.MedicinalProductDefinitionOperationComponent> theOperation) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasOperation
-
addOperation
-
addOperation
-
getOperationFirstRep
public MedicinalProductDefinition.MedicinalProductDefinitionOperationComponent getOperationFirstRep()- Returns:
- The first repetition of repeating field
operation
, creating it if it does not already exist {3}
-
getCharacteristic
public List<MedicinalProductDefinition.MedicinalProductDefinitionCharacteristicComponent> getCharacteristic()- Returns:
characteristic
(Allows the key product features to be recorded, such as "sugar free", "modified release", "parallel import".)
-
setCharacteristic
public MedicinalProductDefinition setCharacteristic(List<MedicinalProductDefinition.MedicinalProductDefinitionCharacteristicComponent> theCharacteristic) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasCharacteristic
-
addCharacteristic
-
addCharacteristic
-
getCharacteristicFirstRep
public MedicinalProductDefinition.MedicinalProductDefinitionCharacteristicComponent getCharacteristicFirstRep()- Returns:
- The first repetition of repeating field
characteristic
, creating it if it does not already exist {3}
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
- Returns:
- the FHIR type name of the instance (not the java class name)
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-