Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-PaymentReconciliation | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_PaymentReconciliation_R4 | ||
This cross-version profile allows R5 PaymentReconciliation content to be represented via FHIR R4 PaymentReconciliation resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| PaymentReconciliation.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
| 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 | PaymentReconciliation.implicitRules, PaymentReconciliation.extension, PaymentReconciliation.extension:type, PaymentReconciliation.extension:kind, PaymentReconciliation.extension:enterer, PaymentReconciliation.extension:issuerType, PaymentReconciliation.extension:location, PaymentReconciliation.extension:method, PaymentReconciliation.extension:cardBrand, PaymentReconciliation.extension:accountNumber, PaymentReconciliation.extension:expirationDate, PaymentReconciliation.extension:processor, PaymentReconciliation.extension:referenceNumber, PaymentReconciliation.extension:authorization, PaymentReconciliation.extension:tenderedAmount, PaymentReconciliation.extension:returnedAmount, PaymentReconciliation.modifierExtension, PaymentReconciliation.status, PaymentReconciliation.created, PaymentReconciliation.paymentDate, PaymentReconciliation.paymentAmount | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PaymentReconciliation.extension, PaymentReconciliation.extension:type, PaymentReconciliation.extension:kind, PaymentReconciliation.extension:enterer, PaymentReconciliation.extension:issuerType, PaymentReconciliation.extension:location, PaymentReconciliation.extension:method, PaymentReconciliation.extension:cardBrand, PaymentReconciliation.extension:accountNumber, PaymentReconciliation.extension:expirationDate, PaymentReconciliation.extension:processor, PaymentReconciliation.extension:referenceNumber, PaymentReconciliation.extension:authorization, PaymentReconciliation.extension:tenderedAmount, PaymentReconciliation.extension:returnedAmount, PaymentReconciliation.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PaymentReconciliation
| Path | Status | Usage | ValueSet | Version | Source |
| PaymentReconciliation.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| PaymentReconciliation.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
| PaymentReconciliation.paymentIssuer.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| PaymentReconciliation.outcome | Base | required | Claim Processing Codes | 📍4.0.1 | FHIR Std. |
| PaymentReconciliation.detail.type | Base | example | Payment Type Codes | 📍4.0.1 | FHIR Std. |
| PaymentReconciliation.detail.response.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| PaymentReconciliation.formCode | Base | example | Forms | 📍4.0.1 | FHIR Std. |
| PaymentReconciliation.processNote.type | Base | required | NoteType | 📍4.0.1 | FHIR Std. |
| 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 | PaymentReconciliation.meta, PaymentReconciliation.implicitRules, PaymentReconciliation.language, PaymentReconciliation.text, PaymentReconciliation.extension, PaymentReconciliation.extension:type, PaymentReconciliation.extension:kind, PaymentReconciliation.extension:enterer, PaymentReconciliation.extension:issuerType, PaymentReconciliation.extension:location, PaymentReconciliation.extension:method, PaymentReconciliation.extension:cardBrand, PaymentReconciliation.extension:accountNumber, PaymentReconciliation.extension:expirationDate, PaymentReconciliation.extension:processor, PaymentReconciliation.extension:referenceNumber, PaymentReconciliation.extension:authorization, PaymentReconciliation.extension:tenderedAmount, PaymentReconciliation.extension:returnedAmount, PaymentReconciliation.modifierExtension, PaymentReconciliation.identifier, PaymentReconciliation.status, PaymentReconciliation.period, PaymentReconciliation.created, PaymentReconciliation.paymentIssuer, PaymentReconciliation.paymentIssuer.extension, PaymentReconciliation.paymentIssuer.extension:paymentIssuer, PaymentReconciliation.paymentIssuer.reference, PaymentReconciliation.paymentIssuer.type, PaymentReconciliation.paymentIssuer.identifier, PaymentReconciliation.paymentIssuer.display, PaymentReconciliation.request, PaymentReconciliation.requestor, PaymentReconciliation.outcome, PaymentReconciliation.disposition, PaymentReconciliation.paymentDate, PaymentReconciliation.paymentAmount, PaymentReconciliation.paymentIdentifier, PaymentReconciliation.detail, PaymentReconciliation.detail.extension, PaymentReconciliation.detail.extension:target, PaymentReconciliation.detail.extension:targetItem, PaymentReconciliation.detail.extension:encounter, PaymentReconciliation.detail.extension:account, PaymentReconciliation.detail.modifierExtension, PaymentReconciliation.detail.identifier, PaymentReconciliation.detail.predecessor, PaymentReconciliation.detail.type, PaymentReconciliation.detail.request, PaymentReconciliation.detail.submitter, PaymentReconciliation.detail.response, PaymentReconciliation.detail.response.extension, PaymentReconciliation.detail.response.extension:response, PaymentReconciliation.detail.response.reference, PaymentReconciliation.detail.response.type, PaymentReconciliation.detail.response.identifier, PaymentReconciliation.detail.response.display, PaymentReconciliation.detail.date, PaymentReconciliation.detail.responsible, PaymentReconciliation.detail.payee, PaymentReconciliation.detail.amount, PaymentReconciliation.formCode, PaymentReconciliation.processNote, PaymentReconciliation.processNote.extension, PaymentReconciliation.processNote.modifierExtension, PaymentReconciliation.processNote.type, PaymentReconciliation.processNote.text | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PaymentReconciliation.extension, PaymentReconciliation.extension:type, PaymentReconciliation.extension:kind, PaymentReconciliation.extension:enterer, PaymentReconciliation.extension:issuerType, PaymentReconciliation.extension:location, PaymentReconciliation.extension:method, PaymentReconciliation.extension:cardBrand, PaymentReconciliation.extension:accountNumber, PaymentReconciliation.extension:expirationDate, PaymentReconciliation.extension:processor, PaymentReconciliation.extension:referenceNumber, PaymentReconciliation.extension:authorization, PaymentReconciliation.extension:tenderedAmount, PaymentReconciliation.extension:returnedAmount, PaymentReconciliation.modifierExtension, PaymentReconciliation.paymentIssuer.extension, PaymentReconciliation.paymentIssuer.extension:paymentIssuer, PaymentReconciliation.detail.extension, PaymentReconciliation.detail.extension:target, PaymentReconciliation.detail.extension:targetItem, PaymentReconciliation.detail.extension:encounter, PaymentReconciliation.detail.extension:account, PaymentReconciliation.detail.modifierExtension, PaymentReconciliation.detail.response.extension, PaymentReconciliation.detail.response.extension:response, PaymentReconciliation.processNote.extension, PaymentReconciliation.processNote.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PaymentReconciliation
Summary
Mandatory: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  PaymentReconciliation |
0..* | PaymentReconciliation(4.0.1) | PaymentReconciliation resource | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
   extension:type |
