| EnrollEligCOB UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
This class contains data sent by a Payer in response to a Billing Event detailing the components and reasons for any payments made or not made.
Attributes | ||
«MO» MonetaryAmount | accumulatedDeductibleAmount |
"Amount in dollars met by the patient/family in a deductible plan." - NCPDP Telecommunication (Field 512-FC, Data Dictionary 201104). |
«MO» MonetaryAmount | amountAppliedToDeductible |
"Amount to be collected from a patient that is included in Patient Pay Amount that is applied to a periodic deductible." - NCPDP Telecommunication (Field 517-FH, Data Dictionary 201104). |
«MO» MonetaryAmount | amountAttributableToSalesTax |
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to sales tax paid." - NCPDP Telecommunication (Field 523-FN, Data Dictionary 201104). |
«MO» MonetaryAmount | amountAttributedToBrandNonFormularySelection |
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the patient’s selection of a Brand Non-Preferred Formulary product." - NCPDP Telecommunication (Field 136-UN, Data Dictionary 201104). |
«MO» MonetaryAmount | amountAttributedToBrandSelection |
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the patient’s selection of a Brand product." - NCPDP Telecommunication (Field 134-UK, Data Dictionary 201104). |
«MO» MonetaryAmount | amountAttributedToCoverageGap |
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the patient being in the coverage gap (for example Medicare Part D Coverage Gap (donut hole)). A coverage gap is defined as the period or amount during which the previous coverage ends and before an additional coverage begins." - NCPDP Telecommunication (Field 137-UP, Data Dictionary 201104). |
«MO» MonetaryAmount | amountAttributedToNonFormularySelection |
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the patient’s selection of a Non-Preferred Formulary product." - NCPDP Telecommunication (Field 135-UM, Data Dictionary 201104). |
«MO» MonetaryAmount | amountAttributedToProviderNetworkSelection |
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the patient’s provider network selection." - NCPDP Telecommunication (Field 133-UJ, Data Dictionary 201104). |
«MO» MonetaryAmount | amountExceedingBenefitMaximum |
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the patient exceeding a periodic benefit maximum." - NCPDP Telecommunication (Field 520-FK, Data Dictionary 201104). |
«MO» MonetaryAmount | amountOfCoinsurance |
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to a per prescription coinsurance." - NCPDP Telecommunication (Field 572-4U, Data Dictionary 201104). |
«MO» MonetaryAmount | amountOfCopay |
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to a per prescription copay." - NCPDP Telecommunication (Field 518-FI, Data Dictionary 201104). |
«MO» MonetaryAmount | amountOfProcessingFee |
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the processing fee imposed by the processor." - NCPDP Telecommunication (Field 571-NZ, Data Dictionary 201104). |
«CS» Code | basisOfCalculationCoInsurance |
"Code indicating how the Coinsurance reimbursement amount was calculated for Patient Pay Amount." - NCPDP Telecommunication (Field 573-4V, Data Dictionary 201104). Possible values include: Quantity Dispensed; Quantity Intended To Be Dispensed; Usual and Customary/Prorated; Waived Due To Partial Fill; Other. |
«CS» Code | basisOfCalculationCopay |
"Code indicating how the Copay reimbursement amount was calculated for Patient Pay Amount." - NCPDP Telecommunication (Field 347-HJ, Data Dictionary 201104). Possible values include: Quantity Dispensed; Quantity Intended To Be Dispensed; Usual and Customary/Prorated; Waived Due To Partial Fill; Other. |
«CS» Code | basisOfCalculationDispensingFee |
"Code indicating how the reimbursement amount was calculated for Dispensing Fee Paid" - NCPDP Telecommunication (Field 346-HH, Data Dictionary 201104). Possible values include: Quantity Dispensed; Quantity Intended To Be Dispensed; Usual and Customary/Prorated; Waived Due To Partial Fill; Other. |
«CS» Code | basisOfCalculationFlatSalesTax |
"Code indicating how the reimbursement amount was calculated for Flat Sales Tax Amount Paid" - NCPDP Telecommunication (Field 348-HK, Data Dictionary 201104). Possible values include: Quantity Dispensed; Quantity Intended To Be Dispensed. |
«CS» Code | basisOfCalculationPercentageSalesTax |
"Code indicating how the reimbursement amount was calculated for Percentage Sales Tax Amount Paid." - NCPDP Telecommunication (Field 349-HM, Data Dictionary 201104). Possible values include: Quantity Dispensed; Quantity Intended To Be Dispensed. |
«CS» Code | basisOfReimbursementDetermination |
"Code identifying how the reimbursement amount was calculated for "Ingredient Cost Paid." - NCPDP Telecommunication (Field 522-FM, Data Dictionary 201104). Possible values include: Default; AWP (Average Wholesale Price); Local Wholesaler; Direct; EAC (Estimated Acquisition Cost); Acquisition; MAC (Maximum Allowable Cost); Usual & Customary; 340B /Disproportionate Share Pricing/Public Health Service; ASP (Average Sales Price); AMP (Average Manufacturer Price); WAC (Wholesale Acquisition Cost); Special Patient Pricing; Other. |
BenefitStage | benefitStage |
Pointer to a record of the number and dollar amount of payments made in each Medicare Part D stage. |
Integer | benefitStageCount |
"Count of Benefit Stage Amount occurrences." - NCPDP Telecommunication (Field 392-MU, Data Dictionary 201104). Note that this property is marked as derived, since this number can be calculated from the number of Benefit Stage class instances. |
«MO» MonetaryAmount | dispensingFee |
"Dispensing fee paid included in the Total Amount Paid" - NCPDP Telecommunication (Field 507-F7, Data Dictionary 201104). |
«MO» MonetaryAmount | dispensingFeeAmount |
"Informational field used when Other Payer-Patient Responsibility Amount or Patient Pay Amount is used for reimbursement. Amount is equal to contracted or reimbursable dispensing fee for product being dispensed." - NCPDP Telecommunication (Field 149-U9, Data Dictionary 201104). |
«MO» MonetaryAmount | estimatedGenericSavings |
"The amount, not included in the Total Amount Paid, that the patient would have saved if they had chosen the generic drug instead of the brand drug." - NCPDP Telecommunication (Field 577-G3, Data Dictionary 201104). |
«MO» MonetaryAmount | flatSalesTaxAmount |
"Flat sales tax paid which is included in the Total Amount Paid" - NCPDP Telecommunication (Field 558-AW, Data Dictionary 201104). |
«MO» MonetaryAmount | healthPlanFundedAssistanceAmount |
"The amount from the health plan-funded assistance account for the patient that was applied to reduce Patient Pay Amount. This amount is used in Healthcare Reimbursement Account (HRA) benefits only. This field is always a negative amount or zero. The Health Plan-funded Assistance Amount is part of the patient pay amount calculation and is used to report back to the provider and patient the portion of Patient Pay Amount that was reduced due to this plan-funded assistance. NOTE: There is no credit card transaction involved in this type of Patient Spending Assistance, as in a Flexible Spending Account (FSA)." - NCPDP Telecommunication (Field 129-UD, Data Dictionary 201104). |
«MO» MonetaryAmount | incentiveAmount |
"Amount represents the contractually agreed upon incentive fee paid for specific services rendered. Amount is included in the Total Amount Paid." - NCPDP Telecommunication (Field 521-FL, Data Dictionary 201104). |
«MO» MonetaryAmount | ingredientCost |
"Drug ingredient cost paid included in the Total Amount Paid." - NCPDP Telecommunication (Field 506-F6, Data Dictionary 201104). |
«MO» MonetaryAmount | ingredientCostAmount |
"Informational field used when Other Payer-Patient Responsibility Amount or Patient Pay Amount is used for reimbursement. Amount is equal to contracted or reimbursable amount for product being dispensed." - NCPDP Telecommunication (Field 148-U8, Data Dictionary 201104). |
OtherAmount | otherAmount |
Pointer to a set of additional costs associated with a dispensed prescription or service that were reimbursed. Examples of such costs include shipping, compound preparation, incentives, and taxes. |
Integer | otherAmountPaidCount |
"Count of the other amount paid occurrences." - NCPDP Telecommunication (Field 563-J2, Data Dictionary 201104). Note that this property could potentially be calculated based on the number of instances of the Other Amount class. |
«MO» MonetaryAmount | otherPayerAmountRecognized |
"Total amount recognized by the processor of any payment from another source." - NCPDP Telecommunication (Field 566-J5, Data Dictionary 201104). |
«MO» MonetaryAmount | patientPayAmount |
"Amount that is calculated by the processor and returned to the pharmacy as the TOTAL amount to be paid by the patient to the pharmacy; the patient’s total cost share, including copayments, amounts applied to deductible, over maximum amounts, penalties, etc." - NCPDP Telecommunication (Field 505-F5, Data Dictionary 201104). |
«MO» MonetaryAmount | patientSalesTaxAmount |
"Patient sales tax responsibility. This field is not a component of the Patient Pay Amount formula." - NCPDP Telecommunication (Field 575-EQ, Data Dictionary 201104). |
«MO» MonetaryAmount | percentageSalesTaxAmount |
"Amount of percentage sales tax paid which is included in the Total Amount Paid" - NCPDP Telecommunication (Field 559-AX, Data Dictionary 201104). |
«CS» Code | percentageSalesTaxBasis |
"Code indicating the percentage sales tax paid basis." - NCPDP Telecommunication (Field 561-AZ, Data Dictionary 201104). Possible values include: Ingredient Cost; Ingredient Cost plus Dispensing Fee; Not Specified. |
«REAL» Decimal | percentageSalesTaxRate |
"Percentage sales tax rate used to calculate Percentage Sales Tax Amount Paid" - NCPDP Telecommunication (Field 560-AY, Data Dictionary 201104). |
«MO» MonetaryAmount | planSalesTaxAmount |
"Plan sales tax responsibility. This field is not a component of the Patient Pay Amount formula." - NCPDP Telecommunication (Field 574-2Y, Data Dictionary 201104). |
«MO» MonetaryAmount | professionalServiceFee |
"Amount representing the contractually agreed upon fee for professional services rendered. This amount is included in the Total Amount Paid." - NCPDP Telecommunication (Field 562-J1, Data Dictionary 201104). |
«MO» MonetaryAmount | remainingBenefitAmount |
"Amount remaining in a patient/family plan with a periodic maximum benefit." - NCPDP Telecommunication (Field 514-FE, Data Dictionary 201104). |
«MO» MonetaryAmount | remainingDeductibleAmount |
"Amount not met by the patient/family in the deductible plan." - NCPDP Telecommunication (Field 513-FD, Data Dictionary 201104). |
«MO» MonetaryAmount | spendingAccountAmountRemaining |
"The balance from the patient’s spending account after this transaction was applied." - NCPDP Telecommunication (Field 128-UC, Data Dictionary 201104). |
«CS» Code | taxExemptCategory |
"Code indicating the payer and/or the patient is exempt from taxes." - NCPDP Telecommunication (Field 557-AV, Data Dictionary 201104). Possible values include: Payer/Plan is Tax Exempt; Patient is Tax Exempt; Payer/Plan and Patient are Tax Exempt. |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | BillingResponse |
Name Expression | |
Namespace | EnrollEligCOB |
Owned Template Signature | |
Owner | EnrollEligCOB |
Owning Template Parameter | |
Package | EnrollEligCOB |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «MO» MonetaryAmount accumulatedDeductibleAmount
"Amount in dollars met by the patient/family in a deductible plan." - NCPDP Telecommunication (Field 512-FC, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | accumulatedDeductibleAmount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::accumulatedDeductibleAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount amountAppliedToDeductible
"Amount to be collected from a patient that is included in Patient Pay Amount that is applied to a periodic deductible." - NCPDP Telecommunication (Field 517-FH, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | amountAppliedToDeductible |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::amountAppliedToDeductible |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount amountAttributableToSalesTax
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to sales tax paid." - NCPDP Telecommunication (Field 523-FN, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | amountAttributableToSalesTax |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::amountAttributableToSalesTax |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount amountAttributedToBrandNonFormularySelection
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the patient’s selection of a Brand Non-Preferred Formulary product." - NCPDP Telecommunication (Field 136-UN, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | amountAttributedToBrandNonFormularySelection |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::amountAttributedToBrandNonFormularySelection |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount amountAttributedToBrandSelection
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the patient’s selection of a Brand product." - NCPDP Telecommunication (Field 134-UK, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | amountAttributedToBrandSelection |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::amountAttributedToBrandSelection |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount amountAttributedToCoverageGap
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the patient being in the coverage gap (for example Medicare Part D Coverage Gap (donut hole)). A coverage gap is defined as the period or amount during which the previous coverage ends and before an additional coverage begins." - NCPDP Telecommunication (Field 137-UP, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | amountAttributedToCoverageGap |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::amountAttributedToCoverageGap |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount amountAttributedToNonFormularySelection
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the patient’s selection of a Non-Preferred Formulary product." - NCPDP Telecommunication (Field 135-UM, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | amountAttributedToNonFormularySelection |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::amountAttributedToNonFormularySelection |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount amountAttributedToProviderNetworkSelection
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the patient’s provider network selection." - NCPDP Telecommunication (Field 133-UJ, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | amountAttributedToProviderNetworkSelection |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::amountAttributedToProviderNetworkSelection |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount amountExceedingBenefitMaximum
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the patient exceeding a periodic benefit maximum." - NCPDP Telecommunication (Field 520-FK, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | amountExceedingBenefitMaximum |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::amountExceedingBenefitMaximum |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount amountOfCoinsurance
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to a per prescription coinsurance." - NCPDP Telecommunication (Field 572-4U, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | amountOfCoinsurance |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::amountOfCoinsurance |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount amountOfCopay
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to a per prescription copay." - NCPDP Telecommunication (Field 518-FI, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | amountOfCopay |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::amountOfCopay |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount amountOfProcessingFee
"Amount to be collected from the patient that is included in Patient Pay Amount that is due to the processing fee imposed by the processor." - NCPDP Telecommunication (Field 571-NZ, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | amountOfProcessingFee |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::amountOfProcessingFee |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code basisOfCalculationCoInsurance
"Code indicating how the Coinsurance reimbursement amount was calculated for Patient Pay Amount." - NCPDP Telecommunication (Field 573-4V, Data Dictionary 201104). Possible values include: Quantity Dispensed; Quantity Intended To Be Dispensed; Usual and Customary/Prorated; Waived Due To Partial Fill; Other.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | basisOfCalculationCoInsurance |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::basisOfCalculationCoInsurance |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code basisOfCalculationCopay
"Code indicating how the Copay reimbursement amount was calculated for Patient Pay Amount." - NCPDP Telecommunication (Field 347-HJ, Data Dictionary 201104). Possible values include: Quantity Dispensed; Quantity Intended To Be Dispensed; Usual and Customary/Prorated; Waived Due To Partial Fill; Other.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | basisOfCalculationCopay |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::basisOfCalculationCopay |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code basisOfCalculationDispensingFee
"Code indicating how the reimbursement amount was calculated for Dispensing Fee Paid" - NCPDP Telecommunication (Field 346-HH, Data Dictionary 201104). Possible values include: Quantity Dispensed; Quantity Intended To Be Dispensed; Usual and Customary/Prorated; Waived Due To Partial Fill; Other.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | basisOfCalculationDispensingFee |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::basisOfCalculationDispensingFee |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code basisOfCalculationFlatSalesTax
"Code indicating how the reimbursement amount was calculated for Flat Sales Tax Amount Paid" - NCPDP Telecommunication (Field 348-HK, Data Dictionary 201104). Possible values include: Quantity Dispensed; Quantity Intended To Be Dispensed.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | basisOfCalculationFlatSalesTax |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::basisOfCalculationFlatSalesTax |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code basisOfCalculationPercentageSalesTax
"Code indicating how the reimbursement amount was calculated for Percentage Sales Tax Amount Paid." - NCPDP Telecommunication (Field 349-HM, Data Dictionary 201104). Possible values include: Quantity Dispensed; Quantity Intended To Be Dispensed.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | basisOfCalculationPercentageSalesTax |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::basisOfCalculationPercentageSalesTax |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code basisOfReimbursementDetermination
"Code identifying how the reimbursement amount was calculated for "Ingredient Cost Paid." - NCPDP Telecommunication (Field 522-FM, Data Dictionary 201104). Possible values include: Default; AWP (Average Wholesale Price); Local Wholesaler; Direct; EAC (Estimated Acquisition Cost); Acquisition; MAC (Maximum Allowable Cost); Usual & Customary; 340B /Disproportionate Share Pricing/Public Health Service; ASP (Average Sales Price); AMP (Average Manufacturer Price); WAC (Wholesale Acquisition Cost); Special Patient Pricing; Other.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | basisOfReimbursementDetermination |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::basisOfReimbursementDetermination |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public BenefitStage benefitStage
Pointer to a record of the number and dollar amount of payments made in each Medicare Part D stage.
Aggregation | None |
Alias | |
Association | billingResponse_benefitStage |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | benefitStage |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::benefitStage |
Stereotype | |
Template Parameter | |
Type | BenefitStage |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Integer benefitStageCount
"Count of Benefit Stage Amount occurrences." - NCPDP Telecommunication (Field 392-MU, Data Dictionary 201104). Note that this property is marked as derived, since this number can be calculated from the number of Benefit Stage class instances.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | true |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | benefitStageCount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::benefitStageCount |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount dispensingFee
"Dispensing fee paid included in the Total Amount Paid" - NCPDP Telecommunication (Field 507-F7, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | dispensingFee |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::dispensingFee |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount dispensingFeeAmount
"Informational field used when Other Payer-Patient Responsibility Amount or Patient Pay Amount is used for reimbursement. Amount is equal to contracted or reimbursable dispensing fee for product being dispensed." - NCPDP Telecommunication (Field 149-U9, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | dispensingFeeAmount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::dispensingFeeAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount estimatedGenericSavings
"The amount, not included in the Total Amount Paid, that the patient would have saved if they had chosen the generic drug instead of the brand drug." - NCPDP Telecommunication (Field 577-G3, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | estimatedGenericSavings |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::estimatedGenericSavings |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount flatSalesTaxAmount
"Flat sales tax paid which is included in the Total Amount Paid" - NCPDP Telecommunication (Field 558-AW, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | flatSalesTaxAmount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::flatSalesTaxAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount healthPlanFundedAssistanceAmount
"The amount from the health plan-funded assistance account for the patient that was applied to reduce Patient Pay Amount. This amount is used in Healthcare Reimbursement Account (HRA) benefits only. This field is always a negative amount or zero. The Health Plan-funded Assistance Amount is part of the patient pay amount calculation and is used to report back to the provider and patient the portion of Patient Pay Amount that was reduced due to this plan-funded assistance. NOTE: There is no credit card transaction involved in this type of Patient Spending Assistance, as in a Flexible Spending Account (FSA)." - NCPDP Telecommunication (Field 129-UD, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | healthPlanFundedAssistanceAmount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::healthPlanFundedAssistanceAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount incentiveAmount
"Amount represents the contractually agreed upon incentive fee paid for specific services rendered. Amount is included in the Total Amount Paid." - NCPDP Telecommunication (Field 521-FL, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | incentiveAmount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::incentiveAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount ingredientCost
"Drug ingredient cost paid included in the Total Amount Paid." - NCPDP Telecommunication (Field 506-F6, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | ingredientCost |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::ingredientCost |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount ingredientCostAmount
"Informational field used when Other Payer-Patient Responsibility Amount or Patient Pay Amount is used for reimbursement. Amount is equal to contracted or reimbursable amount for product being dispensed." - NCPDP Telecommunication (Field 148-U8, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | ingredientCostAmount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::ingredientCostAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public OtherAmount otherAmount
Pointer to a set of additional costs associated with a dispensed prescription or service that were reimbursed. Examples of such costs include shipping, compound preparation, incentives, and taxes.
Aggregation | None |
Alias | |
Association | billingResponse_otherAmount |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | otherAmount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::otherAmount |
Stereotype | |
Template Parameter | |
Type | OtherAmount |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Integer otherAmountPaidCount
"Count of the other amount paid occurrences." - NCPDP Telecommunication (Field 563-J2, Data Dictionary 201104). Note that this property could potentially be calculated based on the number of instances of the Other Amount class.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | true |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | otherAmountPaidCount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::otherAmountPaidCount |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount otherPayerAmountRecognized
"Total amount recognized by the processor of any payment from another source." - NCPDP Telecommunication (Field 566-J5, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | otherPayerAmountRecognized |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::otherPayerAmountRecognized |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount patientPayAmount
"Amount that is calculated by the processor and returned to the pharmacy as the TOTAL amount to be paid by the patient to the pharmacy; the patient’s total cost share, including copayments, amounts applied to deductible, over maximum amounts, penalties, etc." - NCPDP Telecommunication (Field 505-F5, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | patientPayAmount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::patientPayAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount patientSalesTaxAmount
"Patient sales tax responsibility. This field is not a component of the Patient Pay Amount formula." - NCPDP Telecommunication (Field 575-EQ, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | patientSalesTaxAmount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::patientSalesTaxAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount percentageSalesTaxAmount
"Amount of percentage sales tax paid which is included in the Total Amount Paid" - NCPDP Telecommunication (Field 559-AX, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | percentageSalesTaxAmount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::percentageSalesTaxAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code percentageSalesTaxBasis
"Code indicating the percentage sales tax paid basis." - NCPDP Telecommunication (Field 561-AZ, Data Dictionary 201104). Possible values include: Ingredient Cost; Ingredient Cost plus Dispensing Fee; Not Specified.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | percentageSalesTaxBasis |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::percentageSalesTaxBasis |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «REAL» Decimal percentageSalesTaxRate
"Percentage sales tax rate used to calculate Percentage Sales Tax Amount Paid" - NCPDP Telecommunication (Field 560-AY, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | percentageSalesTaxRate |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::percentageSalesTaxRate |
Stereotype | |
Template Parameter | |
Type | «REAL» Decimal |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount planSalesTaxAmount
"Plan sales tax responsibility. This field is not a component of the Patient Pay Amount formula." - NCPDP Telecommunication (Field 574-2Y, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | planSalesTaxAmount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::planSalesTaxAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount professionalServiceFee
"Amount representing the contractually agreed upon fee for professional services rendered. This amount is included in the Total Amount Paid." - NCPDP Telecommunication (Field 562-J1, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | professionalServiceFee |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::professionalServiceFee |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount remainingBenefitAmount
"Amount remaining in a patient/family plan with a periodic maximum benefit." - NCPDP Telecommunication (Field 514-FE, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | remainingBenefitAmount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::remainingBenefitAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount remainingDeductibleAmount
"Amount not met by the patient/family in the deductible plan." - NCPDP Telecommunication (Field 513-FD, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | remainingDeductibleAmount |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::remainingDeductibleAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount spendingAccountAmountRemaining
"The balance from the patient’s spending account after this transaction was applied." - NCPDP Telecommunication (Field 128-UC, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | spendingAccountAmountRemaining |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::spendingAccountAmountRemaining |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code taxExemptCategory
"Code indicating the payer and/or the patient is exempt from taxes." - NCPDP Telecommunication (Field 557-AV, Data Dictionary 201104). Possible values include: Payer/Plan is Tax Exempt; Patient is Tax Exempt; Payer/Plan and Patient are Tax Exempt.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingResponse |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | taxExemptCategory |
Name Expression | |
Namespace | BillingResponse |
Opposite | |
Owner | BillingResponse |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingResponse::taxExemptCategory |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| EnrollEligCOB UML Documentation |
Summary:AttributesProperties | Detail:Attributes |