Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.MedicinalProduct

class HS.FHIR.DTL.vR4.Model.Resource.MedicinalProduct extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use)

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = MedicinalProduct;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = MedicinalProduct;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property additionalMonitoringIndicator as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "additionalMonitoringIndicator", XMLPROJECTION = "ELEMENT");
CodeableConcept

Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.

any FHIR4 code from any ValueSet may be used.

Property methods: additionalMonitoringIndicatorGet(), additionalMonitoringIndicatorGetSwizzled(), additionalMonitoringIndicatorIsValid(), additionalMonitoringIndicatorNewObject(), additionalMonitoringIndicatorSet()
property attachedDocument as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "attachedDocument", XMLPROJECTION = "ELEMENT");
Reference

Supporting documentation, typically for regulatory submission.

DocumentReference

Property methods: attachedDocumentBuildValueArray(), attachedDocumentCollectionToDisplay(), attachedDocumentCollectionToOdbc(), attachedDocumentDisplayToCollection(), attachedDocumentGet(), attachedDocumentGetObject(), attachedDocumentGetObjectId(), attachedDocumentGetSwizzled(), attachedDocumentIsValid(), attachedDocumentOdbcToCollection(), attachedDocumentSet(), attachedDocumentSetObject(), attachedDocumentSetObjectId()
property clinicalTrial as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "clinicalTrial", XMLPROJECTION = "ELEMENT");
Reference

Clinical trials or studies that this product is involved in.

ResearchStudy

Property methods: clinicalTrialBuildValueArray(), clinicalTrialCollectionToDisplay(), clinicalTrialCollectionToOdbc(), clinicalTrialDisplayToCollection(), clinicalTrialGet(), clinicalTrialGetObject(), clinicalTrialGetObjectId(), clinicalTrialGetSwizzled(), clinicalTrialIsValid(), clinicalTrialOdbcToCollection(), clinicalTrialSet(), clinicalTrialSetObject(), clinicalTrialSetObjectId()
property combinedPharmaceuticalDoseForm as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "combinedPharmaceuticalDoseForm", XMLPROJECTION = "ELEMENT");
CodeableConcept

The dose form for a single part product, or combined form of a multiple part product.

any FHIR4 code from any ValueSet may be used.

Property methods: combinedPharmaceuticalDoseFormGet(), combinedPharmaceuticalDoseFormGetSwizzled(), combinedPharmaceuticalDoseFormIsValid(), combinedPharmaceuticalDoseFormNewObject(), combinedPharmaceuticalDoseFormSet()
property contact as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
Reference

A product specific contact, person (in a role), or an organization.

Organization | PractitionerRole

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property crossReference as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "crossReference", XMLPROJECTION = "ELEMENT");
Identifier

Reference to another product, e.g. for linking authorised to investigational product.

Property methods: crossReferenceBuildValueArray(), crossReferenceCollectionToDisplay(), crossReferenceCollectionToOdbc(), crossReferenceDisplayToCollection(), crossReferenceGet(), crossReferenceGetObject(), crossReferenceGetObjectId(), crossReferenceGetSwizzled(), crossReferenceIsValid(), crossReferenceOdbcToCollection(), crossReferenceSet(), crossReferenceSetObject(), crossReferenceSetObjectId()
property domain as HS.FHIR.DTL.vR4.Model.Datatype.Coding (XMLNAME = "domain", XMLPROJECTION = "ELEMENT");
Coding

If this medicine applies to human or veterinary uses.

any FHIR4 code from any ValueSet may be used.

Property methods: domainGet(), domainGetSwizzled(), domainIsValid(), domainNewObject(), domainSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Business identifier for this product. Could be an MPID.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property legalStatusOfSupply as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "legalStatusOfSupply", XMLPROJECTION = "ELEMENT");
CodeableConcept

The legal status of supply of the medicinal product as classified by the regulator.

any FHIR4 code from any ValueSet may be used.

Property methods: legalStatusOfSupplyGet(), legalStatusOfSupplyGetSwizzled(), legalStatusOfSupplyIsValid(), legalStatusOfSupplyNewObject(), legalStatusOfSupplySet()
property manufacturingBusinessOperation as list of HS.FHIR.DTL.vR4.Model.Element.MedicinalProduct.manufacturingBusinessOperation (XMLNAME = "manufacturingBusinessOperation", XMLPROJECTION = "ELEMENT");
BackboneElement

An operation applied to the product, for manufacturing or adminsitrative purpose.

Property methods: manufacturingBusinessOperationBuildValueArray(), manufacturingBusinessOperationCollectionToDisplay(), manufacturingBusinessOperationCollectionToOdbc(), manufacturingBusinessOperationDisplayToCollection(), manufacturingBusinessOperationGet(), manufacturingBusinessOperationGetObject(), manufacturingBusinessOperationGetObjectId(), manufacturingBusinessOperationGetSwizzled(), manufacturingBusinessOperationIsValid(), manufacturingBusinessOperationOdbcToCollection(), manufacturingBusinessOperationSet(), manufacturingBusinessOperationSetObject(), manufacturingBusinessOperationSetObjectId()
property marketingStatus as list of HS.FHIR.DTL.vR4.Model.Datatype.MarketingStatus (XMLNAME = "marketingStatus", XMLPROJECTION = "ELEMENT");
MarketingStatus

Marketing status of the medicinal product, in contrast to marketing authorizaton.

