Medtech ALEX® Implementation Guide
0.0.1 - draft International flag

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

Resource Profile: ALEX Account Credit (Unallocated Prepayment)

Official URL: https://fhir.medtechglobal.com/StructureDefinition/paymentreconciliation-credit Version: 0.0.1
Draft as of 2026-04-17 Computable Name: MedtechPaymentReconciliationCredit

FHIR PaymentReconciliation profile for unallocated prepayments (account credit) created in ALEX.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation C 0..* PaymentReconciliation PaymentReconciliation resource
Constraints: pr-amount-positive, pr-note-max-length
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:location 1..1 Reference(Location) Payment Location
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-location
.... extension:patient 1..1 Reference(Patient) Payment Patient
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-patient
.... extension:method 1..1 CodeableConcept Payment Method
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-method
.... extension:annotation 0..1 Attachment Payment Annotation
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-annotation
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... created Σ 1..1 dateTime Creation date
... requestor 1..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner
... paymentDate Σ 1..1 date When payment issued
... paymentAmount Σ 1..1 Money Total amount of Payment
.... currency Σ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Fixed Value: NZD
... detail 1..1 BackboneElement Settlement particulars
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
...... coding:paymentType Σ 1..1 Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/payment-type
....... code Σ 0..1 code Symbol in syntax defined by the system
Fixed Value: advance
... processNote 1..1 BackboneElement Note concerning processing
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text 1..1 string Note explanatory text

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PaymentReconciliation.​status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​paymentAmount.currency Base required CurrencyCode 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail.type Base example Payment Type Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
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()
pr-amount-positive error PaymentReconciliation Payment amount must be greater than zero paymentAmount.exists() implies paymentAmount.value > 0
pr-note-max-length error PaymentReconciliation Process note text must not exceed 50 characters processNote.text.exists() implies processNote.text.length() <= 50

This structure is derived from PaymentReconciliation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation C 0..* PaymentReconciliation PaymentReconciliation resource
Constraints: pr-amount-positive, pr-note-max-length
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:location 1..1 Reference(Location) Payment Location
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-location
.... extension:patient 1..1 Reference(Patient) Payment Patient
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-patient
.... extension:method 1..1 CodeableConcept Payment Method
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-method
.... extension:annotation 0..1 Attachment Payment Annotation
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-annotation
.... extension:acholder 0..0 Reference(Patient) Account Holder Patient
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-acholder-patient
... status 1..1 code active | cancelled | draft | entered-in-error
Fixed Value: active
... created 1..1 dateTime Creation date
... paymentDate 1..1 date When payment issued
... paymentAmount
.... currency 0..1 code ISO 4217 Currency Code
Fixed Value: NZD
... detail 1..1 BackboneElement Settlement particulars
.... type
..... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
...... coding:paymentType 1..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/payment-type
....... code 0..1 code Symbol in syntax defined by the system
Fixed Value: advance
.... payee 0..0 Recipient of the payment
... processNote 1..1 BackboneElement Note concerning processing
.... text 1..1 string Note explanatory text

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pr-amount-positive error PaymentReconciliation Payment amount must be greater than zero paymentAmount.exists() implies paymentAmount.value > 0
pr-note-max-length error PaymentReconciliation Process note text must not exceed 50 characters processNote.text.exists() implies processNote.text.length() <= 50
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation C 0..* PaymentReconciliation PaymentReconciliation resource
Constraints: pr-amount-positive, pr-note-max-length
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:location 1..1 Reference(Location) Payment Location
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-location
.... extension:patient 1..1 Reference(Patient) Payment Patient
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-patient
.... extension:method 1..1 CodeableConcept Payment Method
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-method
.... extension:annotation 0..1 Attachment Payment Annotation
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-annotation
... 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.
Fixed Value: active
... 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 0..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
.... 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 Σ 0..1 decimal Numerical value (with implicit precision)
.... currency Σ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Fixed Value: NZD
... paymentIdentifier 0..1 Identifier Business identifier for the payment
... detail 1..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
..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
...... coding:paymentType Σ 1..1 Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/payment-type
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Fixed Value: advance
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... 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
.... amount 0..1 Money Amount allocated to this payable
... formCode 0..1 CodeableConcept Printed form identifier
Binding: Form Codes (example): The forms codes.
... processNote 1..1 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 1..1 string Note explanatory text

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PaymentReconciliation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
PaymentReconciliation.​status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​outcome Base required Claim Processing Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​paymentAmount.currency Base required CurrencyCode 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail.type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​formCode Base example Forms 📍4.0.1 FHIR Std.
PaymentReconciliation.​processNote.type Base required NoteType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
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()
pr-amount-positive error PaymentReconciliation Payment amount must be greater than zero paymentAmount.exists() implies paymentAmount.value > 0
pr-note-max-length error PaymentReconciliation Process note text must not exceed 50 characters processNote.text.exists() implies processNote.text.length() <= 50

