Data Model Libraries
    Preparing search index...

    Class CoverageEligibilityResponseInsuranceItemBenefitComponent

    CoverageEligibilityResponseInsuranceItemBenefitComponent Class

    FHIR Specification

    • Short: Benefit Summary
    • Definition: Benefits used to date.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    type_: null | CodeableConcept

    CoverageEligibilityResponse.insurance.item.benefit.type Element

    FHIR Specification

    • Short: Benefit classification
    • Definition: Classification of benefit being provided.
    • Comment: For example: deductible, visits, benefit amount.
    • Requirements: Needed to convey the nature of the benefit.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    allowed?: IDataType

    CoverageEligibilityResponse.insurance.item.benefit.allowed[x] Element

    @ChoiceDataTypesMeta('CoverageEligibilityResponse.insurance.item.benefit.allowed[x]', ['unsignedInt','string','Money',]

    FHIR Specification

    • Short: Benefits allowed
    • Definition: The quantity of the benefit which is permitted under the coverage.
    • Requirements: Needed to convey the benefits offered under the coverage.
    • FHIR Types: 'unsignedInt', 'string', 'Money',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    used?: IDataType

    CoverageEligibilityResponse.insurance.item.benefit.used[x] Element

    @ChoiceDataTypesMeta('CoverageEligibilityResponse.insurance.item.benefit.used[x]', ['unsignedInt','string','Money',]

    FHIR Specification

    • Short: Benefits used
    • Definition: The quantity of the benefit which have been consumed to date.
    • Requirements: Needed to convey the benefits consumed to date.
    • FHIR Types: 'unsignedInt', 'string', 'Money',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • 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