Data Model Libraries
    Preparing search index...

    Class MedicinalProductSpecialDesignationComponent

    MedicinalProductSpecialDesignationComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    identifier?: Identifier[]

    MedicinalProduct.specialDesignation.identifier Element

    FHIR Specification

    • Short: Identifier for the designation, or procedure number
    • Definition: Identifier for the designation, or procedure number.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    MedicinalProduct.specialDesignation.type Element

    FHIR Specification

    • Short: The type of special designation, e.g. orphan drug, minor use
    • Definition: The type of special designation, e.g. orphan drug, minor use.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    intendedUse?: CodeableConcept

    MedicinalProduct.specialDesignation.intendedUse Element

    FHIR Specification

    • Short: The intended use of the product, e.g. prevention, treatment
    • Definition: The intended use of the product, e.g. prevention, treatment.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    indication?: IDataType

    MedicinalProduct.specialDesignation.indication[x] Element

    @ChoiceDataTypesMeta('MedicinalProduct.specialDesignation.indication[x]', ['CodeableConcept','Reference',]

    FHIR Specification

    • Short: Condition for which the medicinal use applies
    • Definition: Condition for which the medicinal use applies.
    • FHIR Types: 'CodeableConcept', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    MedicinalProduct.specialDesignation.status Element

    FHIR Specification

    • Short: For example granted, pending, expired or withdrawn
    • Definition: For example granted, pending, expired or withdrawn.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    MedicinalProduct.specialDesignation.date Element

    FHIR Specification

    • Short: Date when the designation was granted
    • Definition: Date when the designation was granted.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    species?: CodeableConcept

    MedicinalProduct.specialDesignation.species Element

    FHIR Specification

    • Short: Animal species for which this applies
    • Definition: Animal species for which this applies.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicinalProductSpecialDesignationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MedicinalProductSpecialDesignationComponent

      MedicinalProductSpecialDesignationComponent data model or undefined for MedicinalProductSpecialDesignationComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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; 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • 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

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having 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 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

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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