Class MedicinalProductDefinition
- java.lang.Object
-
- org.hl7.fhir.r4b.model.Base
-
- org.hl7.fhir.r4b.model.BaseResource
-
- org.hl7.fhir.r4b.model.Resource
-
- org.hl7.fhir.r4b.model.DomainResource
-
- org.hl7.fhir.r4b.model.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
public class MedicinalProductDefinition extends DomainResource
Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use, drug catalogs).- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMedicinalProductDefinition.MedicinalProductDefinitionCharacteristicComponentstatic classMedicinalProductDefinition.MedicinalProductDefinitionContactComponentstatic classMedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponentstatic classMedicinalProductDefinition.MedicinalProductDefinitionNameComponentstatic classMedicinalProductDefinition.MedicinalProductDefinitionNameCountryLanguageComponentstatic classMedicinalProductDefinition.MedicinalProductDefinitionNameNamePartComponentstatic classMedicinalProductDefinition.MedicinalProductDefinitionOperationComponent
-
Field Summary
Fields Modifier and Type Field Description protected CodeableConceptadditionalMonitoringIndicatorWhether the Medicinal Product is subject to additional monitoring for regulatory reasons.protected List<Reference>attachedDocumentAdditional information or supporting documentation about the medicinal product.protected List<MedicinalProductDefinition.MedicinalProductDefinitionCharacteristicComponent>characteristicAllows the key product features to be recorded, such as "sugar free", "modified release", "parallel import".static ca.uhn.fhir.rest.gclient.TokenClientParamCHARACTERISTICFluent Client search parameter constant for characteristicstatic ca.uhn.fhir.rest.gclient.TokenClientParamCHARACTERISTIC_TYPEFluent Client search parameter constant for characteristic-typeprotected List<CodeableConcept>classificationAllows the product to be classified by various systems.protected List<Reference>clinicalTrialClinical trials or studies that this product is involved in.protected List<Coding>codeA code that this product is known by, usually within some formal terminology.protected CodeableConceptcombinedPharmaceuticalDoseFormThe dose form for a single part product, or combined form of a multiple part product.protected List<MedicinalProductDefinition.MedicinalProductDefinitionContactComponent>contactA product specific contact, person (in a role), or an organization.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCONTACTFluent Client search parameter constant for contactprotected List<MedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponent>crossReferenceReference to another product, e.g.protected MarkdownTypedescriptionGeneral description of this product.protected CodeableConceptdomainIf this medicine applies to human or veterinary uses.static ca.uhn.fhir.rest.gclient.TokenClientParamDOMAINFluent Client search parameter constant for domainprotected List<Identifier>identifierBusiness identifier for this product.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierprotected List<CodeableReference>impurityAny component of the drug product which is not the chemical entity defined as the drug substance or an excipient in the drug product.static ca.uhn.fhir.model.api.IncludeINCLUDE_CONTACTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_MASTER_FILEConstant for fluent queries to be used to add include statements.protected MarkdownTypeindicationDescription of indication(s) for this product, used when structured indications are not required.protected List<CodeableConcept>ingredientThe ingredients of this medicinal product - when not detailed in other resources.static ca.uhn.fhir.rest.gclient.TokenClientParamINGREDIENTFluent Client search parameter constant for ingredientprotected CodeableConceptlegalStatusOfSupplyThe legal status of supply of the medicinal product as classified by the regulator.protected List<MarketingStatus>marketingStatusMarketing status of the medicinal product, in contrast to marketing authorization.static ca.uhn.fhir.rest.gclient.ReferenceClientParamMASTER_FILEFluent Client search parameter constant for master-fileprotected List<Reference>masterFileA master file for the medicinal product (e.g.protected List<MedicinalProductDefinition.MedicinalProductDefinitionNameComponent>nameThe product's name, including full name and possibly coded parts.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for namestatic ca.uhn.fhir.rest.gclient.TokenClientParamNAME_LANGUAGEFluent Client search parameter constant for name-languageprotected List<MedicinalProductDefinition.MedicinalProductDefinitionOperationComponent>operationA manufacturing or administrative process or step associated with (or performed on) the medicinal product.protected List<CodeableConcept>packagedMedicinalProductPackage representation for the product.protected CodeableConceptpediatricUseIndicatorIf authorised for use in children.static ca.uhn.fhir.rest.gclient.TokenClientParamPRODUCT_CLASSIFICATIONFluent Client search parameter constant for product-classificationprotected List<CodeableConcept>routeThe path by which the product is taken into or makes contact with the body.static StringSP_CHARACTERISTICSearch parameter: characteristicstatic StringSP_CHARACTERISTIC_TYPESearch parameter: characteristic-typestatic StringSP_CONTACTSearch parameter: contactstatic StringSP_DOMAINSearch parameter: domainstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_INGREDIENTSearch parameter: ingredientstatic StringSP_MASTER_FILESearch parameter: master-filestatic StringSP_NAMESearch parameter: namestatic StringSP_NAME_LANGUAGESearch parameter: name-languagestatic StringSP_PRODUCT_CLASSIFICATIONSearch parameter: product-classificationstatic StringSP_STATUSSearch parameter: statusstatic StringSP_TYPESearch parameter: typeprotected List<CodeableConcept>specialMeasuresWhether the Medicinal Product is subject to special measures for regulatory reasons.protected CodeableConceptstatusThe status within the lifecycle of this product record.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected DateTimeTypestatusDateThe date at which the given status became applicable.protected CodeableConcepttypeRegulatory type, e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for typeprotected StringTypeversionA 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.r4b.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r4b.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description MedicinalProductDefinition()ConstructorMedicinalProductDefinition(MedicinalProductDefinition.MedicinalProductDefinitionNameComponent name)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4b.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.r4b.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.r4b.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4b.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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Business identifier for this product. Could be an MPID.
-
type
protected CodeableConcept type
Regulatory type, e.g. Investigational or Authorized.
-
domain
protected CodeableConcept domain
If this medicine applies to human or veterinary uses.
-
version
protected StringType version
A business identifier relating to a specific version of the product, this is commonly used to support revisions to an existing product.
-
status
protected CodeableConcept 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
protected DateTimeType statusDate
The date at which the given status became applicable.
-
description
protected MarkdownType description
General description of this product.
-
combinedPharmaceuticalDoseForm
protected CodeableConcept combinedPharmaceuticalDoseForm
The dose form for a single part product, or combined form of a multiple part product.
-
route
protected List<CodeableConcept> 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.
-
indication
protected MarkdownType 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
protected CodeableConcept legalStatusOfSupply
The legal status of supply of the medicinal product as classified by the regulator.
-
additionalMonitoringIndicator
protected CodeableConcept additionalMonitoringIndicator
Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.
-
specialMeasures
protected List<CodeableConcept> specialMeasures
Whether the Medicinal Product is subject to special measures for regulatory reasons.
-
pediatricUseIndicator
protected CodeableConcept pediatricUseIndicator
If authorised for use in children.
-
classification
protected List<CodeableConcept> classification
Allows the product to be classified by various systems.
-
marketingStatus
protected List<MarketingStatus> marketingStatus
Marketing status of the medicinal product, in contrast to marketing authorization.
-
packagedMedicinalProduct
protected List<CodeableConcept> packagedMedicinalProduct
Package representation for the product. See also the PackagedProductDefinition resource.
-
ingredient
protected List<CodeableConcept> 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
protected List<CodeableReference> 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
protected List<Reference> attachedDocument
Additional information or supporting documentation about the medicinal product.
-
masterFile
protected List<Reference> 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
protected List<MedicinalProductDefinition.MedicinalProductDefinitionContactComponent> contact
A product specific contact, person (in a role), or an organization.
-
clinicalTrial
protected List<Reference> clinicalTrial
Clinical trials or studies that this product is involved in.
-
code
protected List<Coding> code
A code that this product is known by, usually within some formal terminology. 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
protected List<MedicinalProductDefinition.MedicinalProductDefinitionNameComponent> name
The product's name, including full name and possibly coded parts.
-
crossReference
protected List<MedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponent> crossReference
Reference to another product, e.g. for linking authorised to investigational product.
-
operation
protected List<MedicinalProductDefinition.MedicinalProductDefinitionOperationComponent> operation
A manufacturing or administrative process or step associated with (or performed on) the medicinal product.
-
characteristic
protected List<MedicinalProductDefinition.MedicinalProductDefinitionCharacteristicComponent> characteristic
Allows the key product features to be recorded, such as "sugar free", "modified release", "parallel import".
-
SP_CHARACTERISTIC_TYPE
public static final String SP_CHARACTERISTIC_TYPE
Search parameter: characteristic-typeDescription: A category for the characteristic
Type: token
Path: MedicinalProductDefinition.characteristic.type
- See Also:
- Constant Field Values
-
CHARACTERISTIC_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CHARACTERISTIC_TYPE
Fluent Client search parameter constant for characteristic-typeDescription: A category for the characteristic
Type: token
Path: MedicinalProductDefinition.characteristic.type
-
SP_CHARACTERISTIC
public static final String 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
- See Also:
- Constant Field Values
-
CHARACTERISTIC
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
-
SP_CONTACT
public static final String SP_CONTACT
Search parameter: contactDescription: A product specific contact, person (in a role), or an organization
Type: reference
Path: MedicinalProductDefinition.contact.contact
- See Also:
- Constant Field Values
-
CONTACT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTACT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicinalProductDefinition:contact".
-
SP_DOMAIN
public static final String SP_DOMAIN
Search parameter: domainDescription: If this medicine applies to human or veterinary uses
Type: token
Path: MedicinalProductDefinition.domain
- See Also:
- Constant Field Values
-
DOMAIN
public static final ca.uhn.fhir.rest.gclient.TokenClientParam DOMAIN
Fluent Client search parameter constant for domainDescription: If this medicine applies to human or veterinary uses
Type: token
Path: MedicinalProductDefinition.domain
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Business identifier for this product. Could be an MPID
Type: token
Path: MedicinalProductDefinition.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Business identifier for this product. Could be an MPID
Type: token
Path: MedicinalProductDefinition.identifier
-
SP_INGREDIENT
public static final String SP_INGREDIENT
Search parameter: ingredientDescription: An ingredient of this product
Type: token
Path: MedicinalProductDefinition.ingredient
- See Also:
- Constant Field Values
-
INGREDIENT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam INGREDIENT
Fluent Client search parameter constant for ingredientDescription: An ingredient of this product
Type: token
Path: MedicinalProductDefinition.ingredient
-
SP_MASTER_FILE
public static final String 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:
- Constant Field Values
-
MASTER_FILE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
public static final ca.uhn.fhir.model.api.Include 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
public static final String SP_NAME_LANGUAGE
Search parameter: name-languageDescription: Language code for this name
Type: token
Path: MedicinalProductDefinition.name.countryLanguage.language
- See Also:
- Constant Field Values
-
NAME_LANGUAGE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam NAME_LANGUAGE
Fluent Client search parameter constant for name-languageDescription: Language code for this name
Type: token
Path: MedicinalProductDefinition.name.countryLanguage.language
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: The full product name
Type: string
Path: MedicinalProductDefinition.name.productName
- See Also:
- Constant Field Values
-
NAME
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Fluent Client search parameter constant for nameDescription: The full product name
Type: string
Path: MedicinalProductDefinition.name.productName
-
SP_PRODUCT_CLASSIFICATION
public static final String SP_PRODUCT_CLASSIFICATION
Search parameter: product-classificationDescription: Allows the product to be classified by various systems
Type: token
Path: MedicinalProductDefinition.classification
- See Also:
- Constant Field Values
-
PRODUCT_CLASSIFICATION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String 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:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String SP_TYPE
Search parameter: typeDescription: Regulatory type, e.g. Investigational or Authorized
Type: token
Path: MedicinalProductDefinition.type
- See Also:
- Constant Field Values
-
TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
Fluent Client search parameter constant for typeDescription: Regulatory type, e.g. Investigational or Authorized
Type: token
Path: MedicinalProductDefinition.type
-
-
Constructor Detail
-
MedicinalProductDefinition
public MedicinalProductDefinition()
Constructor
-
MedicinalProductDefinition
public MedicinalProductDefinition(MedicinalProductDefinition.MedicinalProductDefinitionNameComponent name)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Business identifier for this product. Could be an MPID.)
-
setIdentifier
public MedicinalProductDefinition setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public MedicinalProductDefinition addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getType
public CodeableConcept getType()
- Returns:
type(Regulatory type, e.g. Investigational or Authorized.)
-
hasType
public boolean hasType()
-
setType
public MedicinalProductDefinition setType(CodeableConcept value)
- Parameters:
value-type(Regulatory type, e.g. Investigational or Authorized.)
-
getDomain
public CodeableConcept getDomain()
- Returns:
domain(If this medicine applies to human or veterinary uses.)
-
hasDomain
public boolean hasDomain()
-
setDomain
public MedicinalProductDefinition setDomain(CodeableConcept value)
- Parameters:
value-domain(If this medicine applies to human or veterinary uses.)
-
getVersionElement
public StringType 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
public boolean hasVersionElement()
-
hasVersion
public boolean hasVersion()
-
setVersionElement
public MedicinalProductDefinition setVersionElement(StringType value)
- 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
public String 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
public MedicinalProductDefinition setVersion(String value)
- 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
public CodeableConcept 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
public boolean hasStatus()
-
setStatus
public MedicinalProductDefinition setStatus(CodeableConcept value)
- 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
public DateTimeType 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
public boolean hasStatusDateElement()
-
hasStatusDate
public boolean hasStatusDate()
-
setStatusDateElement
public MedicinalProductDefinition setStatusDateElement(DateTimeType value)
- 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
public Date getStatusDate()
- Returns:
- The date at which the given status became applicable.
-
setStatusDate
public MedicinalProductDefinition setStatusDate(Date value)
- Parameters:
value- The date at which the given status became applicable.
-
getDescriptionElement
public MarkdownType 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
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public MedicinalProductDefinition setDescriptionElement(MarkdownType value)
- 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
public String getDescription()
- Returns:
- General description of this product.
-
setDescription
public MedicinalProductDefinition setDescription(String value)
- Parameters:
value- General description of this product.
-
getCombinedPharmaceuticalDoseForm
public CodeableConcept getCombinedPharmaceuticalDoseForm()
- Returns:
combinedPharmaceuticalDoseForm(The dose form for a single part product, or combined form of a multiple part product.)
-
hasCombinedPharmaceuticalDoseForm
public boolean hasCombinedPharmaceuticalDoseForm()
-
setCombinedPharmaceuticalDoseForm
public MedicinalProductDefinition setCombinedPharmaceuticalDoseForm(CodeableConcept value)
- Parameters:
value-combinedPharmaceuticalDoseForm(The dose form for a single part product, or combined form of a multiple part product.)
-
getRoute
public List<CodeableConcept> 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.)
-
setRoute
public MedicinalProductDefinition setRoute(List<CodeableConcept> theRoute)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRoute
public boolean hasRoute()
-
addRoute
public CodeableConcept addRoute()
-
addRoute
public MedicinalProductDefinition addRoute(CodeableConcept t)
-
getRouteFirstRep
public CodeableConcept getRouteFirstRep()
- Returns:
- The first repetition of repeating field
route, creating it if it does not already exist {3}
-
getIndicationElement
public MarkdownType 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
public boolean hasIndicationElement()
-
hasIndication
public boolean hasIndication()
-
setIndicationElement
public MedicinalProductDefinition setIndicationElement(MarkdownType value)
- 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
public String 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
public MedicinalProductDefinition setIndication(String value)
- 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
public CodeableConcept getLegalStatusOfSupply()
- Returns:
legalStatusOfSupply(The legal status of supply of the medicinal product as classified by the regulator.)
-
hasLegalStatusOfSupply
public boolean hasLegalStatusOfSupply()
-
setLegalStatusOfSupply
public MedicinalProductDefinition setLegalStatusOfSupply(CodeableConcept value)
- Parameters:
value-legalStatusOfSupply(The legal status of supply of the medicinal product as classified by the regulator.)
-
getAdditionalMonitoringIndicator
public CodeableConcept getAdditionalMonitoringIndicator()
- Returns:
additionalMonitoringIndicator(Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.)
-
hasAdditionalMonitoringIndicator
public boolean hasAdditionalMonitoringIndicator()
-
setAdditionalMonitoringIndicator
public MedicinalProductDefinition setAdditionalMonitoringIndicator(CodeableConcept value)
- Parameters:
value-additionalMonitoringIndicator(Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.)
-
getSpecialMeasures
public List<CodeableConcept> getSpecialMeasures()
- Returns:
specialMeasures(Whether the Medicinal Product is subject to special measures for regulatory reasons.)
-
setSpecialMeasures
public MedicinalProductDefinition setSpecialMeasures(List<CodeableConcept> theSpecialMeasures)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSpecialMeasures
public boolean hasSpecialMeasures()
-
addSpecialMeasures
public CodeableConcept addSpecialMeasures()
-
addSpecialMeasures
public MedicinalProductDefinition addSpecialMeasures(CodeableConcept t)
-
getSpecialMeasuresFirstRep
public CodeableConcept getSpecialMeasuresFirstRep()
- Returns:
- The first repetition of repeating field
specialMeasures, creating it if it does not already exist {3}
-
getPediatricUseIndicator
public CodeableConcept getPediatricUseIndicator()
- Returns:
pediatricUseIndicator(If authorised for use in children.)
-
hasPediatricUseIndicator
public boolean hasPediatricUseIndicator()
-
setPediatricUseIndicator
public MedicinalProductDefinition setPediatricUseIndicator(CodeableConcept value)
- Parameters:
value-pediatricUseIndicator(If authorised for use in children.)
-
getClassification
public List<CodeableConcept> getClassification()
- Returns:
classification(Allows the product to be classified by various systems.)
-
setClassification
public MedicinalProductDefinition setClassification(List<CodeableConcept> theClassification)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasClassification
public boolean hasClassification()
-
addClassification
public CodeableConcept addClassification()
-
addClassification
public MedicinalProductDefinition addClassification(CodeableConcept t)
-
getClassificationFirstRep
public CodeableConcept getClassificationFirstRep()
- Returns:
- The first repetition of repeating field
classification, creating it if it does not already exist {3}
-
getMarketingStatus
public List<MarketingStatus> getMarketingStatus()
- Returns:
marketingStatus(Marketing status of the medicinal product, in contrast to marketing authorization.)
-
setMarketingStatus
public MedicinalProductDefinition setMarketingStatus(List<MarketingStatus> theMarketingStatus)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasMarketingStatus
public boolean hasMarketingStatus()
-
addMarketingStatus
public MarketingStatus addMarketingStatus()
-
addMarketingStatus
public MedicinalProductDefinition addMarketingStatus(MarketingStatus t)
-
getMarketingStatusFirstRep
public MarketingStatus getMarketingStatusFirstRep()
- Returns:
- The first repetition of repeating field
marketingStatus, creating it if it does not already exist {3}
-
getPackagedMedicinalProduct
public List<CodeableConcept> getPackagedMedicinalProduct()
- Returns:
packagedMedicinalProduct(Package representation for the product. See also the PackagedProductDefinition resource.)
-
setPackagedMedicinalProduct
public MedicinalProductDefinition setPackagedMedicinalProduct(List<CodeableConcept> thePackagedMedicinalProduct)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPackagedMedicinalProduct
public boolean hasPackagedMedicinalProduct()
-
addPackagedMedicinalProduct
public CodeableConcept addPackagedMedicinalProduct()
-
addPackagedMedicinalProduct
public MedicinalProductDefinition addPackagedMedicinalProduct(CodeableConcept t)
-
getPackagedMedicinalProductFirstRep
public CodeableConcept getPackagedMedicinalProductFirstRep()
- Returns:
- The first repetition of repeating field
packagedMedicinalProduct, creating it if it does not already exist {3}
-
getIngredient
public List<CodeableConcept> 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
public MedicinalProductDefinition setIngredient(List<CodeableConcept> theIngredient)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIngredient
public boolean hasIngredient()
-
addIngredient
public CodeableConcept addIngredient()
-
addIngredient
public MedicinalProductDefinition addIngredient(CodeableConcept t)
-
getIngredientFirstRep
public CodeableConcept getIngredientFirstRep()
- Returns:
- The first repetition of repeating field
ingredient, creating it if it does not already exist {3}
-
getImpurity
public List<CodeableReference> 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
public MedicinalProductDefinition setImpurity(List<CodeableReference> theImpurity)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasImpurity
public boolean hasImpurity()
-
addImpurity
public CodeableReference addImpurity()
-
addImpurity
public MedicinalProductDefinition addImpurity(CodeableReference t)
-
getImpurityFirstRep
public CodeableReference getImpurityFirstRep()
- Returns:
- The first repetition of repeating field
impurity, creating it if it does not already exist {3}
-
getAttachedDocument
public List<Reference> getAttachedDocument()
- Returns:
attachedDocument(Additional information or supporting documentation about the medicinal product.)
-
setAttachedDocument
public MedicinalProductDefinition setAttachedDocument(List<Reference> theAttachedDocument)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAttachedDocument
public boolean hasAttachedDocument()
-
addAttachedDocument
public Reference addAttachedDocument()
-
addAttachedDocument
public MedicinalProductDefinition addAttachedDocument(Reference t)
-
getAttachedDocumentFirstRep
public Reference getAttachedDocumentFirstRep()
- Returns:
- The first repetition of repeating field
attachedDocument, creating it if it does not already exist {3}
-
getMasterFile
public List<Reference> 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
public MedicinalProductDefinition setMasterFile(List<Reference> theMasterFile)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasMasterFile
public boolean hasMasterFile()
-
addMasterFile
public Reference addMasterFile()
-
addMasterFile
public MedicinalProductDefinition addMasterFile(Reference t)
-
getMasterFileFirstRep
public Reference getMasterFileFirstRep()
- Returns:
- The first repetition of repeating field
masterFile, creating it if it does not already exist {3}
-
getContact
public List<MedicinalProductDefinition.MedicinalProductDefinitionContactComponent> 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
thisfor easy method chaining
-
hasContact
public boolean hasContact()
-
addContact
public MedicinalProductDefinition.MedicinalProductDefinitionContactComponent addContact()
-
addContact
public MedicinalProductDefinition addContact(MedicinalProductDefinition.MedicinalProductDefinitionContactComponent t)
-
getContactFirstRep
public MedicinalProductDefinition.MedicinalProductDefinitionContactComponent getContactFirstRep()
- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist {3}
-
getClinicalTrial
public List<Reference> getClinicalTrial()
- Returns:
clinicalTrial(Clinical trials or studies that this product is involved in.)
-
setClinicalTrial
public MedicinalProductDefinition setClinicalTrial(List<Reference> theClinicalTrial)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasClinicalTrial
public boolean hasClinicalTrial()
-
addClinicalTrial
public Reference addClinicalTrial()
-
addClinicalTrial
public MedicinalProductDefinition addClinicalTrial(Reference t)
-
getClinicalTrialFirstRep
public Reference getClinicalTrialFirstRep()
- Returns:
- The first repetition of repeating field
clinicalTrial, creating it if it does not already exist {3}
-
getCode
public List<Coding> getCode()
- Returns:
code(A code that this product is known by, usually within some formal terminology. 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
public MedicinalProductDefinition setCode(List<Coding> theCode)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCode
public boolean hasCode()
-
addCode
public MedicinalProductDefinition addCode(Coding t)
-
getCodeFirstRep
public Coding getCodeFirstRep()
- Returns:
- The first repetition of repeating field
code, creating it if it does not already exist {3}
-
getName
public List<MedicinalProductDefinition.MedicinalProductDefinitionNameComponent> 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
thisfor easy method chaining
-
hasName
public boolean hasName()
-
addName
public MedicinalProductDefinition addName(MedicinalProductDefinition.MedicinalProductDefinitionNameComponent t)
-
getNameFirstRep
public MedicinalProductDefinition.MedicinalProductDefinitionNameComponent 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.)
-
setCrossReference
public MedicinalProductDefinition setCrossReference(List<MedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponent> theCrossReference)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCrossReference
public boolean hasCrossReference()
-
addCrossReference
public MedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponent addCrossReference()
-
addCrossReference
public MedicinalProductDefinition addCrossReference(MedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponent t)
-
getCrossReferenceFirstRep
public MedicinalProductDefinition.MedicinalProductDefinitionCrossReferenceComponent getCrossReferenceFirstRep()
- Returns:
- The first repetition of repeating field
crossReference, creating it if it does not already exist {3}
-
getOperation
public List<MedicinalProductDefinition.MedicinalProductDefinitionOperationComponent> 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
thisfor easy method chaining
-
hasOperation
public boolean hasOperation()
-
addOperation
public MedicinalProductDefinition.MedicinalProductDefinitionOperationComponent addOperation()
-
addOperation
public MedicinalProductDefinition addOperation(MedicinalProductDefinition.MedicinalProductDefinitionOperationComponent t)
-
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
thisfor easy method chaining
-
hasCharacteristic
public boolean hasCharacteristic()
-
addCharacteristic
public MedicinalProductDefinition.MedicinalProductDefinitionCharacteristicComponent addCharacteristic()
-
addCharacteristic
public MedicinalProductDefinition addCharacteristic(MedicinalProductDefinition.MedicinalProductDefinitionCharacteristicComponent t)
-
getCharacteristicFirstRep
public MedicinalProductDefinition.MedicinalProductDefinitionCharacteristicComponent getCharacteristicFirstRep()
- Returns:
- The first repetition of repeating field
characteristic, 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 MedicinalProductDefinition copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(MedicinalProductDefinition dst)
-
typedCopy
protected MedicinalProductDefinition 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
-
-