Data Model Libraries
    Preparing search index...

    Class ElementDefinitionBindingAdditionalComponent

    ElementDefinitionBindingAdditionalComponent Class

    FHIR Specification

    • Short: Additional Bindings - more rules about the binding
    • Definition: Additional bindings that help applications implementing this element. Additional bindings do not replace the main binding but provide more information and/or context.

    Hierarchy (View Summary)

    • DataType
      • ElementDefinitionBindingAdditionalComponent

    Implements

    Index

    Constructors

    Properties

    additionalBindingPurposeEnum: AdditionalBindingPurposeEnum

    FHIR CodeSystem: AdditionalBindingPurpose

    purpose: null | EnumCodeType

    ElementDefinition.binding.additional.purpose Element

    FHIR Specification

    • Short: maximum | minimum | required | extensible | candidate | current | preferred | ui | starter | component
    • Definition: The use of this additional binding.
    • Comment: Conformance bindings are in addition to the base binding, not instead of it.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: AdditionalBindingPurposeEnum

    valueSet: null | CanonicalType

    ElementDefinition.binding.additional.valueSet Element

    FHIR Specification

    • Short: The value set for the additional binding
    • Definition: The valueSet that is being bound for the purpose.
    • FHIR Type: canonical
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    documentation?: MarkdownType

    ElementDefinition.binding.additional.documentation Element

    FHIR Specification

    • Short: Documentation of the purpose of use of the binding
    • Definition: Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    shortDoco?: StringType

    ElementDefinition.binding.additional.shortDoco Element

    FHIR Specification

    • Short: Concise documentation - for summary tables
    • Definition: Concise documentation - for summary tables.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    usage?: UsageContext[]

    ElementDefinition.binding.additional.usage Element

    FHIR Specification

    • Short: Qualifies the usage - jurisdiction, gender, workflow status etc.
    • Definition: Qualifies the usage of the binding. Typically bindings are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.
    • Comment: This specification does not define exactly how the context is determined for the usage; typically, this will be described in implementation guides.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    ElementDefinition.binding.additional.any Element

    FHIR Specification

    • Short: Whether binding can applies to all repeats, or just one
    • Definition: Whether the binding applies to all repeats, or just to any one of them. This is only relevant for elements that can repeat.
    • Comment: A common pattern is to make a conformance binding to all repeats, and then make a binding that one of the repeats must conform to.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ElementDefinitionBindingAdditionalComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ElementDefinitionBindingAdditionalComponent

      ElementDefinitionBindingAdditionalComponent data model or undefined for ElementDefinitionBindingAdditionalComponent

      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