| EnrollEligCOB UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
This class contains data sent to a Payer as part of a Billing Event detailing the components and reasons for the charges being billed.
Attributes | ||
«CS» Code | basisOfCostDetermination |
"Code indicating the method by which Ingredient Cost Submitted was calculated." - NCPDP Telecommunication (Field 423-DN, 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. |
«MO» MonetaryAmount | dispensingFee |
"Dispensing fee submitted by the pharmacy. This amount is included in the Gross Amount Due" - NCPDP Telecommunication (Field 412-DC, Data Dictionary 201104). |
«MO» MonetaryAmount | flatSalesTaxAmount |
"Flat sales tax submitted for prescription. This amount is included in the Gross Amount Due." - NCPDP Telecommunication (Field 481-HA, Data Dictionary 201104). |
«MO» MonetaryAmount | incentiveAmount |
"Amount represents a fee that is submitted by the pharmacy for contractually agreed upon services. This amount is included in the Gross Amount Due." - NCPDP Telecommunication (Field 438-E3, Data Dictionary 201104). |
«MO» MonetaryAmount | ingredientCost |
"Submitted product component cost of the dispensed prescription. This amount is included in the Gross Amount Due" - NCPDP Telecommunication (Field 409-D9, Data Dictionary 201104). |
«MO» MonetaryAmount | medicaidPaidAmount |
"Amount paid by the Medicaid Agency. Required if affects pricing in Medicaid Subrogation (contains the amount paid to the pharmacy). See Medicaid Subrogation Implementation Guide." - NCPDP Telecommunication (Field 113-N3, Data Dictionary 201104). |
String | narrative |
Contains any comments to describe the billable event or to provide justification for payment. |
OtherAmount | otherAmount |
Pointer to a set of additional costs incurred or claimed for a dispensed prescription or service. Examples of such costs include shipping, compound preparation, incentives, and taxes. |
Integer | otherAmountSubmittedCount |
"Count of other amount claimed submitted occurrences." - NCPDP Telecommunication (Field 478-H7, Data Dictionary 201104). Note that this property could potentially be calculated based on the number of instances of the Other Amount class. |
«MO» MonetaryAmount | patientPaidAmount |
"Amount the pharmacy received from the patient for the prescription dispensed." - NCPDP Telecommunication (Field 433-DX, Data Dictionary 201104). |
«MO» MonetaryAmount | percentageSalesTaxAmount |
"Percentage sales tax submitted. This amount is included in the Gross Amount Due." - NCPDP Telecommunication (Field 482-GE, Data Dictionary 201104). |
«CS» Code | percentageSalesTaxBasis |
"Code indicating the basis for percentage sales tax." - NCPDP Telecommunication (Field 483-HE, 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 Submitted" - NCPDP Telecommunication (Field 483-HE, Data Dictionary 201104). |
«MO» MonetaryAmount | professionalServiceFee |
"Amount submitted by the provider for professional services rendered." - NCPDP Telecommunication (Field 477-BE, Data Dictionary 201104). |
«MO» MonetaryAmount | usualAndCustomaryCharge |
"Amount charged cash customers for the prescription exclusive of sales tax or other amounts claimed." - NCPDP Telecommunication (Field 426-DQ, Data Dictionary 201104). |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | BillingSubmission |
Name Expression | |
Namespace | EnrollEligCOB |
Owned Template Signature | |
Owner | EnrollEligCOB |
Owning Template Parameter | |
Package | EnrollEligCOB |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «CS» Code basisOfCostDetermination
"Code indicating the method by which Ingredient Cost Submitted was calculated." - NCPDP Telecommunication (Field 423-DN, 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 | BillingSubmission |
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 | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | basisOfCostDetermination |
Name Expression | |
Namespace | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::basisOfCostDetermination |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount dispensingFee
"Dispensing fee submitted by the pharmacy. This amount is included in the Gross Amount Due" - NCPDP Telecommunication (Field 412-DC, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingSubmission |
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 | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::dispensingFee |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount flatSalesTaxAmount
"Flat sales tax submitted for prescription. This amount is included in the Gross Amount Due." - NCPDP Telecommunication (Field 481-HA, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingSubmission |
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 | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::flatSalesTaxAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount incentiveAmount
"Amount represents a fee that is submitted by the pharmacy for contractually agreed upon services. This amount is included in the Gross Amount Due." - NCPDP Telecommunication (Field 438-E3, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingSubmission |
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 | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::incentiveAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount ingredientCost
"Submitted product component cost of the dispensed prescription. This amount is included in the Gross Amount Due" - NCPDP Telecommunication (Field 409-D9, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingSubmission |
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 | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::ingredientCost |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount medicaidPaidAmount
"Amount paid by the Medicaid Agency. Required if affects pricing in Medicaid Subrogation (contains the amount paid to the pharmacy). See Medicaid Subrogation Implementation Guide." - NCPDP Telecommunication (Field 113-N3, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingSubmission |
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 | medicaidPaidAmount |
Name Expression | |
Namespace | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::medicaidPaidAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String narrative
Contains any comments to describe the billable event or to provide justification for payment.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingSubmission |
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 | narrative |
Name Expression | |
Namespace | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::narrative |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public OtherAmount otherAmount
Pointer to a set of additional costs incurred or claimed for a dispensed prescription or service. Examples of such costs include shipping, compound preparation, incentives, and taxes.
Aggregation | None |
Alias | |
Association | billingSubmission_otherAmount |
Association End | |
Class | BillingSubmission |
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 | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::otherAmount |
Stereotype | |
Template Parameter | |
Type | OtherAmount |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Integer otherAmountSubmittedCount
"Count of other amount claimed submitted occurrences." - NCPDP Telecommunication (Field 478-H7, 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 | BillingSubmission |
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 | otherAmountSubmittedCount |
Name Expression | |
Namespace | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::otherAmountSubmittedCount |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount patientPaidAmount
"Amount the pharmacy received from the patient for the prescription dispensed." - NCPDP Telecommunication (Field 433-DX, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingSubmission |
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 | patientPaidAmount |
Name Expression | |
Namespace | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::patientPaidAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount percentageSalesTaxAmount
"Percentage sales tax submitted. This amount is included in the Gross Amount Due." - NCPDP Telecommunication (Field 482-GE, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingSubmission |
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 | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::percentageSalesTaxAmount |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code percentageSalesTaxBasis
"Code indicating the basis for percentage sales tax." - NCPDP Telecommunication (Field 483-HE, Data Dictionary 201104). Possible values include: Ingredient Cost; Ingredient Cost plus Dispensing Fee; Not Specified.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingSubmission |
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 | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::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 Submitted" - NCPDP Telecommunication (Field 483-HE, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingSubmission |
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 | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::percentageSalesTaxRate |
Stereotype | |
Template Parameter | |
Type | «REAL» Decimal |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount professionalServiceFee
"Amount submitted by the provider for professional services rendered." - NCPDP Telecommunication (Field 477-BE, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingSubmission |
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 | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::professionalServiceFee |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «MO» MonetaryAmount usualAndCustomaryCharge
"Amount charged cash customers for the prescription exclusive of sales tax or other amounts claimed." - NCPDP Telecommunication (Field 426-DQ, Data Dictionary 201104).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | BillingSubmission |
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 | usualAndCustomaryCharge |
Name Expression | |
Namespace | BillingSubmission |
Opposite | |
Owner | BillingSubmission |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::EnrollEligCOB::BillingSubmission::usualAndCustomaryCharge |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| EnrollEligCOB UML Documentation |
Summary:AttributesProperties | Detail:Attributes |