Data Model Libraries
    Preparing search index...

    ElementDefinitionBindingComponent Class

    FHIR Specification

    • Short: ValueSet details if this is coded
    • Definition: Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).
    • Comment: For a CodeableConcept, when no codes are allowed - only text, use a binding of strength "required" with a description explaining that no coded values are allowed and what sort of information to put in the "text" element.

    Hierarchy (View Summary)

    • DataType
      • ElementDefinitionBindingComponent

    Implements

    Index

    Constructors

    Properties

    bindingStrengthEnum: BindingStrengthEnum

    FHIR CodeSystem: BindingStrength

    strength: null | EnumCodeType

    ElementDefinition.binding.strength Element

    FHIR Specification

    • Short: required | extensible | preferred | example
    • Definition: Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.
    • Comment: For further discussion, see Using Terminologies.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: BindingStrengthEnum

    description?: StringType

    ElementDefinition.binding.description Element

    FHIR Specification

    • Short: Human explanation of the value set
    • Definition: Describes the intended use of this particular set of codes.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    valueSet?: CanonicalType

    ElementDefinition.binding.valueSet Element

    FHIR Specification

    • Short: Source of value set
    • Definition: Refers to the value set that identifies the set of codes the binding refers to.
    • Comment: The reference may be version-specific or not (e.g. have a |[version] at the end of the canonical URL).
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ElementDefinitionBindingComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ElementDefinitionBindingComponent

      ElementDefinitionBindingComponent data model or undefined for ElementDefinitionBindingComponent

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • 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

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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 resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise