Data Model Libraries
    Preparing search index...

    Class MedicinalProductDefinitionNameUsageComponent

    MedicinalProductDefinitionNameUsageComponent Class

    FHIR Specification

    • Short: Country and jurisdiction where the name applies
    • Definition: Country and jurisdiction where the name applies, and associated language.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    country: null | CodeableConcept

    MedicinalProductDefinition.name.usage.country Element

    FHIR Specification

    • Short: Country code for where this name applies
    • Definition: Country code for where this name applies.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    jurisdiction?: CodeableConcept

    MedicinalProductDefinition.name.usage.jurisdiction Element

    FHIR Specification

    • Short: Jurisdiction code for where this name applies
    • Definition: Jurisdiction code for where this name applies. A jurisdiction may be a sub- or supra-national entity (e.g. a state or a geographic region).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    language: null | CodeableConcept

    MedicinalProductDefinition.name.usage.language Element

    FHIR Specification

    • Short: Language code for this name
    • Definition: Language code for this name.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicinalProductDefinitionNameUsageComponent

      • OptionaloptSourceField: string

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

      Returns undefined | MedicinalProductDefinitionNameUsageComponent

      MedicinalProductDefinitionNameUsageComponent data model or undefined for MedicinalProductDefinitionNameUsageComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise