Skip to main content

HS.FHIRModel.R4.MedicinalProduct

class HS.FHIRModel.R4.MedicinalProduct extends HS.FHIRModel.FHIRClassSuper

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

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_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 _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _specialMeasures as HS.FHIRModel.R4.SeqOfElement;
Extensions for specialMeasures
Property methods: _specialMeasuresGet(), _specialMeasuresGetSwizzled(), _specialMeasuresIsValid(), _specialMeasuresNewObject(), _specialMeasuresSet()
property additionalMonitoringIndicator as HS.FHIRModel.R4.CodeableConcept;
Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.
Property methods: additionalMonitoringIndicatorGet(), additionalMonitoringIndicatorGetSwizzled(), additionalMonitoringIndicatorIsValid(), additionalMonitoringIndicatorNewObject(), additionalMonitoringIndicatorSet()
property attachedDocument as HS.FHIRModel.R4.SeqOfReference;
Supporting documentation, typically for regulatory submission.
Property methods: attachedDocumentGet(), attachedDocumentGetSwizzled(), attachedDocumentIsValid(), attachedDocumentNewObject(), attachedDocumentSet()
property clinicalTrial as HS.FHIRModel.R4.SeqOfReference;
Clinical trials or studies that this product is involved in.
Property methods: clinicalTrialGet(), clinicalTrialGetSwizzled(), clinicalTrialIsValid(), clinicalTrialNewObject(), clinicalTrialSet()
property combinedPharmaceuticalDoseForm as HS.FHIRModel.R4.CodeableConcept;
The dose form for a single part product, or combined form of a multiple part product.
Property methods: combinedPharmaceuticalDoseFormGet(), combinedPharmaceuticalDoseFormGetSwizzled(), combinedPharmaceuticalDoseFormIsValid(), combinedPharmaceuticalDoseFormNewObject(), combinedPharmaceuticalDoseFormSet()
property contact as HS.FHIRModel.R4.SeqOfReference;
A product specific contact, person (in a role), or an organization.
Property methods: contactGet(), contactGetSwizzled(), contactIsValid(), contactNewObject(), contactSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property crossReference as HS.FHIRModel.R4.SeqOfIdentifier;
Reference to another product, e.g. for linking authorised to investigational product.
Property methods: crossReferenceGet(), crossReferenceGetSwizzled(), crossReferenceIsValid(), crossReferenceNewObject(), crossReferenceSet()
property domain as HS.FHIRModel.R4.Coding;
If this medicine applies to human or veterinary uses.
Property methods: domainGet(), domainGetSwizzled(), domainIsValid(), domainNewObject(), domainSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Business identifier for this product. Could be an MPID.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property legalStatusOfSupply as HS.FHIRModel.R4.CodeableConcept;
The legal status of supply of the medicinal product as classified by the regulator.
Property methods: legalStatusOfSupplyGet(), legalStatusOfSupplyGetSwizzled(), legalStatusOfSupplyIsValid(), legalStatusOfSupplyNewObject(), legalStatusOfSupplySet()
An operation applied to the product, for manufacturing or adminsitrative purpose.
Property methods: manufacturingBusinessOperationGet(), manufacturingBusinessOperationGetSwizzled(), manufacturingBusinessOperationIsValid(), manufacturingBusinessOperationNewObject(), manufacturingBusinessOperationSet()
property marketingStatus as HS.FHIRModel.R4.SeqOfMarketingStatus;
Marketing status of the medicinal product, in contrast to marketing authorizaton.
Property methods: marketingStatusGet(), marketingStatusGetSwizzled(), marketingStatusIsValid(), marketingStatusNewObject(), marketingStatusSet()
property masterFile as HS.FHIRModel.R4.SeqOfReference;
A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).
Property methods: masterFileGet(), masterFileGetSwizzled(), masterFileIsValid(), masterFileNewObject(), masterFileSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
The product's name, including full name and possibly coded parts.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property packagedMedicinalProduct as HS.FHIRModel.R4.SeqOfReference;
Package representation for the product.
Property methods: packagedMedicinalProductGet(), packagedMedicinalProductGetSwizzled(), packagedMedicinalProductIsValid(), packagedMedicinalProductNewObject(), packagedMedicinalProductSet()
property paediatricUseIndicator as HS.FHIRModel.R4.CodeableConcept;
If authorised for use in children.
Property methods: paediatricUseIndicatorGet(), paediatricUseIndicatorGetSwizzled(), paediatricUseIndicatorIsValid(), paediatricUseIndicatorNewObject(), paediatricUseIndicatorSet()
property pharmaceuticalProduct as HS.FHIRModel.R4.SeqOfReference;
Pharmaceutical aspects of product.
Property methods: pharmaceuticalProductGet(), pharmaceuticalProductGetSwizzled(), pharmaceuticalProductIsValid(), pharmaceuticalProductNewObject(), pharmaceuticalProductSet()
property productClassification as HS.FHIRModel.R4.SeqOfCodeableConcept;
Allows the product to be classified by various systems.
Property methods: productClassificationGet(), productClassificationGetSwizzled(), productClassificationIsValid(), productClassificationNewObject(), productClassificationSet()
property resourceType as %String [ InitialExpression = "MedicinalProduct" , Required ];
This is a MedicinalProduct resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.
Property methods: specialDesignationGet(), specialDesignationGetSwizzled(), specialDesignationIsValid(), specialDesignationNewObject(), specialDesignationSet()
property specialMeasures as HS.FHIRModel.R4.SeqOfString;
Whether the Medicinal Product is subject to special measures for regulatory reasons.
Property methods: specialMeasuresGet(), specialMeasuresGetSwizzled(), specialMeasuresIsValid(), specialMeasuresNewObject(), specialMeasuresSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
Regulatory type, e.g. Investigational or Authorized.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

method IncludeAdditionalMonitoringIndicator()
method IncludeAttachedDocument()
method IncludeClinicalTrial()
method IncludeCombinedPharmaceuticalDoseForm()
method IncludeContact()
method IncludeContained()
method IncludeCrossReference()
method IncludeDomain()
method IncludeExtension()
method IncludeIdentifier()
method IncludeLegalStatusOfSupply()
method IncludeManufacturingBusinessOperation()
method IncludeMarketingStatus()
method IncludeMasterFile()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeName()
method IncludePackagedMedicinalProduct()
method IncludePaediatricUseIndicator()
method IncludePharmaceuticalProduct()
method IncludeProductClassification()
method IncludeSpecialDesignation()
method IncludeSpecialMeasures()
method IncludeText()
method IncludeType()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab