Package com.ibm.fhir.model.resource
Class MedicinalProduct
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.MedicinalProduct
-
- All Implemented Interfaces:
Visitable
@Generated("com.ibm.fhir.tools.CodeGenerator") public class MedicinalProduct extends DomainResource
Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).Maturity level: FMM0 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MedicinalProduct.Builder
static class
MedicinalProduct.ManufacturingBusinessOperation
An operation applied to the product, for manufacturing or adminsitrative purpose.static class
MedicinalProduct.Name
The product's name, including full name and possibly coded parts.static class
MedicinalProduct.SpecialDesignation
Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource
id, implicitRules, language, meta
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static MedicinalProduct.Builder
builder()
boolean
equals(Object obj)
CodeableConcept
getAdditionalMonitoringIndicator()
Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.List<Reference>
getAttachedDocument()
Supporting documentation, typically for regulatory submission.List<Reference>
getClinicalTrial()
Clinical trials or studies that this product is involved in.CodeableConcept
getCombinedPharmaceuticalDoseForm()
The dose form for a single part product, or combined form of a multiple part product.List<Reference>
getContact()
A product specific contact, person (in a role), or an organization.List<Identifier>
getCrossReference()
Reference to another product, e.g.Coding
getDomain()
If this medicine applies to human or veterinary uses.List<Identifier>
getIdentifier()
Business identifier for this product.CodeableConcept
getLegalStatusOfSupply()
The legal status of supply of the medicinal product as classified by the regulator.List<MedicinalProduct.ManufacturingBusinessOperation>
getManufacturingBusinessOperation()
An operation applied to the product, for manufacturing or adminsitrative purpose.List<MarketingStatus>
getMarketingStatus()
Marketing status of the medicinal product, in contrast to marketing authorizaton.List<Reference>
getMasterFile()
A master file for to the medicinal product (e.g.List<MedicinalProduct.Name>
getName()
The product's name, including full name and possibly coded parts.List<Reference>
getPackagedMedicinalProduct()
Package representation for the product.CodeableConcept
getPaediatricUseIndicator()
If authorised for use in children.List<Reference>
getPharmaceuticalProduct()
Pharmaceutical aspects of product.List<CodeableConcept>
getProductClassification()
Allows the product to be classified by various systems.List<MedicinalProduct.SpecialDesignation>
getSpecialDesignation()
Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.List<String>
getSpecialMeasures()
Whether the Medicinal Product is subject to special measures for regulatory reasons.CodeableConcept
getType()
Regulatory type, e.g.boolean
hasChildren()
int
hashCode()
MedicinalProduct.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
Business identifier for this product. Could be an MPID.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getType
public CodeableConcept getType()
Regulatory type, e.g. Investigational or Authorized.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getDomain
public Coding getDomain()
If this medicine applies to human or veterinary uses.- Returns:
- An immutable object of type
Coding
that may be null.
-
getCombinedPharmaceuticalDoseForm
public CodeableConcept getCombinedPharmaceuticalDoseForm()
The dose form for a single part product, or combined form of a multiple part product.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getLegalStatusOfSupply
public CodeableConcept getLegalStatusOfSupply()
The legal status of supply of the medicinal product as classified by the regulator.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getAdditionalMonitoringIndicator
public CodeableConcept getAdditionalMonitoringIndicator()
Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getSpecialMeasures
public List<String> getSpecialMeasures()
Whether the Medicinal Product is subject to special measures for regulatory reasons.- Returns:
- An unmodifiable list containing immutable objects of type
String
that may be empty.
-
getPaediatricUseIndicator
public CodeableConcept getPaediatricUseIndicator()
If authorised for use in children.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getProductClassification
public List<CodeableConcept> getProductClassification()
Allows the product to be classified by various systems.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getMarketingStatus
public List<MarketingStatus> getMarketingStatus()
Marketing status of the medicinal product, in contrast to marketing authorizaton.- Returns:
- An unmodifiable list containing immutable objects of type
MarketingStatus
that may be empty.
-
getPharmaceuticalProduct
public List<Reference> getPharmaceuticalProduct()
Pharmaceutical aspects of product.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getPackagedMedicinalProduct
public List<Reference> getPackagedMedicinalProduct()
Package representation for the product.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getAttachedDocument
public List<Reference> getAttachedDocument()
Supporting documentation, typically for regulatory submission.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getMasterFile
public List<Reference> getMasterFile()
A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getContact
public List<Reference> getContact()
A product specific contact, person (in a role), or an organization.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getClinicalTrial
public List<Reference> getClinicalTrial()
Clinical trials or studies that this product is involved in.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getName
public List<MedicinalProduct.Name> getName()
The product's name, including full name and possibly coded parts.- Returns:
- An unmodifiable list containing immutable objects of type
MedicinalProduct.Name
that is non-empty.
-
getCrossReference
public List<Identifier> getCrossReference()
Reference to another product, e.g. for linking authorised to investigational product.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getManufacturingBusinessOperation
public List<MedicinalProduct.ManufacturingBusinessOperation> getManufacturingBusinessOperation()
An operation applied to the product, for manufacturing or adminsitrative purpose.- Returns:
- An unmodifiable list containing immutable objects of type
MedicinalProduct.ManufacturingBusinessOperation
that may be empty.
-
getSpecialDesignation
public List<MedicinalProduct.SpecialDesignation> getSpecialDesignation()
Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.- Returns:
- An unmodifiable list containing immutable objects of type
MedicinalProduct.SpecialDesignation
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
toBuilder
public MedicinalProduct.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static MedicinalProduct.Builder builder()
-
-