Data Model Libraries
    Preparing search index...

    ClaimResponseTotalComponent Class

    FHIR Specification

    • Short: Adjudication totals
    • Definition: Categorized monetary totals for the adjudication.
    • Comment: Totals for amounts submitted, co-pays, benefits payable etc.
    • Requirements: To provide the requestor with financial totals by category for the adjudication.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    category: null | CodeableConcept

    ClaimResponse.total.category Element

    FHIR Specification

    • Short: Type of adjudication information
    • Definition: A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item.
    • Comment: For example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.
    • Requirements: Needed to convey the type of total provided.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    amount: null | Money

    ClaimResponse.total.amount Element

    FHIR Specification

    • Short: Financial total for the category
    • Definition: Monetary total amount associated with the category.
    • Requirements: Needed to convey the total monetary amount.
    • FHIR Type: Money
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ClaimResponseTotalComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ClaimResponseTotalComponent

      ClaimResponseTotalComponent data model or undefined for ClaimResponseTotalComponent

      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