Data Model Libraries
    Preparing search index...

    Class MedicinalProduct

    MedicinalProduct Class

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

    FHIR Specification

    • Short: Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use)
    • Definition: Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).
    • FHIR Version: 4.0.1

    FHIR MedicinalProduct

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? type_? domain? combinedPharmaceuticalDoseForm? legalStatusOfSupply? additionalMonitoringIndicator? specialMeasures? paediatricUseIndicator? productClassification? marketingStatus? pharmaceuticalProduct? packagedMedicinalProduct? attachedDocument? masterFile? contact? clinicalTrial? name crossReference? manufacturingBusinessOperation? specialDesignation?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getType setType hasType getDomain setDomain hasDomain getCombinedPharmaceuticalDoseForm setCombinedPharmaceuticalDoseForm hasCombinedPharmaceuticalDoseForm getLegalStatusOfSupply setLegalStatusOfSupply hasLegalStatusOfSupply getAdditionalMonitoringIndicator setAdditionalMonitoringIndicator hasAdditionalMonitoringIndicator getSpecialMeasuresElement setSpecialMeasuresElement addSpecialMeasuresElement hasSpecialMeasuresElement getSpecialMeasures setSpecialMeasures addSpecialMeasures hasSpecialMeasures getPaediatricUseIndicator setPaediatricUseIndicator hasPaediatricUseIndicator getProductClassification setProductClassification addProductClassification hasProductClassification getMarketingStatus setMarketingStatus addMarketingStatus hasMarketingStatus getPharmaceuticalProduct setPharmaceuticalProduct addPharmaceuticalProduct hasPharmaceuticalProduct getPackagedMedicinalProduct setPackagedMedicinalProduct addPackagedMedicinalProduct hasPackagedMedicinalProduct getAttachedDocument setAttachedDocument addAttachedDocument hasAttachedDocument getMasterFile setMasterFile addMasterFile hasMasterFile getContact setContact addContact hasContact getClinicalTrial setClinicalTrial addClinicalTrial hasClinicalTrial getName setName addName hasName getCrossReference setCrossReference addCrossReference hasCrossReference getManufacturingBusinessOperation setManufacturingBusinessOperation addManufacturingBusinessOperation hasManufacturingBusinessOperation getSpecialDesignation setSpecialDesignation addSpecialDesignation hasSpecialDesignation fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initSpecialMeasures initProductClassification initMarketingStatus initPharmaceuticalProduct initPackagedMedicinalProduct initAttachedDocument initMasterFile initContact initClinicalTrial initName initCrossReference initManufacturingBusinessOperation initSpecialDesignation

    Constructors

    Properties

    identifier?: Identifier[]

    MedicinalProduct.identifier Element

    FHIR Specification

    • Short: Business identifier for this product. Could be an MPID
    • Definition: Business identifier for this product. Could be an MPID.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Private Optionaltype_

    type_?: CodeableConcept

    MedicinalProduct.type Element

    FHIR Specification

    • Short: Regulatory type, e.g. Investigational or Authorized
    • Definition: Regulatory type, e.g. Investigational or Authorized.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    domain?: Coding

    MedicinalProduct.domain Element

    FHIR Specification

    • Short: If this medicine applies to human or veterinary uses
    • Definition: If this medicine applies to human or veterinary uses.
    • FHIR Type: Coding
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    combinedPharmaceuticalDoseForm?: CodeableConcept

    MedicinalProduct.combinedPharmaceuticalDoseForm Element

    FHIR Specification

    • Short: The dose form for a single part product, or combined form of a multiple part product
    • Definition: The dose form for a single part product, or combined form of a multiple part product.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    legalStatusOfSupply?: CodeableConcept

    MedicinalProduct.legalStatusOfSupply Element

    FHIR Specification

    • Short: The legal status of supply of the medicinal product as classified by the regulator
    • Definition: The legal status of supply of the medicinal product as classified by the regulator.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    additionalMonitoringIndicator?: CodeableConcept

    MedicinalProduct.additionalMonitoringIndicator Element

    FHIR Specification

    • Short: Whether the Medicinal Product is subject to additional monitoring for regulatory reasons
    • Definition: Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    specialMeasures?: StringType[]

    MedicinalProduct.specialMeasures Element

    FHIR Specification

    • Short: Whether the Medicinal Product is subject to special measures for regulatory reasons
    • Definition: Whether the Medicinal Product is subject to special measures for regulatory reasons.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    paediatricUseIndicator?: CodeableConcept

    MedicinalProduct.paediatricUseIndicator Element

    FHIR Specification

    • Short: If authorised for use in children
    • Definition: If authorised for use in children.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    productClassification?: CodeableConcept[]

    MedicinalProduct.productClassification Element

    FHIR Specification

    • Short: Allows the product to be classified by various systems
    • Definition: Allows the product to be classified by various systems.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    marketingStatus?: MarketingStatus[]

    MedicinalProduct.marketingStatus Element

    FHIR Specification

    • Short: Marketing status of the medicinal product, in contrast to marketing authorizaton
    • Definition: Marketing status of the medicinal product, in contrast to marketing authorizaton.
    • FHIR Type: MarketingStatus
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    pharmaceuticalProduct?: Reference[]

    MedicinalProduct.pharmaceuticalProduct Element

    FHIR Specification

    packagedMedicinalProduct?: Reference[]

    MedicinalProduct.packagedMedicinalProduct Element

    FHIR Specification

    attachedDocument?: Reference[]

    MedicinalProduct.attachedDocument Element

    FHIR Specification

    • Short: Supporting documentation, typically for regulatory submission
    • Definition: Supporting documentation, typically for regulatory submission.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    masterFile?: Reference[]

    MedicinalProduct.masterFile Element

    FHIR Specification

    • Short: A master file for to the medicinal product (e.g. Pharmacovigilance System Master File)
    • Definition: A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    contact?: Reference[]

    MedicinalProduct.contact Element

    FHIR Specification

    clinicalTrial?: Reference[]

    MedicinalProduct.clinicalTrial Element

    FHIR Specification

    • Short: Clinical trials or studies that this product is involved in
    • Definition: Clinical trials or studies that this product is involved in.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    name: null | MedicinalProductNameComponent[]

    MedicinalProduct.name Element

    FHIR Specification

    • Short: The product's name, including full name and possibly coded parts
    • Definition: The product's name, including full name and possibly coded parts.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: true
    crossReference?: Identifier[]

    MedicinalProduct.crossReference Element

    FHIR Specification

    • Short: Reference to another product, e.g. for linking authorised to investigational product
    • Definition: Reference to another product, e.g. for linking authorised to investigational product.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    manufacturingBusinessOperation?: MedicinalProductManufacturingBusinessOperationComponent[]

    MedicinalProduct.manufacturingBusinessOperation Element

    FHIR Specification

    • Short: An operation applied to the product, for manufacturing or adminsitrative purpose
    • Definition: An operation applied to the product, for manufacturing or adminsitrative purpose.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    specialDesignation?: MedicinalProductSpecialDesignationComponent[]

    MedicinalProduct.specialDesignation Element

    FHIR Specification

    • Short: Indicates if the medicinal product has an orphan designation for the treatment of a rare disease
    • Definition: Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided MedicinalProduct JSON to instantiate the MedicinalProduct data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicinalProduct

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to MedicinalProduct

      Returns undefined | MedicinalProduct

      MedicinalProduct data model or undefined for MedicinalProduct

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the pharmaceuticalProduct property.

      Parameters

      • value: undefined | Reference[]

        the pharmaceuticalProduct array value

      Returns this

      this

      @ReferenceTargets('MedicinalProduct.pharmaceuticalProduct', ['MedicinalProductPharmaceutical',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Reference array value to the packagedMedicinalProduct property.

      Parameters

      • value: undefined | Reference[]

        the packagedMedicinalProduct array value

      Returns this

      this

      @ReferenceTargets('MedicinalProduct.packagedMedicinalProduct', ['MedicinalProductPackaged',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetTypesetTypehasTypegetDomainsetDomainhasDomaingetCombinedPharmaceuticalDoseFormsetCombinedPharmaceuticalDoseFormhasCombinedPharmaceuticalDoseFormgetLegalStatusOfSupplysetLegalStatusOfSupplyhasLegalStatusOfSupplygetAdditionalMonitoringIndicatorsetAdditionalMonitoringIndicatorhasAdditionalMonitoringIndicatorgetSpecialMeasuresElementsetSpecialMeasuresElementaddSpecialMeasuresElementhasSpecialMeasuresElementgetSpecialMeasuressetSpecialMeasuresaddSpecialMeasureshasSpecialMeasuresgetPaediatricUseIndicatorsetPaediatricUseIndicatorhasPaediatricUseIndicatorgetProductClassificationsetProductClassificationaddProductClassificationhasProductClassificationgetMarketingStatussetMarketingStatusaddMarketingStatushasMarketingStatusgetPharmaceuticalProductsetPharmaceuticalProductaddPharmaceuticalProducthasPharmaceuticalProductgetPackagedMedicinalProductsetPackagedMedicinalProductaddPackagedMedicinalProducthasPackagedMedicinalProductgetAttachedDocumentsetAttachedDocumentaddAttachedDocumenthasAttachedDocumentgetMasterFilesetMasterFileaddMasterFilehasMasterFilegetContactsetContactaddContacthasContactgetClinicalTrialsetClinicalTrialaddClinicalTrialhasClinicalTrialgetNamesetNameaddNamehasNamegetCrossReferencesetCrossReferenceaddCrossReferencehasCrossReferencegetManufacturingBusinessOperationsetManufacturingBusinessOperationaddManufacturingBusinessOperationhasManufacturingBusinessOperationgetSpecialDesignationsetSpecialDesignationaddSpecialDesignationhasSpecialDesignationfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitSpecialMeasuresinitProductClassificationinitMarketingStatusinitPharmaceuticalProductinitPackagedMedicinalProductinitAttachedDocumentinitMasterFileinitContactinitClinicalTrialinitNameinitCrossReferenceinitManufacturingBusinessOperationinitSpecialDesignation