Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - 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_R3 | ||
This cross-version profile allows R5 PaymentReconciliation content to be represented via FHIR STU3 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 | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | PaymentReconciliation | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PaymentReconciliation
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  PaymentReconciliation |
0..* | PaymentReconciliation | PaymentReconciliation resource | |||||
  id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages  (extensible): 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 |
2..* | 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: Payment Type Codes (extensible) | |||||
| extension:kind |
0..1 | CodeableConcept | R5: Workflow originating payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.kind Binding: R5PaymentKindForR3 (0.1.0) (extensible) | |||||
| extension:enterer |
0..1 | Reference(Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R5.Organization for use in FHIR STU3(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: R5PaymentIssuertypeForR3 (0.1.0) (extensible) | |||||
| extension:requestor |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Responsible practitioner URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| extension:date |
1..1 | date | R5: When payment issued (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.date | |||||
| extension:location |
0..1 | Reference(Cross-version Profile for R5.Location for use in FHIR STU3(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: R5V20570ForR3 (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 | |||||
 extension:paymentIdentifier |
0..1 | Identifier | R5: Business identifier for the payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIdentifier | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business Identifier | |||||
| status |
?!Σ | 0..1 | code | active | cancelled | draft | entered-in-error Binding: Financial Resource Status Codes (required): A code specifying the state of the resource instance. | ||||
| period |
0..1 | Period | Period covered | |||||
| created |
0..1 | dateTime | Creation date | |||||
 organization |
0..1 | Reference(Organization) | Insurer | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:paymentIssuer |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Party generating payment URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| 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(ProcessRequest) | Claim reference | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:request |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Reference to requesting resource additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| outcome |
0..1 | CodeableConcept | complete | error | partial Binding: Claim Processing Codes (required): The outcome of the processing. | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:outcome |
0..1 | code | R5: queued | complete | error | partial URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.outcome Binding: Claim Processing Codes (required): The outcome of the processing. | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| disposition |
0..1 | string | Disposition Message | |||||
| requestProvider |
0..1 | Reference(Practitioner) | Responsible practitioner | |||||
| requestOrganization |
0..1 | Reference(Organization) | Responsible organization | |||||
| detail |
0..* | BackboneElement | List of settlements | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:identifier |
0..1 | Identifier | R5: Business identifier of the payment detail (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier | |||||
| extension:predecessor |
0..1 | Identifier | R5: Business identifier of the prior payment detail (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.predecessor | |||||
| extension:target |
0..1 | Reference(Cross-version Profile for R5.Claim for use in FHIR STU3(0.1.0) | Claim | Cross-version Profile for R5.Account for use in FHIR STU3(0.1.0) | Account | Cross-version Profile for R5.Invoice for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.ChargeItem for use in FHIR STU3(0.1.0) | ChargeItem | Cross-version Profile for R5.Encounter for use in FHIR STU3(0.1.0) | Encounter | Cross-version Profile for R5.Contract for use in FHIR STU3(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 STU3(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 STU3(0.1.0) | Account) | R5: Applied-to account (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.account | |||||
| extension:responsible |
0..1 | Reference(Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole) | R5: Contact for the response (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.responsible | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
1..1 | CodeableConcept | Type code Binding: Payment Type Codes (example): The reason for the amount: payment, adjustment, advance. | |||||
| request |
0..1 | Reference(Resource) | Claim | |||||
| response |
0..1 | Reference(Resource) | Claim Response | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:response |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Response committing to a payment additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| submitter |
0..1 | Reference(Organization) | Organization which submitted the claim | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:submitter |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Submitter of the request URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| payee |
0..1 | Reference(Organization) | Organization which is receiving the payment | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:payee |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Recipient of the payment URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| 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 | Invoice date | |||||
| amount |
0..1 | Money | Amount being paid | |||||
| form |
0..1 | CodeableConcept | Printed Form Identifier Binding: Form Codes (example): The forms codes. | |||||
| total |
0..1 | Money | Total amount of Payment | |||||
 processNote |
0..* | BackboneElement | Processing comments | |||||
 id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
0..1 | CodeableConcept | display | print | printoper Binding: NoteType (required): The presentation types of notes. | |||||
| text |
0..1 | string | Comment on the processing | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PaymentReconciliation.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| PaymentReconciliation.status | Base | required | Financial Resource Status Codes | 📍3.0.2 | FHIR Std. |
| PaymentReconciliation.outcome | Base | required | Claim Processing Codes | 📍3.0.2 | FHIR Std. |
| PaymentReconciliation.detail.type | Base | example | Payment Type Codes | 📍3.0.2 | FHIR Std. |
| PaymentReconciliation.form | Base | example | Form Codes | 📍3.0.2 | FHIR Std. |
| PaymentReconciliation.processNote.type | Base | required | NoteType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | PaymentReconciliation | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PaymentReconciliation
Summary
Mandatory: 2 elements
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| PaymentReconciliation.status | Base | required | Financial Resource Status Codes | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | PaymentReconciliation | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from PaymentReconciliation
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| PaymentReconciliation |
0..* | PaymentReconciliation | PaymentReconciliation resource | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): 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 |
2..* | 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: Payment Type Codes (extensible) | |||||
| extension:kind |
0..1 | CodeableConcept | R5: Workflow originating payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.kind Binding: R5PaymentKindForR3 (0.1.0) (extensible) | |||||
| extension:enterer |
0..1 | Reference(Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R5.Organization for use in FHIR STU3(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: R5PaymentIssuertypeForR3 (0.1.0) (extensible) | |||||
| extension:requestor |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Responsible practitioner URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| extension:date |
1..1 | date | R5: When payment issued (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.date | |||||
| extension:location |
0..1 | Reference(Cross-version Profile for R5.Location for use in FHIR STU3(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: R5V20570ForR3 (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 | |||||
| extension:paymentIdentifier |
0..1 | Identifier | R5: Business identifier for the payment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIdentifier | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Business Identifier | |||||
| status |
?!Σ | 0..1 | code | active | cancelled | draft | entered-in-error Binding: Financial Resource Status Codes (required): A code specifying the state of the resource instance. | ||||
| period |
0..1 | Period | Period covered | |||||
| created |
0..1 | dateTime | Creation date | |||||
| organization |
0..1 | Reference(Organization) | Insurer | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:paymentIssuer |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Party generating payment URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| 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(ProcessRequest) | Claim reference | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:request |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Reference to requesting resource additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| outcome |
0..1 | CodeableConcept | complete | error | partial Binding: Claim Processing Codes (required): The outcome of the processing. | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:outcome |
0..1 | code | R5: queued | complete | error | partial URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.outcome Binding: Claim Processing Codes (required): The outcome of the processing. | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| disposition |
0..1 | string | Disposition Message | |||||
| requestProvider |
0..1 | Reference(Practitioner) | Responsible practitioner | |||||
| requestOrganization |
0..1 | Reference(Organization) | Responsible organization | |||||
| detail |
0..* | BackboneElement | List of settlements | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:identifier |
0..1 | Identifier | R5: Business identifier of the payment detail (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier | |||||
| extension:predecessor |
0..1 | Identifier | R5: Business identifier of the prior payment detail (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.predecessor | |||||
| extension:target |
0..1 | Reference(Cross-version Profile for R5.Claim for use in FHIR STU3(0.1.0) | Claim | Cross-version Profile for R5.Account for use in FHIR STU3(0.1.0) | Account | Cross-version Profile for R5.Invoice for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.ChargeItem for use in FHIR STU3(0.1.0) | ChargeItem | Cross-version Profile for R5.Encounter for use in FHIR STU3(0.1.0) | Encounter | Cross-version Profile for R5.Contract for use in FHIR STU3(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 STU3(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 STU3(0.1.0) | Account) | R5: Applied-to account (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.account | |||||
| extension:responsible |
0..1 | Reference(Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole) | R5: Contact for the response (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.responsible | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
1..1 | CodeableConcept | Type code Binding: Payment Type Codes (example): The reason for the amount: payment, adjustment, advance. | |||||
| request |
0..1 | Reference(Resource) | Claim | |||||
| response |
0..1 | Reference(Resource) | Claim Response | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:response |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Response committing to a payment additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| submitter |
0..1 | Reference(Organization) | Organization which submitted the claim | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:submitter |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Submitter of the request URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| payee |
0..1 | Reference(Organization) | Organization which is receiving the payment | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:payee |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Recipient of the payment URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| 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 | Invoice date | |||||
| amount |
0..1 | Money | Amount being paid | |||||
| form |
0..1 | CodeableConcept | Printed Form Identifier Binding: Form Codes (example): The forms codes. | |||||
| total |
0..1 | Money | Total amount of Payment | |||||
| processNote |
0..* | BackboneElement | Processing comments | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
0..1 | CodeableConcept | display | print | printoper Binding: NoteType (required): The presentation types of notes. | |||||
| text |
0..1 | string | Comment on the processing | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PaymentReconciliation.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| PaymentReconciliation.status | Base | required | Financial Resource Status Codes | 📍3.0.2 | FHIR Std. |
| PaymentReconciliation.outcome | Base | required | Claim Processing Codes | 📍3.0.2 | FHIR Std. |
| PaymentReconciliation.detail.type | Base | example | Payment Type Codes | 📍3.0.2 | FHIR Std. |
| PaymentReconciliation.form | Base | example | Form Codes | 📍3.0.2 | FHIR Std. |
| PaymentReconciliation.processNote.type | Base | required | NoteType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | PaymentReconciliation | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PaymentReconciliation
Summary
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.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
