Data Model Libraries
    Preparing search index...

    Class ValueSetExpansionPropertyComponent

    ValueSetExpansionPropertyComponent Class

    FHIR Specification

    • Short: Additional information supplied about each concept
    • Definition: A property defines an additional slot through which additional information can be provided about a concept.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | CodeType

    ValueSet.expansion.property.code Element

    FHIR Specification

    • Short: Identifies the property on the concepts, and when referred to in operations
    • Definition: A code that is used to identify the property. The code is used in ValueSet.expansion.contains.property.code.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    uri?: UriType

    ValueSet.expansion.property.uri Element

    FHIR Specification

    • Short: Formal identifier for the property
    • Definition: Reference to the formal meaning of the property. One possible source of meaning is the Concept Properties code system.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ValueSetExpansionPropertyComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ValueSetExpansionPropertyComponent

      ValueSetExpansionPropertyComponent data model or undefined for ValueSetExpansionPropertyComponent

      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