Data Model Libraries
    Preparing search index...

    CodeSystemConceptComponent Class

    FHIR Specification

    • Short: Concepts in the code system
    • Definition: Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.
    • Comment: If this is empty, it means that the code system resource does not represent the content of the code system.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | CodeType

    CodeSystem.concept.code Element

    FHIR Specification

    • Short: Code that identifies concept
    • Definition: A code - a text symbol - that uniquely identifies the concept within the code system.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    display?: StringType

    CodeSystem.concept.display Element

    FHIR Specification

    • Short: Text to display to the user
    • Definition: A human readable string that is the recommended default way to present this concept to a user.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    definition?: StringType

    CodeSystem.concept.definition Element

    FHIR Specification

    • Short: Formal definition
    • Definition: The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem.concept.designation Element

    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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    CodeSystem.concept.property Element

    FHIR Specification

    • Short: Property value for the concept
    • Definition: A property value for this concept.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    CodeSystem.concept.concept Element

    FHIR Specification

    • Short: Child Concepts (is-a/contains/categorizes)
    • Definition: Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CodeSystemConceptComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CodeSystemConceptComponent

      CodeSystemConceptComponent data model or undefined for CodeSystemConceptComponent

      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