
Package org.hl7.fhir.r4.model
Class MedicinalProduct
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.MedicinalProduct
- 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
Detailed definition of a medicinal product, typically for uses other than
direct patient care (e.g. regulatory use).
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic class -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CodeableConceptWhether the Medicinal Product is subject to additional monitoring for regulatory reasons.Supporting documentation, typically for regulatory submission.protected List<DocumentReference> The actual objects that are the target of the reference (Supporting documentation, typically for regulatory submission.)Clinical trials or studies that this product is involved in.protected List<ResearchStudy> The actual objects that are the target of the reference (Clinical trials or studies that this product is involved in.)protected CodeableConceptThe dose form for a single part product, or combined form of a multiple part product.A product specific contact, person (in a role), or an organization.The actual objects that are the target of the reference (A product specific contact, person (in a role), or an organization.)protected List<Identifier> Reference to another product, e.g. for linking authorised to investigational product.protected CodingIf this medicine applies to human or veterinary uses.protected List<Identifier> Business identifier for this product.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for identifierprotected CodeableConceptThe legal status of supply of the medicinal product as classified by the regulator.An operation applied to the product, for manufacturing or adminsitrative purpose.protected List<MarketingStatus> Marketing status of the medicinal product, in contrast to marketing authorizaton.A master file for to the medicinal product (e.g.protected List<DocumentReference> The actual objects that are the target of the reference (A master file for to the medicinal product (e.g.The product's name, including full name and possibly coded parts.static final ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for namestatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for name-languagePackage representation for the product.protected List<MedicinalProductPackaged> The actual objects that are the target of the reference (Package representation for the product.)protected CodeableConceptIf authorised for use in children.Pharmaceutical aspects of product.protected List<MedicinalProductPharmaceutical> The actual objects that are the target of the reference (Pharmaceutical aspects of product.)protected List<CodeableConcept> Allows the product to be classified by various systems.static final StringSearch parameter: identifierstatic final StringSearch parameter: namestatic final StringSearch parameter: name-languageIndicates if the medicinal product has an orphan designation for the treatment of a rare disease.protected List<StringType> Whether the Medicinal Product is subject to special measures for regulatory reasons.protected CodeableConceptRegulatory type, e.g.Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, textFields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, metaFields 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_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddManufacturingBusinessOperation(MedicinalProduct.MedicinalProductManufacturingBusinessOperationComponent t) addName()addSpecialMeasures(String value) copy()voidbooleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getName()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) getType()String[]getTypesForProperty(int hash, String name) booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasName()booleanbooleanbooleanbooleanbooleanbooleanbooleanhasSpecialMeasures(String value) booleanhasType()booleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) voidremoveChild(String name, Base value) setAttachedDocument(List<Reference> theAttachedDocument) setClinicalTrial(List<Reference> theClinicalTrial) setContact(List<Reference> theContact) setCrossReference(List<Identifier> theCrossReference) setIdentifier(List<Identifier> theIdentifier) setManufacturingBusinessOperation(List<MedicinalProduct.MedicinalProductManufacturingBusinessOperationComponent> theManufacturingBusinessOperation) setMarketingStatus(List<MarketingStatus> theMarketingStatus) setMasterFile(List<Reference> theMasterFile) setPackagedMedicinalProduct(List<Reference> thePackagedMedicinalProduct) setPharmaceuticalProduct(List<Reference> thePharmaceuticalProduct) setProductClassification(List<CodeableConcept> theProductClassification) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setSpecialDesignation(List<MedicinalProduct.MedicinalProductSpecialDesignationComponent> theSpecialDesignation) setSpecialMeasures(List<StringType> theSpecialMeasures) setType(CodeableConcept value) protected MedicinalProductMethods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setTextMethods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetaMethods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods 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, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN, setXhtmlMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods 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. -
type
Regulatory type, e.g. Investigational or Authorized. -
domain
If this medicine applies to human or veterinary uses. -
combinedPharmaceuticalDoseForm
The dose form for a single part product, or combined form of a multiple part product. -
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. -
specialMeasures
Whether the Medicinal Product is subject to special measures for regulatory reasons. -
paediatricUseIndicator
If authorised for use in children. -
productClassification
Allows the product to be classified by various systems. -
marketingStatus
Marketing status of the medicinal product, in contrast to marketing authorizaton. -
pharmaceuticalProduct
Pharmaceutical aspects of product. -
pharmaceuticalProductTarget
The actual objects that are the target of the reference (Pharmaceutical aspects of product.) -
packagedMedicinalProduct
Package representation for the product. -
packagedMedicinalProductTarget
The actual objects that are the target of the reference (Package representation for the product.) -
attachedDocument
Supporting documentation, typically for regulatory submission. -
attachedDocumentTarget
The actual objects that are the target of the reference (Supporting documentation, typically for regulatory submission.) -
masterFile
A master file for to the medicinal product (e.g. Pharmacovigilance System Master File). -
masterFileTarget
The actual objects that are the target of the reference (A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).) -
contact
A product specific contact, person (in a role), or an organization. -
contactTarget
The actual objects that are the target of the reference (A product specific contact, person (in a role), or an organization.) -
clinicalTrial
Clinical trials or studies that this product is involved in. -
clinicalTrialTarget
The actual objects that are the target of the reference (Clinical trials or studies that this product is involved in.) -
name
The product's name, including full name and possibly coded parts. -
crossReference
Reference to another product, e.g. for linking authorised to investigational product. -
manufacturingBusinessOperation
protected List<MedicinalProduct.MedicinalProductManufacturingBusinessOperationComponent> manufacturingBusinessOperationAn operation applied to the product, for manufacturing or adminsitrative purpose. -
specialDesignation
Indicates if the medicinal product has an orphan designation for the treatment of a rare disease. -
SP_IDENTIFIER
Search parameter: identifierDescription: Business identifier for this product. Could be an MPID
Type: token
Path: MedicinalProduct.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Business identifier for this product. Could be an MPID
Type: token
Path: MedicinalProduct.identifier
-
SP_NAME
Search parameter: nameDescription: The full product name
Type: string
Path: MedicinalProduct.name.productName
- See Also:
-
NAME
Fluent Client search parameter constant for nameDescription: The full product name
Type: string
Path: MedicinalProduct.name.productName
-
SP_NAME_LANGUAGE
Search parameter: name-languageDescription: Language code for this name
Type: token
Path: MedicinalProduct.name.countryLanguage.language
- See Also:
-
NAME_LANGUAGE
Fluent Client search parameter constant for name-languageDescription: Language code for this name
Type: token
Path: MedicinalProduct.name.countryLanguage.language
-
-
Constructor Details
-
MedicinalProduct
public MedicinalProduct()Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier(Business identifier for this product. Could be an MPID.)
-
setIdentifier
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
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.)
-
getCombinedPharmaceuticalDoseForm
- Returns:
combinedPharmaceuticalDoseForm(The dose form for a single part product, or combined form of a multiple part product.)
-
hasCombinedPharmaceuticalDoseForm
-
setCombinedPharmaceuticalDoseForm
- Parameters:
value-combinedPharmaceuticalDoseForm(The dose form for a single part product, or combined form of a multiple part product.)
-
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.)
-
hasAdditionalMonitoringIndicator
-
setAdditionalMonitoringIndicator
- Parameters:
value-additionalMonitoringIndicator(Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.)
-
getSpecialMeasures
- Returns:
specialMeasures(Whether the Medicinal Product is subject to special measures for regulatory reasons.)
-
setSpecialMeasures
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSpecialMeasures
-
addSpecialMeasuresElement
- Returns:
specialMeasures(Whether the Medicinal Product is subject to special measures for regulatory reasons.)
-
addSpecialMeasures
- Parameters:
value-specialMeasures(Whether the Medicinal Product is subject to special measures for regulatory reasons.)
-
hasSpecialMeasures
- Parameters:
value-specialMeasures(Whether the Medicinal Product is subject to special measures for regulatory reasons.)
-
getPaediatricUseIndicator
- Returns:
paediatricUseIndicator(If authorised for use in children.)
-
hasPaediatricUseIndicator
-
setPaediatricUseIndicator
- Parameters:
value-paediatricUseIndicator(If authorised for use in children.)
-
getProductClassification
- Returns:
productClassification(Allows the product to be classified by various systems.)
-
setProductClassification
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasProductClassification
-
addProductClassification
-
addProductClassification
-
getProductClassificationFirstRep
- Returns:
- The first repetition of repeating field
productClassification, creating it if it does not already exist
-
getMarketingStatus
- Returns:
marketingStatus(Marketing status of the medicinal product, in contrast to marketing authorizaton.)
-
setMarketingStatus
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasMarketingStatus
-
addMarketingStatus
-
addMarketingStatus
-
getMarketingStatusFirstRep
- Returns:
- The first repetition of repeating field
marketingStatus, creating it if it does not already exist
-
getPharmaceuticalProduct
- Returns:
pharmaceuticalProduct(Pharmaceutical aspects of product.)
-
setPharmaceuticalProduct
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPharmaceuticalProduct
-
addPharmaceuticalProduct
-
addPharmaceuticalProduct
-
getPharmaceuticalProductFirstRep
- Returns:
- The first repetition of repeating field
pharmaceuticalProduct, creating it if it does not already exist
-
getPackagedMedicinalProduct
- Returns:
packagedMedicinalProduct(Package representation for the product.)
-
setPackagedMedicinalProduct
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPackagedMedicinalProduct
-
addPackagedMedicinalProduct
-
addPackagedMedicinalProduct
-
getPackagedMedicinalProductFirstRep
- Returns:
- The first repetition of repeating field
packagedMedicinalProduct, creating it if it does not already exist
-
getAttachedDocument
- Returns:
attachedDocument(Supporting documentation, typically for regulatory submission.)
-
setAttachedDocument
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAttachedDocument
-
addAttachedDocument
-
addAttachedDocument
-
getAttachedDocumentFirstRep
- Returns:
- The first repetition of repeating field
attachedDocument, creating it if it does not already exist
-
getMasterFile
- Returns:
masterFile(A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).)
-
setMasterFile
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasMasterFile
-
addMasterFile
-
addMasterFile
-
getMasterFileFirstRep
- Returns:
- The first repetition of repeating field
masterFile, creating it if it does not already exist
-
getContact
- Returns:
contact(A product specific contact, person (in a role), or an organization.)
-
setContact
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
-
addContact
-
addContact
-
getContactFirstRep
- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist
-
getClinicalTrial
- Returns:
clinicalTrial(Clinical trials or studies that this product is involved in.)
-
setClinicalTrial
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasClinicalTrial
-
addClinicalTrial
-
addClinicalTrial
-
getClinicalTrialFirstRep
- Returns:
- The first repetition of repeating field
clinicalTrial, creating it if it does not already exist
-
getName
- Returns:
name(The product's name, including full name and possibly coded parts.)
-
setName
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasName
-
addName
-
addName
-
getNameFirstRep
- Returns:
- The first repetition of repeating field
name, creating it if it does not already exist
-
getCrossReference
- Returns:
crossReference(Reference to another product, e.g. for linking authorised to investigational product.)
-
setCrossReference
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCrossReference
-
addCrossReference
-
addCrossReference
-
getCrossReferenceFirstRep
- Returns:
- The first repetition of repeating field
crossReference, creating it if it does not already exist
-
getManufacturingBusinessOperation
public List<MedicinalProduct.MedicinalProductManufacturingBusinessOperationComponent> getManufacturingBusinessOperation()- Returns:
manufacturingBusinessOperation(An operation applied to the product, for manufacturing or adminsitrative purpose.)
-
setManufacturingBusinessOperation
public MedicinalProduct setManufacturingBusinessOperation(List<MedicinalProduct.MedicinalProductManufacturingBusinessOperationComponent> theManufacturingBusinessOperation) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasManufacturingBusinessOperation
-
addManufacturingBusinessOperation
-
addManufacturingBusinessOperation
-
getManufacturingBusinessOperationFirstRep
public MedicinalProduct.MedicinalProductManufacturingBusinessOperationComponent getManufacturingBusinessOperationFirstRep()- Returns:
- The first repetition of repeating field
manufacturingBusinessOperation, creating it if it does not already exist
-
getSpecialDesignation
- Returns:
specialDesignation(Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.)
-
setSpecialDesignation
public MedicinalProduct setSpecialDesignation(List<MedicinalProduct.MedicinalProductSpecialDesignationComponent> theSpecialDesignation) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSpecialDesignation
-
addSpecialDesignation
-
addSpecialDesignation
-
getSpecialDesignationFirstRep
- Returns:
- The first repetition of repeating field
specialDesignation, creating it if it does not already exist
-
listChildren
- 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
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- 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
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
- Specified by:
copyin classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-