EnrollEligCOB UML Documentation

Element

EnrollEligCOB
Class Invoice

"Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose." - HL7 FHIR, Invoice

Attributes
Account	account	"Account which is supposed to be balanced with this Invoice." - HL7 FHIR, Invoice.account
String	cancelledReason	"In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.)." - HL7 FHIR, Invoice.cancelledReason
«TS» PointInTime	date	"Date/time(s) of when this Invoice was posted." - HL7 FHIR, Invoice.date
«II» Id	identifier	"Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments." - HL7 FHIR, Invoice.identifier
InvoiceLineItem	invoiceLineItem	"Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource." - HL7 FHIR, Invoice.lineItem
Organization	issuer	"The organizationissuing the Invoice." - HL7 FHIR, Invoice.issuer
«CS» Code	kind	"Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary)." - HL7 FHIR, Invoice.type
Annotation	note	"Comments made about the invoice by the issuer, subject, or other participants." - HL7 FHIR, Invoice.note
FHIRParticipant	participant	"Indicates who or what performed or participated in the charged service." - HL7 FHIR, Invoice.participant
String	paymentTerms	"Payment details such as banking details, period of payment, deductibles, methods of payment." - HL7 FHIR, Invoice.paymentTerms
PriceComponent	priceComponent	"The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated." - HL7 FHIR, Invoice.totalPriceComponent
«ANY» Any	recipient	"The individual or Organization responsible for balancing of this invoice." - HL7 FHIR, Invoice.recipient Note that in FHIR, this can be an Organization, Patient or a RelatedPerson; in the FHIM, the data type is an Any to handle this variability.
«CS» Code	status	"The current state of the Invoice." Possible values are: Draft; Issued; Balanced; Cancelled; Entered in error. - HL7 FHIR, Invoice.status
Patient	subject	"The individual or set of individuals receiving the goods and services billed in this invoice." - HL7 FHIR, Invoice.subject Note that in FHIR, this can be a Patient or a Group; we have modeled this a zero-to-many Patients.
«MO» MonetaryAmount	totalGross	"Invoice total, tax included." - HL7 FHIR, Invoice.totalGross
«MO» MonetaryAmount	totalNet	"Invoice total, taxes excluded." - HL7 FHIR, Invoice.totalNet

Properties:

Alias
Classifier Behavior
Is Abstract	false
Is Active	false
Is Leaf	false
Keywords
Name	Invoice
Name Expression
Namespace	EnrollEligCOB
Owned Template Signature
Owner	EnrollEligCOB
Owning Template Parameter
Package	EnrollEligCOB
Qualified Name	FHIM::EnrollEligCOB::Invoice
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

account

Public Account account

"Account which is supposed to be balanced with this Invoice." - HL7 FHIR, Invoice.account

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	account
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::account
Stereotype
Template Parameter
Type	Account
Upper	1
Upper Value	(1)
Visibility	Public

cancelledReason

Public String cancelledReason

"In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.)." - HL7 FHIR, Invoice.cancelledReason

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	cancelledReason
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::cancelledReason
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value	(1)
Visibility	Public

date

Public «TS» PointInTime date

"Date/time(s) of when this Invoice was posted." - HL7 FHIR, Invoice.date

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	date
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::date
Stereotype
Template Parameter
Type	«TS» PointInTime
Upper	1
Upper Value	(1)
Visibility	Public

identifier

Public «II» Id identifier

"Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments." - HL7 FHIR, Invoice.identifier

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	identifier
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::identifier
Stereotype
Template Parameter
Type	«II» Id
Upper	*
Upper Value	(*)
Visibility	Public

invoiceLineItem

Public InvoiceLineItem invoiceLineItem

"Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource." - HL7 FHIR, Invoice.lineItem

Constraints:

Properties:

Aggregation	None
Alias
Association	invoice_invoiceLineItem
Association End
Class	Invoice
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	invoiceLineItem
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::invoiceLineItem
Stereotype
Template Parameter
Type	InvoiceLineItem
Upper	*
Upper Value	(*)
Visibility	Public

issuer

Public Organization issuer

"The organizationissuing the Invoice." - HL7 FHIR, Invoice.issuer

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	issuer
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::issuer
Stereotype
Template Parameter
Type	Organization
Upper	1
Upper Value	(1)
Visibility	Public

kind

Public «CS» Code kind

"Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary)." - HL7 FHIR, Invoice.type

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	kind
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::kind
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

note

Public Annotation note

"Comments made about the invoice by the issuer, subject, or other participants." - HL7 FHIR, Invoice.note

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	note
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::note
Stereotype
Template Parameter
Type	Annotation
Upper	*
Upper Value	(*)
Visibility	Public

participant

Public FHIRParticipant participant

"Indicates who or what performed or participated in the charged service." - HL7 FHIR, Invoice.participant

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	participant
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::participant
Stereotype
Template Parameter
Type	FHIRParticipant
Upper	*
Upper Value	(*)
Visibility	Public

paymentTerms

Public String paymentTerms

"Payment details such as banking details, period of payment, deductibles, methods of payment." - HL7 FHIR, Invoice.paymentTerms

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	paymentTerms
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::paymentTerms
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value	(1)
Visibility	Public

priceComponent

Public PriceComponent priceComponent

"The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated." - HL7 FHIR, Invoice.totalPriceComponent

Constraints:

Properties:

Aggregation	None
Alias
Association	invoice_priceComponent
Association End
Class	Invoice
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	priceComponent
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::priceComponent
Stereotype
Template Parameter
Type	PriceComponent
Upper	*
Upper Value	(*)
Visibility	Public

recipient

Public «ANY» Any recipient

"The individual or Organization responsible for balancing of this invoice." - HL7 FHIR, Invoice.recipient
Note that in FHIR, this can be an Organization, Patient or a RelatedPerson; in the FHIM, the data type is an Any to handle this variability.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	recipient
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::recipient
Stereotype
Template Parameter
Type	«ANY» Any
Upper	1
Upper Value	(1)
Visibility	Public

status

Public «CS» Code status

"The current state of the Invoice." Possible values are: Draft; Issued; Balanced; Cancelled; Entered in error. - HL7 FHIR, Invoice.status

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	status
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::status
Stereotype
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

subject

Public Patient subject

"The individual or set of individuals receiving the goods and services billed in this invoice." - HL7 FHIR, Invoice.subject
Note that in FHIR, this can be a Patient or a Group; we have modeled this a zero-to-many Patients.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	subject
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::subject
Stereotype
Template Parameter
Type	Patient
Upper	*
Upper Value	(*)
Visibility	Public

totalGross

Public «MO» MonetaryAmount totalGross

"Invoice total, tax included." - HL7 FHIR, Invoice.totalGross

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	totalGross
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::totalGross
Stereotype
Template Parameter
Type	«MO» MonetaryAmount
Upper	1
Upper Value	(1)
Visibility	Public

totalNet

Public «MO» MonetaryAmount totalNet

"Invoice total, taxes excluded." - HL7 FHIR, Invoice.totalNet

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Invoice
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	totalNet
Name Expression
Namespace	Invoice
Opposite
Owner	Invoice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::Invoice::totalNet
Stereotype
Template Parameter
Type	«MO» MonetaryAmount
Upper	1
Upper Value	(1)
Visibility	Public

Overview

Top

Package

Element

EnrollEligCOB UML Documentation

Summary:AttributesProperties

Detail:Attributes