Property methods: marketingStatusBuildValueArray(), marketingStatusCollectionToDisplay(), marketingStatusCollectionToOdbc(), marketingStatusDisplayToCollection(), marketingStatusGet(), marketingStatusGetObject(), marketingStatusGetObjectId(), marketingStatusGetSwizzled(), marketingStatusIsValid(), marketingStatusOdbcToCollection(), marketingStatusSet(), marketingStatusSetObject(), marketingStatusSetObjectId()
property masterFile as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "masterFile", XMLPROJECTION = "ELEMENT");
Reference

A master file for to the medicinal product (e.g. Pharmacovigilance System Master File)

DocumentReference

Property methods: masterFileBuildValueArray(), masterFileCollectionToDisplay(), masterFileCollectionToOdbc(), masterFileDisplayToCollection(), masterFileGet(), masterFileGetObject(), masterFileGetObjectId(), masterFileGetSwizzled(), masterFileIsValid(), masterFileOdbcToCollection(), masterFileSet(), masterFileSetObject(), masterFileSetObjectId()
property name as list of HS.FHIR.DTL.vR4.Model.Element.MedicinalProduct.name (XMLNAME = "name", XMLPROJECTION = "ELEMENT") [ Required ];
BackboneElement

The product's name, including full name and possibly coded parts.

Property methods: nameBuildValueArray(), nameCollectionToDisplay(), nameCollectionToOdbc(), nameDisplayToCollection(), nameGet(), nameGetObject(), nameGetObjectId(), nameGetSwizzled(), nameIsValid(), nameOdbcToCollection(), nameSet(), nameSetObject(), nameSetObjectId()
property packagedMedicinalProduct as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "packagedMedicinalProduct", XMLPROJECTION = "ELEMENT");
Reference

Package representation for the product.

MedicinalProductPackaged

Property methods: packagedMedicinalProductBuildValueArray(), packagedMedicinalProductCollectionToDisplay(), packagedMedicinalProductCollectionToOdbc(), packagedMedicinalProductDisplayToCollection(), packagedMedicinalProductGet(), packagedMedicinalProductGetObject(), packagedMedicinalProductGetObjectId(), packagedMedicinalProductGetSwizzled(), packagedMedicinalProductIsValid(), packagedMedicinalProductOdbcToCollection(), packagedMedicinalProductSet(), packagedMedicinalProductSetObject(), packagedMedicinalProductSetObjectId()
property paediatricUseIndicator as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "paediatricUseIndicator", XMLPROJECTION = "ELEMENT");
CodeableConcept

If authorised for use in children.

any FHIR4 code from any ValueSet may be used.

Property methods: paediatricUseIndicatorGet(), paediatricUseIndicatorGetSwizzled(), paediatricUseIndicatorIsValid(), paediatricUseIndicatorNewObject(), paediatricUseIndicatorSet()
property pharmaceuticalProduct as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "pharmaceuticalProduct", XMLPROJECTION = "ELEMENT");
Reference

Pharmaceutical aspects of product.

MedicinalProductPharmaceutical

Property methods: pharmaceuticalProductBuildValueArray(), pharmaceuticalProductCollectionToDisplay(), pharmaceuticalProductCollectionToOdbc(), pharmaceuticalProductDisplayToCollection(), pharmaceuticalProductGet(), pharmaceuticalProductGetObject(), pharmaceuticalProductGetObjectId(), pharmaceuticalProductGetSwizzled(), pharmaceuticalProductIsValid(), pharmaceuticalProductOdbcToCollection(), pharmaceuticalProductSet(), pharmaceuticalProductSetObject(), pharmaceuticalProductSetObjectId()
property productClassification as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "productClassification", XMLPROJECTION = "ELEMENT");
CodeableConcept

Allows the product to be classified by various systems.

any FHIR4 code from any ValueSet may be used.

Property methods: productClassificationBuildValueArray(), productClassificationCollectionToDisplay(), productClassificationCollectionToOdbc(), productClassificationDisplayToCollection(), productClassificationGet(), productClassificationGetObject(), productClassificationGetObjectId(), productClassificationGetSwizzled(), productClassificationIsValid(), productClassificationOdbcToCollection(), productClassificationSet(), productClassificationSetObject(), productClassificationSetObjectId()
property specialDesignation as list of HS.FHIR.DTL.vR4.Model.Element.MedicinalProduct.specialDesignation (XMLNAME = "specialDesignation", XMLPROJECTION = "ELEMENT");
BackboneElement

Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.

Property methods: specialDesignationBuildValueArray(), specialDesignationCollectionToDisplay(), specialDesignationCollectionToOdbc(), specialDesignationDisplayToCollection(), specialDesignationGet(), specialDesignationGetObject(), specialDesignationGetObjectId(), specialDesignationGetSwizzled(), specialDesignationIsValid(), specialDesignationOdbcToCollection(), specialDesignationSet(), specialDesignationSetObject(), specialDesignationSetObjectId()
property specialMeasures as list of %String (MAXLEN = 1000000, XMLNAME = "specialMeasures", XMLPROJECTION = "ELEMENT");
string

Whether the Medicinal Product is subject to special measures for regulatory reasons.

Property methods: specialMeasuresBuildValueArray(), specialMeasuresCollectionToDisplay(), specialMeasuresCollectionToOdbc(), specialMeasuresDisplayToCollection(), specialMeasuresDisplayToLogical(), specialMeasuresGet(), specialMeasuresGetObject(), specialMeasuresGetObjectId(), specialMeasuresGetSwizzled(), specialMeasuresIsValid(), specialMeasuresLogicalToDisplay(), specialMeasuresLogicalToOdbc(), specialMeasuresNormalize(), specialMeasuresOdbcToCollection(), specialMeasuresSet(), specialMeasuresSetObject(), specialMeasuresSetObjectId()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

Regulatory type, e.g. Investigational or Authorized.

any FHIR4 code from any ValueSet may be used.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab