FHIR Implementation Guide for HCX
0.0.1 - CI Build
FHIR Implementation Guide for HCX
0.0.1 - CI Build
FHIR Implementation Guide for HCX - Local Development build (v0.0.1). See the Directory of published versions
| Defining URL: | http://hl7.org/fhir/StructureDefinition/HCXPaymentReconciliation |
| Version: | 0.0.1 |
| Name: | PaymentReconciliation |
| Status: | Draft as of 2021-08-16T22:29:23+11:00 (Standards Status: Trial Use) |
| Definition: | This resource provides the details including amount of a payment and allocates the payment items being paid. |
| Publisher: | HL7 International - HCX |
| Committee: | Financial Management |
| Maturity: | 2 |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/HCXPaymentReconciliation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PaymentReconciliation
This structure is derived from PaymentReconciliation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PaymentReconciliation | 0..* | PaymentReconciliation | PaymentReconciliation resource | |
  identifier | 0..* | Identifier | Business Identifier for a payment reconciliation | |
 status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
| period | Σ | 0..1 | Period | Period covered |
| created | Σ | 1..1 | dateTime | Creation date |
 paymentIssuer | Σ | 0..1 | Reference(Organization) | Party generating payment |
| request | 0..1 | Reference(Task) | Reference to requesting resource | |
| requestor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | |
| outcome | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The outcome of the processing. | |
| disposition | 0..1 | string | Disposition message | |
| paymentDate | Σ | 1..1 | date | When payment issued |
| paymentAmount | Σ | 1..1 | Money | Total amount of Payment |
| paymentIdentifier | 1..1 | Identifier | Business identifier for the payment | |
 detail | 0..* | BackboneElement | Settlement particulars | |
 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 | |
| formCode | 0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (example): The forms codes. | |
 processNote | 0..* | BackboneElement | Note concerning processing | |
 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentReconciliation | 0..* | PaymentReconciliation | PaymentReconciliation resource | |
| 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) Max Binding: AllLanguages: A human language. | |
| 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 | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | Business Identifier for a payment reconciliation | |
| status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
| period | Σ | 0..1 | Period | Period covered |
| created | Σ | 1..1 | dateTime | Creation date |
| paymentIssuer | Σ | 0..1 | Reference(Organization) | Party generating payment |
| request | 0..1 | Reference(Task) | Reference to requesting resource | |
| requestor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | |
| outcome | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The outcome of the processing. | |
| disposition | 0..1 | string | Disposition message | |
| paymentDate | Σ | 1..1 | date | When payment issued |
| paymentAmount | Σ | 1..1 | Money | Total amount of Payment |
| paymentIdentifier | 1..1 | Identifier | Business identifier for the payment | |
| detail | 0..* | BackboneElement | Settlement particulars | |
| 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 | |
| formCode | 0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (example): The forms codes. | |
| processNote | 0..* | BackboneElement | Note concerning processing | |
| 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentReconciliation | 0..* | PaymentReconciliation | PaymentReconciliation resource | |
| Documentation for this format | ||||
This structure is derived from PaymentReconciliation
Differential View
This structure is derived from PaymentReconciliation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentReconciliation | 0..* | PaymentReconciliation | PaymentReconciliation resource | |
| identifier | 0..* | Identifier | Business Identifier for a payment reconciliation | |
| status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
| period | Σ | 0..1 | Period | Period covered |
| created | Σ | 1..1 | dateTime | Creation date |
| paymentIssuer | Σ | 0..1 | Reference(Organization) | Party generating payment |
| request | 0..1 | Reference(Task) | Reference to requesting resource | |
| requestor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | |
| outcome | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The outcome of the processing. | |
| disposition | 0..1 | string | Disposition message | |
| paymentDate | Σ | 1..1 | date | When payment issued |
| paymentAmount | Σ | 1..1 | Money | Total amount of Payment |
| paymentIdentifier | 1..1 | Identifier | Business identifier for the payment | |
| detail | 0..* | BackboneElement | Settlement particulars | |
| 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 | |
| formCode | 0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (example): The forms codes. | |
| processNote | 0..* | BackboneElement | Note concerning processing | |
| 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 | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PaymentReconciliation | 0..* | PaymentReconciliation | PaymentReconciliation resource | |
| 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) Max Binding: AllLanguages: A human language. | |
| 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 | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | Business Identifier for a payment reconciliation | |
| status | ?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
| period | Σ | 0..1 | Period | Period covered |
| created | Σ | 1..1 | dateTime | Creation date |
| paymentIssuer | Σ | 0..1 | Reference(Organization) | Party generating payment |
| request | 0..1 | Reference(Task) | Reference to requesting resource | |
| requestor | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Responsible practitioner | |
| outcome | 1..1 | code | queued | complete | error | partial Binding: ClaimProcessingCodes (required): The outcome of the processing. | |
| disposition | 0..1 | string | Disposition message | |
| paymentDate | Σ | 1..1 | date | When payment issued |
| paymentAmount | Σ | 1..1 | Money | Total amount of Payment |
| paymentIdentifier | 1..1 | Identifier | Business identifier for the payment | |
| detail | 0..* | BackboneElement | Settlement particulars | |
| 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 | |
| formCode | 0..1 | CodeableConcept | Printed form identifier Binding: Form Codes (example): The forms codes. | |
| processNote | 0..* | BackboneElement | Note concerning processing | |
| 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 | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| PaymentReconciliation.language | preferred | CommonLanguages Max Binding: AllLanguages |
| PaymentReconciliation.status | required | FinancialResourceStatusCodes |
| PaymentReconciliation.outcome | required | ClaimProcessingCodes |
| PaymentReconciliation.detail.type | example | PaymentTypeCodes |
| PaymentReconciliation.formCode | example | Form Codes |
| PaymentReconciliation.processNote.type | required | NoteType |
| Id | Path | Details | Requirements |
| dom-2 | PaymentReconciliation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | PaymentReconciliation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | PaymentReconciliation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | PaymentReconciliation.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PaymentReconciliation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PaymentReconciliation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PaymentReconciliation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PaymentReconciliation.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.created | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.paymentIssuer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.request | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.requestor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.outcome | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.disposition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.paymentDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.paymentAmount | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.paymentIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.detail | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.detail.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PaymentReconciliation.detail.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PaymentReconciliation.detail.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PaymentReconciliation.detail.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PaymentReconciliation.detail.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.detail.predecessor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.detail.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.detail.request | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.detail.submitter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.detail.response | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.detail.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.detail.responsible | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.detail.payee | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.detail.amount | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.formCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.processNote | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.processNote.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PaymentReconciliation.processNote.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PaymentReconciliation.processNote.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | PaymentReconciliation.processNote.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | PaymentReconciliation.processNote.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | PaymentReconciliation.processNote.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |