EnrollEligCOB UML Documentation

Element

EnrollEligCOB
Class PaymentNotice

"This resource provides the status of the payment for goods and services rendered, and the request and response resource references." - HL7 FHIR, PaymentNotice

Attributes
«MO» MonetaryAmount	amount	"The party who is notified of the payment status." - HL7 FHIR, PaymentNotice.recipient
«TS» PointInTime	dateCreated	"The date when this resource was created." - HL7 FHIR, PaymentNotice.created
«II» Id	identifier	"A unique identifier assigned to this payment notice." - HL7 FHIR, PaymentNotice.identifier
HealthcareProvider	payee	"The party who will receive or has received payment that is the subject of this notification." - HL7 FHIR, PaymentNotice.payee
PaymentReconciliation	payment	"A reference to the payment which is the subject of this notice." - HL7 FHIR, PaymentNotice.payment Note that in FHIR, this is a pointer to any resource. This is a placeholder to remind us to change this property to an association to the appriopriate FHIM class.
«TS» PointInTime	paymentDate	"The date when the above payment action occurred." - HL7 FHIR, PaymentNotice.paymentDate
«CS» Code	paymentStatus	"The payment status, typically paid: payment sent, cleared: payment received." - HL7 FHIR, PaymentNotice.paymentStatus
HealthcareProvider	provider	"The practitioner who is responsible for the services rendered to the patient." - HL7 FHIR, PaymentNotice.provider
Organization	recipient	"The party who is notified of the payment status." - HL7 FHIR, PaymentNotice.recipient
«ANY» Any	request	"Reference of resource for which payment is being made." - HL7 FHIR, PaymentNotice.request Note that in FHIR, this is a pointer to ANY resource. This is a placeholder to remind us to change this property to an association to the appriopriate FHIM class.
«ANY» Any	response	"Reference of response to resource for which payment is being made." - HL7 FHIR, PaymentNotice.response Note that in FHIR, this is a pointer to ANY resource. This is a placeholder to remind us to change this property to an association to the appriopriate FHIM class.
«CS» Code	status	"The status of the resource instance." - HL7 FHIR, PaymentNotice.status

Properties:

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

Attribute Details

amount

Public «MO» MonetaryAmount amount

"The party who is notified of the payment status." - HL7 FHIR, PaymentNotice.recipient

Constraints:

Properties:

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

dateCreated

Public «TS» PointInTime dateCreated

"The date when this resource was created." - HL7 FHIR, PaymentNotice.created

Constraints:

Properties:

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

identifier

Public «II» Id identifier

"A unique identifier assigned to this payment notice." - HL7 FHIR, PaymentNotice.identifier

Constraints:

Properties:

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

payee

Public HealthcareProvider payee

"The party who will receive or has received payment that is the subject of this notification." - HL7 FHIR, PaymentNotice.payee

Constraints:

Properties:

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

payment

Public PaymentReconciliation payment

"A reference to the payment which is the subject of this notice." - HL7 FHIR, PaymentNotice.payment
Note that in FHIR, this is a pointer to any resource. This is a placeholder to remind us to change this property to an association to the appriopriate FHIM class.

Constraints:

Properties:

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

paymentDate

Public «TS» PointInTime paymentDate

"The date when the above payment action occurred." - HL7 FHIR, PaymentNotice.paymentDate

Constraints:

Properties:

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

paymentStatus

Public «CS» Code paymentStatus

"The payment status, typically paid: payment sent, cleared: payment received." - HL7 FHIR, PaymentNotice.paymentStatus

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PaymentNotice
Terminologies	[ HL7_FHIR_R4 Payment Status Codes http://hl7.org/fhir/ValueSet/payment-status ]
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	paymentStatus
Name Expression
Namespace	PaymentNotice
Opposite
Owner	PaymentNotice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::PaymentNotice::paymentStatus
Stereotype	ValueSetConstraints
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

provider

Public HealthcareProvider provider

"The practitioner who is responsible for the services rendered to the patient." - HL7 FHIR, PaymentNotice.provider

Constraints:

Properties:

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

recipient

Public Organization recipient

"The party who is notified of the payment status." - HL7 FHIR, PaymentNotice.recipient

Constraints:

Properties:

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

request

Public «ANY» Any request

"Reference of resource for which payment is being made." - HL7 FHIR, PaymentNotice.request
Note that in FHIR, this is a pointer to ANY resource. This is a placeholder to remind us to change this property to an association to the appriopriate FHIM class.

Constraints:

Properties:

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

response

Public «ANY» Any response

"Reference of response to resource for which payment is being made." - HL7 FHIR, PaymentNotice.response
Note that in FHIR, this is a pointer to ANY resource. This is a placeholder to remind us to change this property to an association to the appriopriate FHIM class.

Constraints:

Properties:

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

status

Public «CS» Code status

"The status of the resource instance." - HL7 FHIR, PaymentNotice.status

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	PaymentNotice
Terminologies	[ HL7_FHIR_R4 Financial Resource Status Codes http://hl7.org/fhir/ValueSet/fm-status ]
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	status
Name Expression
Namespace	PaymentNotice
Opposite
Owner	PaymentNotice
Owning Association
Owning Template Parameter
Qualified Name	FHIM::EnrollEligCOB::PaymentNotice::status
Stereotype	ValueSetConstraints
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

Overview

Top

Package

Element

EnrollEligCOB UML Documentation

Summary:AttributesProperties

Detail:Attributes