Publication Build: This will be filled in by the publication tooling

• Content
• Detailed Descriptions
• Mappings
• JSON
• History

Resource Profile: Debt Portal PaymentReconciliation

This StructureDefinition contains the maps for VistA file AR TRANSACTION (433) to PaymentReconciliation.

Usage:

• CapabilityStatements using this Resource Profile: Lung Cancer Screening
• This Resource Profile 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
PaymentReconciliation		0..*	PaymentReconciliation	PaymentReconciliation resource 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
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
Slices for extension		0..*	Extension	Extension 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
extension:extension-PaymentReconciliation-paymentIssuer		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer"
value[x]	S	1..1	Reference(Debt Portal Patient)	Value of extension ele-1: All FHIR elements must have a @value or children
extension:extension-PaymentReconciliation-allocation-identifier		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier"
value[x]		1..1	Identifier	Value of extension ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Bill Number
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
extension:extension-PaymentReconciliation-allocation-target		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target"
value[x]	S	1..1	Reference(Debt Portal Invoice)	Value of extension ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier		0..*	Identifier	Business Identifier for a payment reconciliation ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Transaction Number
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
status	?!SΣ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. ele-1: All FHIR elements must have a @value or children Required Pattern: active
created	SΣ	1..1	dateTime	Creation date ele-1: All FHIR elements must have a @value or children
disposition	SC	0..1	string	Disposition message ele-1: All FHIR elements must have a @value or children dppr-31-1982: If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01)
paymentDate	SΣ	1..1	date	When payment issued ele-1: All FHIR elements must have a @value or children
paymentAmount	Σ	1..1	Money	Total amount of Payment ele-1: All FHIR elements must have a @value or children
value	SΣ	0..1	decimal	Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children
currency	SΣ	0..1	code	ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. ele-1: All FHIR elements must have a @value or children Required Pattern: USD
paymentIdentifier	S	0..1	Identifier	Business identifier for the payment ele-1: All FHIR elements must have a @value or children
Slices for detail		0..*	BackboneElement	Settlement particulars Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children
detail:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance. ele-1: All FHIR elements must have a @value or children
detail:va-principal-collected		0..1	BackboneElement	Settlement particulars ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Principal Collected
amount	S	0..1	Money	Amount allocated to this payable ele-1: All FHIR elements must have a @value or children
detail:va-interest-collected		0..1	BackboneElement	Settlement particulars ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Interest Collected
amount	S	0..1	Money	Amount allocated to this payable ele-1: All FHIR elements must have a @value or children
detail:va-admin-collected		0..1	BackboneElement	Settlement particulars ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Administrative Charge Collected
amount	S	0..1	Money	Amount allocated to this payable ele-1: All FHIR elements must have a @value or children
detail:va-marshal-collected		0..1	BackboneElement	Settlement particulars ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Marshal Fee Collected
amount	S	0..1	Money	Amount allocated to this payable ele-1: All FHIR elements must have a @value or children
detail:va-courtcost-collected		0..1	BackboneElement	Settlement particulars ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Court Cost Collected
amount	S	0..1	Money	Amount allocated to this payable ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PaymentReconciliation.extension:extension-PaymentReconciliation-allocation-identifier.value[x].use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PaymentReconciliation.extension:extension-PaymentReconciliation-allocation-identifier.value[x].type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
PaymentReconciliation.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PaymentReconciliation.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
PaymentReconciliation.status	required	Pattern: active http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
PaymentReconciliation.paymentAmount.currency	required	Pattern: USD http://hl7.org/fhir/ValueSet/currencies|4.0.1 from the FHIR Standard
PaymentReconciliation.detail.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-principal-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-interest-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-admin-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-marshal-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-courtcost-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PaymentReconciliation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PaymentReconciliation	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	PaymentReconciliation	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	PaymentReconciliation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PaymentReconciliation	A resource should have narrative for robust management : text.`div`.exists()
dppr-31-1982	warning	PaymentReconciliation.disposition	If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01) : true
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 PaymentReconciliation

Name	Flags	Card.	Type	Description & Constraints
PaymentReconciliation		0..*	PaymentReconciliation	PaymentReconciliation resource
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:extension-PaymentReconciliation-paymentIssuer		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer
value[x]	S	1..1	Reference(Debt Portal Patient)	Value of extension
extension:extension-PaymentReconciliation-allocation-identifier		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier
value[x]
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Bill Number
value	S	0..1	string	The value that is unique
extension:extension-PaymentReconciliation-allocation-target		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target
value[x]	S	1..1	Reference(Debt Portal Invoice)	Value of extension
identifier
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Transaction Number
value	S	0..1	string	The value that is unique
status	S	1..1	code	active | cancelled | draft | entered-in-error Required Pattern: active
created	S	1..1	dateTime	Creation date
disposition	SC	0..1	string	Disposition message dppr-31-1982: If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01)
paymentDate	S	1..1	date	When payment issued
paymentAmount
value	S	0..1	decimal	Numerical value (with implicit precision)
currency	S	0..1	code	ISO 4217 Currency Code Required Pattern: USD
paymentIdentifier	S	0..1	Identifier	Business identifier for the payment
Slices for detail		0..*	BackboneElement	Settlement particulars Slice: Unordered, Open by value:$this
detail:va-principal-collected		0..1	BackboneElement	Settlement particulars
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Principal Collected
amount	S	0..1	Money	Amount allocated to this payable
detail:va-interest-collected		0..1	BackboneElement	Settlement particulars
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Interest Collected
amount	S	0..1	Money	Amount allocated to this payable
detail:va-admin-collected		0..1	BackboneElement	Settlement particulars
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Administrative Charge Collected
amount	S	0..1	Money	Amount allocated to this payable
detail:va-marshal-collected		0..1	BackboneElement	Settlement particulars
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Marshal Fee Collected
amount	S	0..1	Money	Amount allocated to this payable
detail:va-courtcost-collected		0..1	BackboneElement	Settlement particulars
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Court Cost Collected
amount	S	0..1	Money	Amount allocated to this payable
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
dppr-31-1982	warning	PaymentReconciliation.disposition	If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01) : true

