Data Model Libraries
    Preparing search index...

    Class CodeSystemConceptDesignationComponent

    CodeSystemConceptDesignationComponent Class

    FHIR Specification

    • Short: Additional representations for the concept
    • Definition: Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.
    • Comment: Concepts have both a display and an array of designation. The display is equivalent to a special designation with an implied designation.use of "primary code" and a language equal to the Resource Language.
    • Requirements: Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    language?: CodeType

    CodeSystem.concept.designation.language Element

    FHIR Specification

    • Short: Human language of the designation
    • Definition: The language this designation is defined for.
    • Comment: In the absence of a language, the resource language applies.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    use?: Coding

    CodeSystem.concept.designation.use Element

    FHIR Specification

    • Short: Details how this designation would be used
    • Definition: A code that details how this designation would be used.
    • Comment: If no use is provided, the designation can be assumed to be suitable for general display to a human user.
    • FHIR Type: Coding
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    value: null | StringType

    CodeSystem.concept.designation.value Element

    FHIR Specification

    • Short: The text value for this designation
    • Definition: The text value for this designation.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CodeSystemConceptDesignationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CodeSystemConceptDesignationComponent

      CodeSystemConceptDesignationComponent data model or undefined for CodeSystemConceptDesignationComponent

      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