Data Model Libraries
    Preparing search index...

    ValueSetExpansionContainsComponent Class

    FHIR Specification

    • Short: Codes in the value set
    • Definition: The codes that are contained in the value set expansion.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    system?: UriType

    ValueSet.expansion.contains.system Element

    FHIR Specification

    • Short: System value for the code
    • Definition: An absolute URI which is the code system in which the code for this item in the expansion is defined.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    abstract_?: BooleanType

    ValueSet.expansion.contains.abstract Element

    FHIR Specification

    • Short: If user cannot select this entry
    • Definition: If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.
    • Comment: This should not be understood to exclude its use for searching (e.g. by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    inactive?: BooleanType

    ValueSet.expansion.contains.inactive Element

    FHIR Specification

    • Short: If concept is inactive in the code system
    • Definition: If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use).
    • Comment: This should only have a value if the concept is inactive.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    version?: StringType

    ValueSet.expansion.contains.version Element

    FHIR Specification

    • Short: Version in which this code/display is defined
    • Definition: The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
    • Comment: The exact value of the version string is specified by the system from which the code is derived.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    code?: CodeType

    ValueSet.expansion.contains.code Element

    FHIR Specification

    • Short: Code - if blank, this is not a selectable code
    • Definition: The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    display?: StringType

    ValueSet.expansion.contains.display Element

    FHIR Specification

    • Short: User display for the concept
    • Definition: The recommended display for this item in the expansion.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ValueSet.expansion.contains.designation Element

    FHIR Specification

    • Short: Additional representations for this item
    • Definition: Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.
    • Comment: The designations provided must be based on the value set and code system definitions.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    ValueSet.expansion.contains.contains Element

    FHIR Specification

    • Short: Codes contained under this entry
    • Definition: Other codes and entries contained under this entry in the hierarchy.
    • Comment: If the expansion uses this element, there is no implication about the logical relationship between them, and the structure cannot be used for logical inferencing. The structure exists to provide navigational assistance for helping human users to locate codes in the expansion.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ValueSetExpansionContainsComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ValueSetExpansionContainsComponent

      ValueSetExpansionContainsComponent data model or undefined for ValueSetExpansionContainsComponent

      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