Name	Flags	Card.	Type	Description & Constraints
PaymentReconciliation		0..*	PaymentReconciliation	PaymentReconciliation resource
id	Σ	0..1	id	Logical id of this artifact
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:extension-PaymentReconciliation-paymentIssuer		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer"
value[x]	S	1..1	Reference(Debt Portal Patient)	Value of extension
extension:extension-PaymentReconciliation-allocation-identifier		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier"
value[x]		1..1	Identifier	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Bill Number
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
extension:extension-PaymentReconciliation-allocation-target		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target"
value[x]	S	1..1	Reference(Debt Portal Invoice)	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business Identifier for a payment reconciliation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Transaction Number
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active
period	Σ	0..1	Period	Period covered
created	SΣ	1..1	dateTime	Creation date
paymentIssuer	Σ	0..1	Reference(Organization)	Party generating payment
request		0..1	Reference(Task)	Reference to requesting resource
requestor		0..1	Reference(Practitioner | PractitionerRole | Organization)	Responsible practitioner
outcome		0..1	code	queued | complete | error | partial Binding: ClaimProcessingCodes (required): The outcome of the processing.
disposition	SC	0..1	string	Disposition message dppr-31-1982: If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01)
paymentDate	SΣ	1..1	date	When payment issued
paymentAmount	Σ	1..1	Money	Total amount of Payment
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
value	SΣ	0..1	decimal	Numerical value (with implicit precision)
currency	SΣ	0..1	code	ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Required Pattern: USD
paymentIdentifier	S	0..1	Identifier	Business identifier for the payment
Slices for detail		0..*	BackboneElement	Settlement particulars Slice: Unordered, Open by value:$this
detail:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	Identifier	Business identifier of the payment detail
predecessor		0..1	Identifier	Business identifier of the prior payment detail
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
request		0..1	Reference(Resource)	Request giving rise to the payment
submitter		0..1	Reference(Practitioner | PractitionerRole | Organization)	Submitter of the request
response		0..1	Reference(Resource)	Response committing to a payment
date		0..1	date	Date of commitment to pay
responsible		0..1	Reference(PractitionerRole)	Contact for the response
payee		0..1	Reference(Practitioner | PractitionerRole | Organization)	Recipient of the payment
amount		0..1	Money	Amount allocated to this payable
detail:va-principal-collected		0..1	BackboneElement	Settlement particulars
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	Identifier	Business identifier of the payment detail
predecessor		0..1	Identifier	Business identifier of the prior payment detail
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Principal Collected
request		0..1	Reference(Resource)	Request giving rise to the payment
submitter		0..1	Reference(Practitioner | PractitionerRole | Organization)	Submitter of the request
response		0..1	Reference(Resource)	Response committing to a payment
date		0..1	date	Date of commitment to pay
responsible		0..1	Reference(PractitionerRole)	Contact for the response
payee		0..1	Reference(Practitioner | PractitionerRole | Organization)	Recipient of the payment
amount	S	0..1	Money	Amount allocated to this payable
detail:va-interest-collected		0..1	BackboneElement	Settlement particulars
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	Identifier	Business identifier of the payment detail
predecessor		0..1	Identifier	Business identifier of the prior payment detail
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Interest Collected
request		0..1	Reference(Resource)	Request giving rise to the payment
submitter		0..1	Reference(Practitioner | PractitionerRole | Organization)	Submitter of the request
response		0..1	Reference(Resource)	Response committing to a payment
date		0..1	date	Date of commitment to pay
responsible		0..1	Reference(PractitionerRole)	Contact for the response
payee		0..1	Reference(Practitioner | PractitionerRole | Organization)	Recipient of the payment
amount	S	0..1	Money	Amount allocated to this payable
detail:va-admin-collected		0..1	BackboneElement	Settlement particulars
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	Identifier	Business identifier of the payment detail
predecessor		0..1	Identifier	Business identifier of the prior payment detail
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Administrative Charge Collected
request		0..1	Reference(Resource)	Request giving rise to the payment
submitter		0..1	Reference(Practitioner | PractitionerRole | Organization)	Submitter of the request
response		0..1	Reference(Resource)	Response committing to a payment
date		0..1	date	Date of commitment to pay
responsible		0..1	Reference(PractitionerRole)	Contact for the response
payee		0..1	Reference(Practitioner | PractitionerRole | Organization)	Recipient of the payment
amount	S	0..1	Money	Amount allocated to this payable
detail:va-marshal-collected		0..1	BackboneElement	Settlement particulars
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	Identifier	Business identifier of the payment detail
predecessor		0..1	Identifier	Business identifier of the prior payment detail
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Marshal Fee Collected
request		0..1	Reference(Resource)	Request giving rise to the payment
submitter		0..1	Reference(Practitioner | PractitionerRole | Organization)	Submitter of the request
response		0..1	Reference(Resource)	Response committing to a payment
date		0..1	date	Date of commitment to pay
responsible		0..1	Reference(PractitionerRole)	Contact for the response
payee		0..1	Reference(Practitioner | PractitionerRole | Organization)	Recipient of the payment
amount	S	0..1	Money	Amount allocated to this payable
detail:va-courtcost-collected		0..1	BackboneElement	Settlement particulars
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	Identifier	Business identifier of the payment detail
predecessor		0..1	Identifier	Business identifier of the prior payment detail
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Court Cost Collected
request		0..1	Reference(Resource)	Request giving rise to the payment
submitter		0..1	Reference(Practitioner | PractitionerRole | Organization)	Submitter of the request
response		0..1	Reference(Resource)	Response committing to a payment
date		0..1	date	Date of commitment to pay
responsible		0..1	Reference(PractitionerRole)	Contact for the response
payee		0..1	Reference(Practitioner | PractitionerRole | Organization)	Recipient of the payment
amount	S	0..1	Money	Amount allocated to this payable
formCode		0..1	CodeableConcept	Printed form identifier Binding: Form Codes (example): The forms codes.
processNote		0..*	BackboneElement	Note concerning processing
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	code	display | print | printoper Binding: NoteType (required): The presentation types of notes.
text		0..1	string	Note explanatory text
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PaymentReconciliation.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
PaymentReconciliation.extension:extension-PaymentReconciliation-allocation-identifier.value[x].use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PaymentReconciliation.extension:extension-PaymentReconciliation-allocation-identifier.value[x].type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
PaymentReconciliation.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PaymentReconciliation.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
PaymentReconciliation.status	required	Pattern: active http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
PaymentReconciliation.outcome	required	ClaimProcessingCodes http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 from the FHIR Standard
PaymentReconciliation.paymentAmount.currency	required	Pattern: USD http://hl7.org/fhir/ValueSet/currencies|4.0.1 from the FHIR Standard
PaymentReconciliation.detail.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-principal-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-interest-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-admin-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-marshal-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-courtcost-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.formCode	example	Form Codes http://hl7.org/fhir/ValueSet/forms from the FHIR Standard
PaymentReconciliation.processNote.type	required	NoteType http://hl7.org/fhir/ValueSet/note-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PaymentReconciliation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PaymentReconciliation	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	PaymentReconciliation	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	PaymentReconciliation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PaymentReconciliation	A resource should have narrative for robust management : text.`div`.exists()
dppr-31-1982	warning	PaymentReconciliation.disposition	If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01) : true
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 PaymentReconciliation

