Data Model Libraries
    Preparing search index...

    Class ValueSetComposeIncludeConceptComponent

    ValueSetComposeIncludeConceptComponent Class

    FHIR Specification

    • Short: A concept defined in the system
    • Definition: Specifies a concept to be included or excluded.
    • Comment: The list of concepts is considered ordered, though the order might not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | CodeType

    ValueSet.compose.include.concept.code Element

    FHIR Specification

    • Short: Code or expression from system
    • Definition: Specifies a code for the concept to be included or excluded.
    • Comment: Expressions are allowed if defined by the underlying code system.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    display?: StringType

    ValueSet.compose.include.concept.display Element

    FHIR Specification

    • Short: Text to display for this code for this value set in this valueset
    • Definition: The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.
    • Comment: The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ValueSet.compose.include.concept.designation Element

    FHIR Specification

    • Short: Additional representations for this concept
    • Definition: Additional representations for this concept when used in this value set - 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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ValueSetComposeIncludeConceptComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ValueSetComposeIncludeConceptComponent

      ValueSetComposeIncludeConceptComponent data model or undefined for ValueSetComposeIncludeConceptComponent

      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