EHI Export Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Payment

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

Notes

The id element is not displayed in the snapshot tables. Refer to the detailed descriptions for the full definition.

Usage:

• This Resource is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Payment		0..*	DomainResource	Payment dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding ele-1: All FHIR elements must have a @value or children
text		0..1	Narrative	Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..1	Identifier	Identification key
subject	Σ	1..1	Reference(Patient)	Patient subject reference
effectiveDateTime	Σ	0..1	dateTime	Timestamp when the payment was effective
createdDate	Σ	0..1	dateTime	Timestamp when the payment was created
revisionDate	Σ	0..1	dateTime	Timestamp when the payment was revised
receiptAmount	Σ	0..1	Money	Receipt amount for the payment
trustAmount	Σ	0..1	Money	Trust amount for the payment
arAmount	Σ	0..1	Money	AR amount for the payment
payerDescription	Σ	0..1	string	Payer description
payerType	Σ	0..1	string	Payer type
cashReceiptType	Σ	0..1	string	Cash receipt type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Payment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Payment	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Payment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Payment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Payment	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Payment	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from DomainResource

Name	Flags	Card.	Type	Description & Constraints
Payment		0..*	DomainResource	Payment
identifier	Σ	1..1	Identifier	Identification key
subject	Σ	1..1	Reference(Patient)	Patient subject reference
effectiveDateTime	Σ	0..1	dateTime	Timestamp when the payment was effective
createdDate	Σ	0..1	dateTime	Timestamp when the payment was created
revisionDate	Σ	0..1	dateTime	Timestamp when the payment was revised
receiptAmount	Σ	0..1	Money	Receipt amount for the payment
trustAmount	Σ	0..1	Money	Trust amount for the payment
arAmount	Σ	0..1	Money	AR amount for the payment
payerDescription	Σ	0..1	string	Payer description
payerType	Σ	0..1	string	Payer type
cashReceiptType	Σ	0..1	string	Cash receipt type
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Payment		0..*	DomainResource	Payment
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier	Σ	1..1	Identifier	Identification key
subject	Σ	1..1	Reference(Patient)	Patient subject reference
effectiveDateTime	Σ	0..1	dateTime	Timestamp when the payment was effective
createdDate	Σ	0..1	dateTime	Timestamp when the payment was created
revisionDate	Σ	0..1	dateTime	Timestamp when the payment was revised
receiptAmount	Σ	0..1	Money	Receipt amount for the payment
trustAmount	Σ	0..1	Money	Trust amount for the payment
arAmount	Σ	0..1	Money	AR amount for the payment
payerDescription	Σ	0..1	string	Payer description
payerType	Σ	0..1	string	Payer type
cashReceiptType	Σ	0..1	string	Cash receipt type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Payment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Payment	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Payment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Payment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Payment	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Payment	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element(2 nested mandatory elements)

Structures

This structure refers to these other structures:

• Patient (https://ehi-export.pointclickcare.com//StructureDefinition/patient)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Payment		0..*	DomainResource	Payment dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding ele-1: All FHIR elements must have a @value or children
text		0..1	Narrative	Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..1	Identifier	Identification key
subject	Σ	1..1	Reference(Patient)	Patient subject reference
effectiveDateTime	Σ	0..1	dateTime	Timestamp when the payment was effective
createdDate	Σ	0..1	dateTime	Timestamp when the payment was created
revisionDate	Σ	0..1	dateTime	Timestamp when the payment was revised
receiptAmount	Σ	0..1	Money	Receipt amount for the payment
trustAmount	Σ	0..1	Money	Trust amount for the payment
arAmount	Σ	0..1	Money	AR amount for the payment
payerDescription	Σ	0..1	string	Payer description
payerType	Σ	0..1	string	Payer type
cashReceiptType	Σ	0..1	string	Cash receipt type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Payment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Payment	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Payment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Payment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Payment	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Payment	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from DomainResource

Name	Flags	Card.	Type	Description & Constraints
Payment		0..*	DomainResource	Payment
identifier	Σ	1..1	Identifier	Identification key
subject	Σ	1..1	Reference(Patient)	Patient subject reference
effectiveDateTime	Σ	0..1	dateTime	Timestamp when the payment was effective
createdDate	Σ	0..1	dateTime	Timestamp when the payment was created
revisionDate	Σ	0..1	dateTime	Timestamp when the payment was revised
receiptAmount	Σ	0..1	Money	Receipt amount for the payment
trustAmount	Σ	0..1	Money	Trust amount for the payment
arAmount	Σ	0..1	Money	AR amount for the payment
payerDescription	Σ	0..1	string	Payer description
payerType	Σ	0..1	string	Payer type
cashReceiptType	Σ	0..1	string	Cash receipt type
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Payment		0..*	DomainResource	Payment
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier	Σ	1..1	Identifier	Identification key
subject	Σ	1..1	Reference(Patient)	Patient subject reference
effectiveDateTime	Σ	0..1	dateTime	Timestamp when the payment was effective
createdDate	Σ	0..1	dateTime	Timestamp when the payment was created
revisionDate	Σ	0..1	dateTime	Timestamp when the payment was revised
receiptAmount	Σ	0..1	Money	Receipt amount for the payment
trustAmount	Σ	0..1	Money	Trust amount for the payment
arAmount	Σ	0..1	Money	AR amount for the payment
payerDescription	Σ	0..1	string	Payer description
payerType	Σ	0..1	string	Payer type
cashReceiptType	Σ	0..1	string	Cash receipt type
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Payment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Payment	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Payment	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Payment	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Payment	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Payment	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element(2 nested mandatory elements)

Structures

This structure refers to these other structures:

• Patient (https://ehi-export.pointclickcare.com//StructureDefinition/patient)

Other representations of profile: CSV, Excel, Schematron