Summary

Must-Support: 23 elements

Structures

This structure refers to these other structures:

• Debt Portal Patient (http://va.gov/fhir/StructureDefinition/DebtPortalPatient)
• Debt Portal Invoice (http://va.gov/fhir/StructureDefinition/DebtPortalInvoice)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer
• http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier
• http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of PaymentReconciliation.detail

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PaymentReconciliation		0..*	PaymentReconciliation	PaymentReconciliation resource 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
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
Slices for extension		0..*	Extension	Extension 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
extension:extension-PaymentReconciliation-paymentIssuer		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer"
value[x]	S	1..1	Reference(Debt Portal Patient)	Value of extension ele-1: All FHIR elements must have a @value or children
extension:extension-PaymentReconciliation-allocation-identifier		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier"
value[x]		1..1	Identifier	Value of extension ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Bill Number
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
extension:extension-PaymentReconciliation-allocation-target		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target"
value[x]	S	1..1	Reference(Debt Portal Invoice)	Value of extension ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier		0..*	Identifier	Business Identifier for a payment reconciliation ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Transaction Number
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
status	?!SΣ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. ele-1: All FHIR elements must have a @value or children Required Pattern: active
created	SΣ	1..1	dateTime	Creation date ele-1: All FHIR elements must have a @value or children
disposition	SC	0..1	string	Disposition message ele-1: All FHIR elements must have a @value or children dppr-31-1982: If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01)
paymentDate	SΣ	1..1	date	When payment issued ele-1: All FHIR elements must have a @value or children
paymentAmount	Σ	1..1	Money	Total amount of Payment ele-1: All FHIR elements must have a @value or children
value	SΣ	0..1	decimal	Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children
currency	SΣ	0..1	code	ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. ele-1: All FHIR elements must have a @value or children Required Pattern: USD
paymentIdentifier	S	0..1	Identifier	Business identifier for the payment ele-1: All FHIR elements must have a @value or children
Slices for detail		0..*	BackboneElement	Settlement particulars Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children
detail:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance. ele-1: All FHIR elements must have a @value or children
detail:va-principal-collected		0..1	BackboneElement	Settlement particulars ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Principal Collected
amount	S	0..1	Money	Amount allocated to this payable ele-1: All FHIR elements must have a @value or children
detail:va-interest-collected		0..1	BackboneElement	Settlement particulars ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Interest Collected
amount	S	0..1	Money	Amount allocated to this payable ele-1: All FHIR elements must have a @value or children
detail:va-admin-collected		0..1	BackboneElement	Settlement particulars ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Administrative Charge Collected
amount	S	0..1	Money	Amount allocated to this payable ele-1: All FHIR elements must have a @value or children
detail:va-marshal-collected		0..1	BackboneElement	Settlement particulars ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Marshal Fee Collected
amount	S	0..1	Money	Amount allocated to this payable ele-1: All FHIR elements must have a @value or children
detail:va-courtcost-collected		0..1	BackboneElement	Settlement particulars ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Plain text representation of the concept ele-1: All FHIR elements must have a @value or children Required Pattern: Court Cost Collected
amount	S	0..1	Money	Amount allocated to this payable ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PaymentReconciliation.extension:extension-PaymentReconciliation-allocation-identifier.value[x].use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PaymentReconciliation.extension:extension-PaymentReconciliation-allocation-identifier.value[x].type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
PaymentReconciliation.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PaymentReconciliation.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
PaymentReconciliation.status	required	Pattern: active http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
PaymentReconciliation.paymentAmount.currency	required	Pattern: USD http://hl7.org/fhir/ValueSet/currencies|4.0.1 from the FHIR Standard
PaymentReconciliation.detail.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-principal-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-interest-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-admin-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-marshal-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-courtcost-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PaymentReconciliation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PaymentReconciliation	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	PaymentReconciliation	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	PaymentReconciliation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PaymentReconciliation	A resource should have narrative for robust management : text.`div`.exists()
dppr-31-1982	warning	PaymentReconciliation.disposition	If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01) : true
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 PaymentReconciliation

Name	Flags	Card.	Type	Description & Constraints
PaymentReconciliation		0..*	PaymentReconciliation	PaymentReconciliation resource
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:extension-PaymentReconciliation-paymentIssuer		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer
value[x]	S	1..1	Reference(Debt Portal Patient)	Value of extension
extension:extension-PaymentReconciliation-allocation-identifier		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier
value[x]
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Bill Number
value	S	0..1	string	The value that is unique
extension:extension-PaymentReconciliation-allocation-target		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target
value[x]	S	1..1	Reference(Debt Portal Invoice)	Value of extension
identifier
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Transaction Number
value	S	0..1	string	The value that is unique
status	S	1..1	code	active | cancelled | draft | entered-in-error Required Pattern: active
created	S	1..1	dateTime	Creation date
disposition	SC	0..1	string	Disposition message dppr-31-1982: If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01)
paymentDate	S	1..1	date	When payment issued
paymentAmount
value	S	0..1	decimal	Numerical value (with implicit precision)
currency	S	0..1	code	ISO 4217 Currency Code Required Pattern: USD
paymentIdentifier	S	0..1	Identifier	Business identifier for the payment
Slices for detail		0..*	BackboneElement	Settlement particulars Slice: Unordered, Open by value:$this
detail:va-principal-collected		0..1	BackboneElement	Settlement particulars
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Principal Collected
amount	S	0..1	Money	Amount allocated to this payable
detail:va-interest-collected		0..1	BackboneElement	Settlement particulars
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Interest Collected
amount	S	0..1	Money	Amount allocated to this payable
detail:va-admin-collected		0..1	BackboneElement	Settlement particulars
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Administrative Charge Collected
amount	S	0..1	Money	Amount allocated to this payable
detail:va-marshal-collected		0..1	BackboneElement	Settlement particulars
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Marshal Fee Collected
amount	S	0..1	Money	Amount allocated to this payable
detail:va-courtcost-collected		0..1	BackboneElement	Settlement particulars
type
text	S	0..1	string	Plain text representation of the concept Required Pattern: Court Cost Collected
amount	S	0..1	Money	Amount allocated to this payable
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
dppr-31-1982	warning	PaymentReconciliation.disposition	If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01) : true

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PaymentReconciliation		0..*	PaymentReconciliation	PaymentReconciliation resource
id	Σ	0..1	id	Logical id of this artifact
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:extension-PaymentReconciliation-paymentIssuer		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer"
value[x]	S	1..1	Reference(Debt Portal Patient)	Value of extension
extension:extension-PaymentReconciliation-allocation-identifier		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier"
value[x]		1..1	Identifier	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Bill Number
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
extension:extension-PaymentReconciliation-allocation-target		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target"
value[x]	S	1..1	Reference(Debt Portal Invoice)	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business Identifier for a payment reconciliation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Transaction Number
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. Required Pattern: active
period	Σ	0..1	Period	Period covered
created	SΣ	1..1	dateTime	Creation date
paymentIssuer	Σ	0..1	Reference(Organization)	Party generating payment
request		0..1	Reference(Task)	Reference to requesting resource
requestor		0..1	Reference(Practitioner | PractitionerRole | Organization)	Responsible practitioner
outcome		0..1	code	queued | complete | error | partial Binding: ClaimProcessingCodes (required): The outcome of the processing.
disposition	SC	0..1	string	Disposition message dppr-31-1982: If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01)
paymentDate	SΣ	1..1	date	When payment issued
paymentAmount	Σ	1..1	Money	Total amount of Payment
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
value	SΣ	0..1	decimal	Numerical value (with implicit precision)
currency	SΣ	0..1	code	ISO 4217 Currency Code Binding: Currencies (required): A code indicating the currency, taken from ISO 4217. Required Pattern: USD
paymentIdentifier	S	0..1	Identifier	Business identifier for the payment
Slices for detail		0..*	BackboneElement	Settlement particulars Slice: Unordered, Open by value:$this
detail:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	Identifier	Business identifier of the payment detail
predecessor		0..1	Identifier	Business identifier of the prior payment detail
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
request		0..1	Reference(Resource)	Request giving rise to the payment
submitter		0..1	Reference(Practitioner | PractitionerRole | Organization)	Submitter of the request
response		0..1	Reference(Resource)	Response committing to a payment
date		0..1	date	Date of commitment to pay
responsible		0..1	Reference(PractitionerRole)	Contact for the response
payee		0..1	Reference(Practitioner | PractitionerRole | Organization)	Recipient of the payment
amount		0..1	Money	Amount allocated to this payable
detail:va-principal-collected		0..1	BackboneElement	Settlement particulars
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	Identifier	Business identifier of the payment detail
predecessor		0..1	Identifier	Business identifier of the prior payment detail
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Principal Collected
request		0..1	Reference(Resource)	Request giving rise to the payment
submitter		0..1	Reference(Practitioner | PractitionerRole | Organization)	Submitter of the request
response		0..1	Reference(Resource)	Response committing to a payment
date		0..1	date	Date of commitment to pay
responsible		0..1	Reference(PractitionerRole)	Contact for the response
payee		0..1	Reference(Practitioner | PractitionerRole | Organization)	Recipient of the payment
amount	S	0..1	Money	Amount allocated to this payable
detail:va-interest-collected		0..1	BackboneElement	Settlement particulars
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	Identifier	Business identifier of the payment detail
predecessor		0..1	Identifier	Business identifier of the prior payment detail
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Interest Collected
request		0..1	Reference(Resource)	Request giving rise to the payment
submitter		0..1	Reference(Practitioner | PractitionerRole | Organization)	Submitter of the request
response		0..1	Reference(Resource)	Response committing to a payment
date		0..1	date	Date of commitment to pay
responsible		0..1	Reference(PractitionerRole)	Contact for the response
payee		0..1	Reference(Practitioner | PractitionerRole | Organization)	Recipient of the payment
amount	S	0..1	Money	Amount allocated to this payable
detail:va-admin-collected		0..1	BackboneElement	Settlement particulars
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	Identifier	Business identifier of the payment detail
predecessor		0..1	Identifier	Business identifier of the prior payment detail
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Administrative Charge Collected
request		0..1	Reference(Resource)	Request giving rise to the payment
submitter		0..1	Reference(Practitioner | PractitionerRole | Organization)	Submitter of the request
response		0..1	Reference(Resource)	Response committing to a payment
date		0..1	date	Date of commitment to pay
responsible		0..1	Reference(PractitionerRole)	Contact for the response
payee		0..1	Reference(Practitioner | PractitionerRole | Organization)	Recipient of the payment
amount	S	0..1	Money	Amount allocated to this payable
detail:va-marshal-collected		0..1	BackboneElement	Settlement particulars
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	Identifier	Business identifier of the payment detail
predecessor		0..1	Identifier	Business identifier of the prior payment detail
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Marshal Fee Collected
request		0..1	Reference(Resource)	Request giving rise to the payment
submitter		0..1	Reference(Practitioner | PractitionerRole | Organization)	Submitter of the request
response		0..1	Reference(Resource)	Response committing to a payment
date		0..1	date	Date of commitment to pay
responsible		0..1	Reference(PractitionerRole)	Contact for the response
payee		0..1	Reference(Practitioner | PractitionerRole | Organization)	Recipient of the payment
amount	S	0..1	Money	Amount allocated to this payable
detail:va-courtcost-collected		0..1	BackboneElement	Settlement particulars
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier		0..1	Identifier	Business identifier of the payment detail
predecessor		0..1	Identifier	Business identifier of the prior payment detail
type		1..1	CodeableConcept	Category of payment Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept Required Pattern: Court Cost Collected
request		0..1	Reference(Resource)	Request giving rise to the payment
submitter		0..1	Reference(Practitioner | PractitionerRole | Organization)	Submitter of the request
response		0..1	Reference(Resource)	Response committing to a payment
date		0..1	date	Date of commitment to pay
responsible		0..1	Reference(PractitionerRole)	Contact for the response
payee		0..1	Reference(Practitioner | PractitionerRole | Organization)	Recipient of the payment
amount	S	0..1	Money	Amount allocated to this payable
formCode		0..1	CodeableConcept	Printed form identifier Binding: Form Codes (example): The forms codes.
processNote		0..*	BackboneElement	Note concerning processing
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	code	display | print | printoper Binding: NoteType (required): The presentation types of notes.
text		0..1	string	Note explanatory text
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PaymentReconciliation.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
PaymentReconciliation.extension:extension-PaymentReconciliation-allocation-identifier.value[x].use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PaymentReconciliation.extension:extension-PaymentReconciliation-allocation-identifier.value[x].type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
PaymentReconciliation.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PaymentReconciliation.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
PaymentReconciliation.status	required	Pattern: active http://hl7.org/fhir/ValueSet/fm-status|4.0.1 from the FHIR Standard
PaymentReconciliation.outcome	required	ClaimProcessingCodes http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1 from the FHIR Standard
PaymentReconciliation.paymentAmount.currency	required	Pattern: USD http://hl7.org/fhir/ValueSet/currencies|4.0.1 from the FHIR Standard
PaymentReconciliation.detail.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-principal-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-interest-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-admin-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-marshal-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.detail:va-courtcost-collected.type	example	PaymentTypeCodes http://hl7.org/fhir/ValueSet/payment-type from the FHIR Standard
PaymentReconciliation.formCode	example	Form Codes http://hl7.org/fhir/ValueSet/forms from the FHIR Standard
PaymentReconciliation.processNote.type	required	NoteType http://hl7.org/fhir/ValueSet/note-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PaymentReconciliation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PaymentReconciliation	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	PaymentReconciliation	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	PaymentReconciliation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PaymentReconciliation	A resource should have narrative for robust management : text.`div`.exists()
dppr-31-1982	warning	PaymentReconciliation.disposition	If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01) : true
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 PaymentReconciliation

Summary

Must-Support: 23 elements

Structures

This structure refers to these other structures:

• Debt Portal Patient (http://va.gov/fhir/StructureDefinition/DebtPortalPatient)
• Debt Portal Invoice (http://va.gov/fhir/StructureDefinition/DebtPortalInvoice)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer
• http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier
• http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of PaymentReconciliation.detail