Data Model Libraries
    Preparing search index...

    Class SubstanceSpecificationNameOfficialComponent

    SubstanceSpecificationNameOfficialComponent Class

    FHIR Specification

    • Short: Details of the official nature of this name
    • Definition: Details of the official nature of this name.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    authority?: CodeableConcept

    SubstanceSpecification.name.official.authority Element

    FHIR Specification

    • Short: Which authority uses this official name
    • Definition: Which authority uses this official name.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceSpecification.name.official.status Element

    FHIR Specification

    • Short: The status of the official name
    • Definition: The status of the official name.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceSpecification.name.official.date Element

    FHIR Specification

    • Short: Date of official name change
    • Definition: Date of official name change.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubstanceSpecificationNameOfficialComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubstanceSpecificationNameOfficialComponent

      SubstanceSpecificationNameOfficialComponent data model or undefined for SubstanceSpecificationNameOfficialComponent

      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