This structure is derived from PaymentReconciliation

Summary

Mandatory: 10 elements
Fixed: 4 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PaymentReconciliation.detail.type.coding (Closed)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation C 0..* PaymentReconciliation PaymentReconciliation resource
Constraints: pr-amount-positive, pr-note-max-length
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:location 1..1 Reference(Location) Payment Location
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-location
.... extension:patient 1..1 Reference(Patient) Payment Patient
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-patient
.... extension:method 1..1 CodeableConcept Payment Method
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-method
.... extension:annotation 0..1 Attachment Payment Annotation
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-annotation
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... created Σ 1..1 dateTime Creation date
... requestor 1..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner
... paymentDate Σ 1..1 date When payment issued
... paymentAmount Σ 1..1 Money Total amount of Payment
.... currency Σ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Fixed Value: NZD
... detail 1..1 BackboneElement Settlement particulars
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
...... coding:paymentType Σ 1..1 Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/payment-type
....... code Σ 0..1 code Symbol in syntax defined by the system
Fixed Value: advance
... processNote 1..1 BackboneElement Note concerning processing
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text 1..1 string Note explanatory text

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PaymentReconciliation.​status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​paymentAmount.currency Base required CurrencyCode 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail.type Base example Payment Type Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
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()
pr-amount-positive error PaymentReconciliation Payment amount must be greater than zero paymentAmount.exists() implies paymentAmount.value > 0
pr-note-max-length error PaymentReconciliation Process note text must not exceed 50 characters processNote.text.exists() implies processNote.text.length() <= 50

Differential View

This structure is derived from PaymentReconciliation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation C 0..* PaymentReconciliation PaymentReconciliation resource
Constraints: pr-amount-positive, pr-note-max-length
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:location 1..1 Reference(Location) Payment Location
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-location
.... extension:patient 1..1 Reference(Patient) Payment Patient
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-patient
.... extension:method 1..1 CodeableConcept Payment Method
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-method
.... extension:annotation 0..1 Attachment Payment Annotation
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-annotation
.... extension:acholder 0..0 Reference(Patient) Account Holder Patient
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-acholder-patient
... status 1..1 code active | cancelled | draft | entered-in-error
Fixed Value: active
... created 1..1 dateTime Creation date
... paymentDate 1..1 date When payment issued
... paymentAmount
.... currency 0..1 code ISO 4217 Currency Code
Fixed Value: NZD
... detail 1..1 BackboneElement Settlement particulars
.... type
..... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
...... coding:paymentType 1..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/payment-type
....... code 0..1 code Symbol in syntax defined by the system
Fixed Value: advance
.... payee 0..0 Recipient of the payment
... processNote 1..1 BackboneElement Note concerning processing
.... text 1..1 string Note explanatory text

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pr-amount-positive error PaymentReconciliation Payment amount must be greater than zero paymentAmount.exists() implies paymentAmount.value > 0
pr-note-max-length error PaymentReconciliation Process note text must not exceed 50 characters processNote.text.exists() implies processNote.text.length() <= 50

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation C 0..* PaymentReconciliation PaymentReconciliation resource
Constraints: pr-amount-positive, pr-note-max-length
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:location 1..1 Reference(Location) Payment Location
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-location
.... extension:patient 1..1 Reference(Patient) Payment Patient
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-patient
.... extension:method 1..1 CodeableConcept Payment Method
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-method
.... extension:annotation 0..1 Attachment Payment Annotation
URL: https://alexapi.medtechglobal.com/fhir/StructureDefinition/payment-annotation
... 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.
Fixed Value: active
... 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 0..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
.... 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 Σ 0..1 decimal Numerical value (with implicit precision)
.... currency Σ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Fixed Value: NZD
... paymentIdentifier 0..1 Identifier Business identifier for the payment
... detail 1..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
..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
...... coding:paymentType Σ 1..1 Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/payment-type
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Fixed Value: advance
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... 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
.... amount 0..1 Money Amount allocated to this payable
... formCode 0..1 CodeableConcept Printed form identifier
Binding: Form Codes (example): The forms codes.
... processNote 1..1 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 1..1 string Note explanatory text

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PaymentReconciliation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
PaymentReconciliation.​status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​outcome Base required Claim Processing Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​paymentAmount.currency Base required CurrencyCode 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail.type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​formCode Base example Forms 📍4.0.1 FHIR Std.
PaymentReconciliation.​processNote.type Base required NoteType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
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()
pr-amount-positive error PaymentReconciliation Payment amount must be greater than zero paymentAmount.exists() implies paymentAmount.value > 0
pr-note-max-length error PaymentReconciliation Process note text must not exceed 50 characters processNote.text.exists() implies processNote.text.length() <= 50

This structure is derived from PaymentReconciliation

Summary

Mandatory: 10 elements
Fixed: 4 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PaymentReconciliation.detail.type.coding (Closed)

 

Other representations of profile: CSV, Excel, Schematron