Data Model Libraries
    Preparing search index...

    Class CoverageCostToBeneficiaryComponent

    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.

    FHIR Coverage

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    type_? category? network? unit? term? value? exception?

    Methods

    parse getType setType hasType getCategory setCategory hasCategory getNetwork setNetwork hasNetwork getUnit setUnit hasUnit getTerm setTerm hasTerm getValue setValue hasValue getValueQuantity hasValueQuantity getValueMoney hasValueMoney getException setException addException hasException fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initException

    Constructors

    Properties

    Private Optionaltype_

    type_?: CodeableConcept

    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
    category?: CodeableConcept

    Coverage.costToBeneficiary.category Element

    FHIR Specification

    • Short: Benefit classification
    • Definition: Code to identify the general type of benefits under which products and services are provided.
    • Comment: Examples include Medical Care, Periodontics, Renal Dialysis, Vision Coverage.
    • Requirements: Needed to convey the category of service or product for which eligibility is sought.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    network?: CodeableConcept

    Coverage.costToBeneficiary.network Element

    FHIR Specification

    • Short: In or out of network
    • Definition: Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers.
    • Requirements: Needed as in or out of network providers are treated differently under the coverage.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    unit?: CodeableConcept

    Coverage.costToBeneficiary.unit Element

    FHIR Specification

    • Short: Individual or family
    • Definition: Indicates if the benefits apply to an individual or to the family.
    • Requirements: Needed for the understanding of the benefits.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    term?: CodeableConcept

    Coverage.costToBeneficiary.term Element

    FHIR Specification

    • Short: Annual or lifetime
    • Definition: The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'.
    • Requirements: Needed for the understanding of the benefits.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    value?: 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: 0..1
    • isModifier: false
    • isSummary: true
    exception?: CoverageCostToBeneficiaryExceptionComponent[]

    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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods