Data Model Libraries
    Preparing search index...

    SubstanceDefinitionCodeComponent Class

    FHIR Specification

    • Short: Codes associated with the substance
    • Definition: Codes associated with the substance.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    SubstanceDefinition.code.code Element

    FHIR Specification

    • Short: The specific code
    • Definition: The specific code.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    SubstanceDefinition.code.status Element

    FHIR Specification

    • Short: Status of the code assignment, for example 'provisional', 'approved'
    • Definition: Status of the code assignment, for example 'provisional', 'approved'.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    statusDate?: DateTimeType

    SubstanceDefinition.code.statusDate Element

    FHIR Specification

    • Short: The date at which the code status was changed
    • Definition: The date at which the code status was changed as part of the terminology maintenance.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    note?: Annotation[]

    SubstanceDefinition.code.note Element

    FHIR Specification

    • Short: Any comment can be provided in this field
    • Definition: Any comment can be provided in this field, if necessary.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    source?: Reference[]

    SubstanceDefinition.code.source Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR SubstanceDefinitionCodeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | SubstanceDefinitionCodeComponent

      SubstanceDefinitionCodeComponent data model or undefined for SubstanceDefinitionCodeComponent

      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