1..1 | CodeableConcept | R5: Category of payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.type Binding: PaymentTypeCodes (extensible) Constraints: ext-1 | |
| extension:kind |
0..1 | CodeableConcept | R5: Workflow originating payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.kind Binding: R5PaymentKindForR4 (0.1.0) (extensible) Constraints: ext-1 | |
| extension:enterer |
0..1 | Reference(Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization) | R5: Who entered the payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.enterer Constraints: ext-1 | |
| extension:issuerType |
0..1 | CodeableConcept | R5: Nature of the source (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.issuerType Binding: R5PaymentIssuertypeForR4 (0.1.0) (extensible) Constraints: ext-1 | |
| extension:location |
0..1 | Reference(Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location) | R5: Where payment collected (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.location Constraints: ext-1 | |
| extension:method |
0..1 | CodeableConcept | R5: Payment instrument (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.method Binding: R5V20570ForR4 (0.1.0) (extensible) Constraints: ext-1 | |
| extension:cardBrand |
0..1 | string | R5: Type of card (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.cardBrand Constraints: ext-1 | |
| extension:accountNumber |
0..1 | string | R5: Digits for verification (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.accountNumber Constraints: ext-1 | |
| extension:expirationDate |
0..1 | date | R5: Expiration year-month (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.expirationDate Constraints: ext-1 | |
| extension:processor |
0..1 | string | R5: Processor name (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.processor Constraints: ext-1 | |
| extension:referenceNumber |
0..1 | string | R5: Check number or payment reference (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.referenceNumber Constraints: ext-1 | |
| extension:authorization |
0..1 | string | R5: Authorization number (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.authorization Constraints: ext-1 | |
| extension:tenderedAmount |
0..1 | Money | R5: Amount offered by the issuer (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.tenderedAmount Constraints: ext-1 | |
 extension:returnedAmount |
0..1 | Money | R5: Amount returned by the receiver (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.returnedAmount Constraints: ext-1 | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | active | cancelled | draft | entered-in-error Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance. |
| created |
Σ | 1..1 | dateTime | Creation date |
| paymentDate |
Σ | 1..1 | date | When payment issued |
  paymentAmount |
Σ | 1..1 | Money | Total amount of Payment |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PaymentReconciliation.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
| 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 | PaymentReconciliation.implicitRules, PaymentReconciliation.extension, PaymentReconciliation.extension:type, PaymentReconciliation.extension:kind, PaymentReconciliation.extension:enterer, PaymentReconciliation.extension:issuerType, PaymentReconciliation.extension:location, PaymentReconciliation.extension:method, PaymentReconciliation.extension:cardBrand, PaymentReconciliation.extension:accountNumber, PaymentReconciliation.extension:expirationDate, PaymentReconciliation.extension:processor, PaymentReconciliation.extension:referenceNumber, PaymentReconciliation.extension:authorization, PaymentReconciliation.extension:tenderedAmount, PaymentReconciliation.extension:returnedAmount, PaymentReconciliation.modifierExtension, PaymentReconciliation.status, PaymentReconciliation.created, PaymentReconciliation.paymentDate, PaymentReconciliation.paymentAmount | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PaymentReconciliation.extension, PaymentReconciliation.extension:type, PaymentReconciliation.extension:kind, PaymentReconciliation.extension:enterer, PaymentReconciliation.extension:issuerType, PaymentReconciliation.extension:location, PaymentReconciliation.extension:method, PaymentReconciliation.extension:cardBrand, PaymentReconciliation.extension:accountNumber, PaymentReconciliation.extension:expirationDate, PaymentReconciliation.extension:processor, PaymentReconciliation.extension:referenceNumber, PaymentReconciliation.extension:authorization, PaymentReconciliation.extension:tenderedAmount, PaymentReconciliation.extension:returnedAmount, PaymentReconciliation.modifierExtension | 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 Filter: |
|---|---|---|---|---|
| PaymentReconciliation |
0..* | PaymentReconciliation(4.0.1) | PaymentReconciliation resource | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:type |
1..1 | CodeableConcept | R5: Category of payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.type Binding: PaymentTypeCodes (extensible) | |
| extension:kind |
0..1 | CodeableConcept | R5: Workflow originating payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.kind Binding: R5PaymentKindForR4 (0.1.0) (extensible) | |
| extension:enterer |
0..1 | Reference(Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization) | R5: Who entered the payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.enterer | |
| extension:issuerType |
0..1 | CodeableConcept | R5: Nature of the source (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.issuerType Binding: R5PaymentIssuertypeForR4 (0.1.0) (extensible) | |
| extension:location |
0..1 | Reference(Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location) | R5: Where payment collected (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.location | |
| extension:method |
0..1 | CodeableConcept | R5: Payment instrument (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.method Binding: R5V20570ForR4 (0.1.0) (extensible) | |
| extension:cardBrand |
0..1 | string | R5: Type of card (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.cardBrand | |
| extension:accountNumber |
0..1 | string | R5: Digits for verification (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.accountNumber | |
| extension:expirationDate |
0..1 | date | R5: Expiration year-month (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.expirationDate | |
| extension:processor |
0..1 | string | R5: Processor name (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.processor | |
| extension:referenceNumber |
0..1 | string | R5: Check number or payment reference (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.referenceNumber | |
| extension:authorization |
0..1 | string | R5: Authorization number (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.authorization | |
| extension:tenderedAmount |
0..1 | Money | R5: Amount offered by the issuer (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.tenderedAmount | |
| extension:returnedAmount |
0..1 | Money | R5: Amount returned by the receiver (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.returnedAmount | |
 paymentIssuer |
||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:paymentIssuer |
0..1 | Reference(Resource) | R5: paymentIssuer URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| detail |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:target |
0..1 | Reference(Cross-version Profile for R5.Claim for use in FHIR R4(0.1.0) | Claim | Cross-version Profile for R5.Account for use in FHIR R4(0.1.0) | Account | Cross-version Profile for R5.Invoice for use in FHIR R4(0.1.0) | Invoice | Cross-version Profile for R5.ChargeItem for use in FHIR R4(0.1.0) | ChargeItem | Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter | Cross-version Profile for R5.Contract for use in FHIR R4(0.1.0) | Contract) | R5: Subject of the payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target | |
| extension:targetItem |
0..1 | string, Identifier, positiveInt | R5: Sub-element of the subject (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.targetItem | |
| extension:encounter |
0..1 | Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) | R5: Applied-to encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.encounter | |
| extension:account |
0..1 | Reference(Cross-version Profile for R5.Account for use in FHIR R4(0.1.0) | Account) | R5: Applied-to account (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.account | |
| response |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:response |
0..1 | Reference(Resource) | R5: response additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| PaymentReconciliation |
0..* | PaymentReconciliation(4.0.1) | 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.
| |||||
| 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:type |
1..1 | CodeableConcept | R5: Category of payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.type Binding: PaymentTypeCodes (extensible) Constraints: ext-1 | |||||
| extension:kind |
0..1 | CodeableConcept | R5: Workflow originating payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.kind Binding: R5PaymentKindForR4 (0.1.0) (extensible) Constraints: ext-1 | |||||
| extension:enterer |
0..1 | Reference(Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization) | R5: Who entered the payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.enterer Constraints: ext-1 | |||||
| extension:issuerType |
0..1 | CodeableConcept | R5: Nature of the source (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.issuerType Binding: R5PaymentIssuertypeForR4 (0.1.0) (extensible) Constraints: ext-1 | |||||
| extension:location |
0..1 | Reference(Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location) | R5: Where payment collected (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.location Constraints: ext-1 | |||||
| extension:method |
0..1 | CodeableConcept | R5: Payment instrument (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.method Binding: R5V20570ForR4 (0.1.0) (extensible) Constraints: ext-1 | |||||
| extension:cardBrand |
0..1 | string | R5: Type of card (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.cardBrand Constraints: ext-1 | |||||
| extension:accountNumber |
0..1 | string | R5: Digits for verification (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.accountNumber Constraints: ext-1 | |||||
| extension:expirationDate |
0..1 | date | R5: Expiration year-month (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.expirationDate Constraints: ext-1 | |||||
| extension:processor |
0..1 | string | R5: Processor name (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.processor Constraints: ext-1 | |||||
| extension:referenceNumber |
0..1 | string | R5: Check number or payment reference (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.referenceNumber Constraints: ext-1 | |||||
| extension:authorization |
0..1 | string | R5: Authorization number (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.authorization Constraints: ext-1 | |||||
| extension:tenderedAmount |
0..1 | Money | R5: Amount offered by the issuer (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.tenderedAmount Constraints: ext-1 | |||||
| extension:returnedAmount |
0..1 | Money | R5: Amount returned by the receiver (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.returnedAmount Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| 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 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:paymentIssuer |
0..1 | Reference(Resource) | R5: paymentIssuer URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 |
0..1 | string | Disposition message | |||||
| paymentDate |
Σ | 1..1 | date | When payment issued | ||||
| paymentAmount |
Σ | 1..1 | Money | Total amount of Payment | ||||
| paymentIdentifier |
0..1 | Identifier | Business identifier for the payment | |||||
| detail |
0..* | BackboneElement | Settlement particulars | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:target |
0..1 | Reference(Cross-version Profile for R5.Claim for use in FHIR R4(0.1.0) | Claim | Cross-version Profile for R5.Account for use in FHIR R4(0.1.0) | Account | Cross-version Profile for R5.Invoice for use in FHIR R4(0.1.0) | Invoice | Cross-version Profile for R5.ChargeItem for use in FHIR R4(0.1.0) | ChargeItem | Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter | Cross-version Profile for R5.Contract for use in FHIR R4(0.1.0) | Contract) | R5: Subject of the payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target Constraints: ext-1 | |||||
| extension:targetItem |
0..1 | string, Identifier, positiveInt | R5: Sub-element of the subject (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.targetItem Constraints: ext-1 | |||||
| extension:encounter |
0..1 | Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) | R5: Applied-to encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.encounter Constraints: ext-1 | |||||
| extension:account |
0..1 | Reference(Cross-version Profile for R5.Account for use in FHIR R4(0.1.0) | Account) | R5: Applied-to account (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.account Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:response |
0..1 | Reference(Resource) | R5: response additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PaymentReconciliation.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| PaymentReconciliation.status | Base | required | Financial Resource Status Codes | 📍4.0.1 | FHIR Std. |
| PaymentReconciliation.paymentIssuer.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| PaymentReconciliation.outcome | Base | required | Claim Processing Codes | 📍4.0.1 | FHIR Std. |
| PaymentReconciliation.detail.type | Base | example | Payment Type Codes | 📍4.0.1 | FHIR Std. |
| PaymentReconciliation.detail.response.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| PaymentReconciliation.formCode | Base | example | Forms | 📍4.0.1 | FHIR Std. |
| PaymentReconciliation.processNote.type | Base | required | NoteType | 📍4.0.1 | FHIR Std. |
| 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 | PaymentReconciliation.meta, PaymentReconciliation.implicitRules, PaymentReconciliation.language, PaymentReconciliation.text, PaymentReconciliation.extension, PaymentReconciliation.extension:type, PaymentReconciliation.extension:kind, PaymentReconciliation.extension:enterer, PaymentReconciliation.extension:issuerType, PaymentReconciliation.extension:location, PaymentReconciliation.extension:method, PaymentReconciliation.extension:cardBrand, PaymentReconciliation.extension:accountNumber, PaymentReconciliation.extension:expirationDate, PaymentReconciliation.extension:processor, PaymentReconciliation.extension:referenceNumber, PaymentReconciliation.extension:authorization, PaymentReconciliation.extension:tenderedAmount, PaymentReconciliation.extension:returnedAmount, PaymentReconciliation.modifierExtension, PaymentReconciliation.identifier, PaymentReconciliation.status, PaymentReconciliation.period, PaymentReconciliation.created, PaymentReconciliation.paymentIssuer, PaymentReconciliation.paymentIssuer.extension, PaymentReconciliation.paymentIssuer.extension:paymentIssuer, PaymentReconciliation.paymentIssuer.reference, PaymentReconciliation.paymentIssuer.type, PaymentReconciliation.paymentIssuer.identifier, PaymentReconciliation.paymentIssuer.display, PaymentReconciliation.request, PaymentReconciliation.requestor, PaymentReconciliation.outcome, PaymentReconciliation.disposition, PaymentReconciliation.paymentDate, PaymentReconciliation.paymentAmount, PaymentReconciliation.paymentIdentifier, PaymentReconciliation.detail, PaymentReconciliation.detail.extension, PaymentReconciliation.detail.extension:target, PaymentReconciliation.detail.extension:targetItem, PaymentReconciliation.detail.extension:encounter, PaymentReconciliation.detail.extension:account, PaymentReconciliation.detail.modifierExtension, PaymentReconciliation.detail.identifier, PaymentReconciliation.detail.predecessor, PaymentReconciliation.detail.type, PaymentReconciliation.detail.request, PaymentReconciliation.detail.submitter, PaymentReconciliation.detail.response, PaymentReconciliation.detail.response.extension, PaymentReconciliation.detail.response.extension:response, PaymentReconciliation.detail.response.reference, PaymentReconciliation.detail.response.type, PaymentReconciliation.detail.response.identifier, PaymentReconciliation.detail.response.display, PaymentReconciliation.detail.date, PaymentReconciliation.detail.responsible, PaymentReconciliation.detail.payee, PaymentReconciliation.detail.amount, PaymentReconciliation.formCode, PaymentReconciliation.processNote, PaymentReconciliation.processNote.extension, PaymentReconciliation.processNote.modifierExtension, PaymentReconciliation.processNote.type, PaymentReconciliation.processNote.text | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PaymentReconciliation.extension, PaymentReconciliation.extension:type, PaymentReconciliation.extension:kind, PaymentReconciliation.extension:enterer, PaymentReconciliation.extension:issuerType, PaymentReconciliation.extension:location, PaymentReconciliation.extension:method, PaymentReconciliation.extension:cardBrand, PaymentReconciliation.extension:accountNumber, PaymentReconciliation.extension:expirationDate, PaymentReconciliation.extension:processor, PaymentReconciliation.extension:referenceNumber, PaymentReconciliation.extension:authorization, PaymentReconciliation.extension:tenderedAmount, PaymentReconciliation.extension:returnedAmount, PaymentReconciliation.modifierExtension, PaymentReconciliation.paymentIssuer.extension, PaymentReconciliation.paymentIssuer.extension:paymentIssuer, PaymentReconciliation.detail.extension, PaymentReconciliation.detail.extension:target, PaymentReconciliation.detail.extension:targetItem, PaymentReconciliation.detail.extension:encounter, PaymentReconciliation.detail.extension:account, PaymentReconciliation.detail.modifierExtension, PaymentReconciliation.detail.response.extension, PaymentReconciliation.detail.response.extension:response, PaymentReconciliation.processNote.extension, PaymentReconciliation.processNote.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PaymentReconciliation
Summary
Mandatory: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r4#0.1.0 based on FHIR 4.0.1. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change