Data Model Libraries
    Preparing search index...

    Class CoverageCostToBeneficiaryExceptionComponent

    CoverageCostToBeneficiaryExceptionComponent Class

    FHIR Specification

    • Short: Exceptions for patient payments
    • Definition: A suite of codes indicating exceptions or reductions to patient costs and their effective periods.
    • Requirements: Required by providers to manage financial transaction with the patient.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    type_: null | CodeableConcept

    Coverage.costToBeneficiary.exception.type Element

    FHIR Specification

    • Short: Exception category
    • Definition: The code for the specific exception.
    • Requirements: Needed to identify the exception associated with the amount for the patient.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    period?: Period

    Coverage.costToBeneficiary.exception.period Element

    FHIR Specification

    • Short: The effective period of the exception
    • Definition: The timeframe the exception is in force.
    • Requirements: Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CoverageCostToBeneficiaryExceptionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CoverageCostToBeneficiaryExceptionComponent

      CoverageCostToBeneficiaryExceptionComponent data model or undefined for CoverageCostToBeneficiaryExceptionComponent

      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