Data Model Libraries
    Preparing search index...

    CoverageCostToBeneficiaryComponent Class

    FHIR Specification

    • Short: Patient payments for services/products
    • Definition: A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.
    • Comment: For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.
    • Requirements: Required by providers to manage financial transaction with the patient.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Coverage.costToBeneficiary.type Element

    FHIR Specification

    • Short: Cost category
    • Definition: The category of patient centric costs associated with treatment.
    • Comment: For example visit, specialist visits, emergency, inpatient care, etc.
    • Requirements: Needed to identify the category associated with the amount for the patient.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    value: null | IDataType

    Coverage.costToBeneficiary.value[x] Element

    @ChoiceDataTypesMeta('Coverage.costToBeneficiary.value[x]', ['Quantity','Money',]

    FHIR Specification

    • Short: The amount or percentage due from the beneficiary
    • Definition: The amount due from the patient for the cost category.
    • Comment: Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.
    • Requirements: Needed to identify the amount for the patient associated with the category.
    • FHIR Types: 'Quantity', 'Money',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Coverage.costToBeneficiary.exception Element

    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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CoverageCostToBeneficiaryComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CoverageCostToBeneficiaryComponent

      CoverageCostToBeneficiaryComponent data model or undefined for CoverageCostToBeneficiaryComponent

      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