FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

13.9 Resource PaymentReconciliation - Content

Financial Management Work GroupMaturity Level: 2 Trial UseCompartments: Practitioner

This resource provides payment details and claim references supporting a bulk payment.

13.9.1 Scope and Usage

The PaymentReconciliation resource provides the bulk payment details associated with a payment by the payor for goods and services rendered by a provider to patients covered by insurance plans offered by that payor. These are the payment reconciliation details which align to the individual payment amounts indicated on discrete ClaimResponses.

Bulk payments need to provide a means to associate the amounts paid again specific Claims, and other financial exchanges and adjustments, to the bulk payment itself in order to reconcile provider accounts receivable.

13.9.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentReconciliation DomainResourcePaymentReconciliation resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierBusiness Identifier
... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
... period 0..1PeriodPeriod covered
... created 0..1dateTimeCreation date
... organization 0..1Reference(Organization)Insurer
... request 0..1Reference(ProcessRequest)Claim reference
... outcome 0..1CodeableConceptcomplete | error | partial
RemittanceOutcome (Required)
... disposition 0..1stringDisposition Message
... requestProvider 0..1Reference(Practitioner)Responsible practitioner
... requestOrganization 0..1Reference(Organization)Responsible organization
... detail 0..*BackboneElementList of settlements
.... type 1..1CodeableConceptType code
Payment Type Codes (Example)
.... request 0..1Reference(Any)Claim
.... response 0..1Reference(Any)Claim Response
.... submitter 0..1Reference(Organization)Organization which submitted the claim
.... payee 0..1Reference(Organization)Organization which is receiving the payment
.... date 0..1dateInvoice date
.... amount 0..1MoneyAmount being paid
... form 0..1CodeableConceptPrinted Form Identifier
Form Codes (Example)
... total 0..1MoneyTotal amount of Payment
... processNote 0..*BackboneElementProcessing comments
.... type 0..1CodeableConceptdisplay | print | printoper
NoteType (Required)
.... text 0..1stringComment on the processing

doco Documentation for this format

UML Diagram (Legend)

PaymentReconciliation (DomainResource)The Response business identifieridentifier : Identifier [0..*]The status of the resource instance (this element modifies the meaning of other elements)status : code [0..1] A code specifying the state of the resource instance. (Strength=Required)Financial Resource Status ! The period of time for which payments have been gathered into this bulk payment for settlementperiod : Period [0..1]The date when the enclosed suite of services were performed or completedcreated : dateTime [0..1]The Insurer who produced this adjudicated responseorganization : Reference [0..1] Organization Original request resource referencerequest : Reference [0..1] ProcessRequest Transaction status: error, completeoutcome : CodeableConcept [0..1] The outcome of the processing. (Strength=Required)RemittanceOutcome! A description of the status of the adjudicationdisposition : string [0..1]The practitioner who is responsible for the services rendered to the patientrequestProvider : Reference [0..1] Practitioner The organization which is responsible for the services rendered to the patientrequestOrganization : Reference [0..1] Organization The form to be used for printing the contentform : CodeableConcept [0..1] The forms codes. (Strength=Example)Form ?? Total payment amounttotal : Money [0..1]DetailsCode to indicate the nature of the payment, adjustment, funds advance, etctype : CodeableConcept [1..1] The reason for the amount: payment, adjustment, advance. (Strength=Example)Payment Type ?? The claim or financial resourcerequest : Reference [0..1] Any The claim response resourceresponse : Reference [0..1] Any The Organization which submitted the claim or financial transactionsubmitter : Reference [0..1] Organization The organization which is receiving the paymentpayee : Reference [0..1] Organization The date of the invoice or financial resourcedate : date [0..1]Amount paid for this detailamount : Money [0..1]NotesThe note purpose: Print/Displaytype : CodeableConcept [0..1] The presentation types of notes. (Strength=Required)NoteType! The note texttext : string [0..1]List of individual settlement amounts and the corresponding transactiondetail[0..*]Suite of notesprocessNote[0..*]

XML Template

<PaymentReconciliation xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error -->
 <period><!-- 0..1 Period Period covered --></period>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <organization><!-- 0..1 Reference(Organization) Insurer --></organization>
 <request><!-- 0..1 Reference(ProcessRequest) Claim reference --></request>
 <outcome><!-- 0..1 CodeableConcept complete | error | partial --></outcome>
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <requestProvider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
 <detail>  <!-- 0..* List of settlements -->
  <type><!-- 1..1 CodeableConcept Type code --></type>
  <request><!-- 0..1 Reference(Any) Claim --></request>
  <response><!-- 0..1 Reference(Any) Claim Response --></response>
  <submitter><!-- 0..1 Reference(Organization) Organization which submitted the claim --></submitter>
  <payee><!-- 0..1 Reference(Organization) Organization which is receiving the payment --></payee>
  <date value="[date]"/><!-- 0..1 Invoice date -->
  <amount><!-- 0..1 Money Amount being paid --></amount>
 </detail>
 <form><!-- 0..1 CodeableConcept Printed Form Identifier --></form>
 <total><!-- 0..1 Money Total amount of Payment --></total>
 <processNote>  <!-- 0..* Processing comments -->
  <type><!-- 0..1 CodeableConcept display | print | printoper --></type>
  <text value="[string]"/><!-- 0..1 Comment on the processing -->
 </processNote>
</PaymentReconciliation>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:PaymentReconciliation;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:PaymentReconciliation.identifier [ Identifier ], ... ; # 0..* Business Identifier
  fhir:PaymentReconciliation.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error
  fhir:PaymentReconciliation.period [ Period ]; # 0..1 Period covered
  fhir:PaymentReconciliation.created [ dateTime ]; # 0..1 Creation date
  fhir:PaymentReconciliation.organization [ Reference(Organization) ]; # 0..1 Insurer
  fhir:PaymentReconciliation.request [ Reference(ProcessRequest) ]; # 0..1 Claim reference
  fhir:PaymentReconciliation.outcome [ CodeableConcept ]; # 0..1 complete | error | partial
  fhir:PaymentReconciliation.disposition [ string ]; # 0..1 Disposition Message
  fhir:PaymentReconciliation.requestProvider [ Reference(Practitioner) ]; # 0..1 Responsible practitioner
  fhir:PaymentReconciliation.requestOrganization [ Reference(Organization) ]; # 0..1 Responsible organization
  fhir:PaymentReconciliation.detail [ # 0..* List of settlements
    fhir:PaymentReconciliation.detail.type [ CodeableConcept ]; # 1..1 Type code
    fhir:PaymentReconciliation.detail.request [ Reference(Any) ]; # 0..1 Claim
    fhir:PaymentReconciliation.detail.response [ Reference(Any) ]; # 0..1 Claim Response
    fhir:PaymentReconciliation.detail.submitter [ Reference(Organization) ]; # 0..1 Organization which submitted the claim
    fhir:PaymentReconciliation.detail.payee [ Reference(Organization) ]; # 0..1 Organization which is receiving the payment
    fhir:PaymentReconciliation.detail.date [ date ]; # 0..1 Invoice date
    fhir:PaymentReconciliation.detail.amount [ Money ]; # 0..1 Amount being paid
  ], ...;
  fhir:PaymentReconciliation.form [ CodeableConcept ]; # 0..1 Printed Form Identifier
  fhir:PaymentReconciliation.total [ Money ]; # 0..1 Total amount of Payment
  fhir:PaymentReconciliation.processNote [ # 0..* Processing comments
    fhir:PaymentReconciliation.processNote.type [ CodeableConcept ]; # 0..1 display | print | printoper
    fhir:PaymentReconciliation.processNote.text [ string ]; # 0..1 Comment on the processing
  ], ...;
]

Changes since DSTU2

PaymentReconciliation
PaymentReconciliation.status
  • Added Element
PaymentReconciliation.outcome
  • Type changed from code to CodeableConcept
PaymentReconciliation.detail.type
  • Type changed from Coding to CodeableConcept
PaymentReconciliation.detail.response
  • Added Element
PaymentReconciliation.detail.amount
  • Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money
PaymentReconciliation.form
  • Type changed from Coding to CodeableConcept
  • Remove Binding http://hl7.org/fhir/ValueSet/forms (required)
PaymentReconciliation.total
  • Min Cardinality changed from 1 to 0
  • Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money
PaymentReconciliation.processNote
  • Added Element
PaymentReconciliation.processNote.type
  • Added Element
PaymentReconciliation.processNote.text
  • Added Element
PaymentReconciliation.ruleset
  • deleted
PaymentReconciliation.originalRuleset
  • deleted
PaymentReconciliation.detail.responce
  • deleted
PaymentReconciliation.note
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PaymentReconciliation DomainResourcePaymentReconciliation resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierBusiness Identifier
... status ?!Σ0..1codeactive | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
... period 0..1PeriodPeriod covered
... created 0..1dateTimeCreation date
... organization 0..1Reference(Organization)Insurer
... request 0..1Reference(ProcessRequest)Claim reference
... outcome 0..1CodeableConceptcomplete | error | partial
RemittanceOutcome (Required)
... disposition 0..1stringDisposition Message
... requestProvider 0..1Reference(Practitioner)Responsible practitioner
... requestOrganization 0..1Reference(Organization)Responsible organization
... detail 0..*BackboneElementList of settlements
.... type 1..1CodeableConceptType code
Payment Type Codes (Example)
.... request 0..1Reference(Any)Claim
.... response 0..1Reference(Any)Claim Response
.... submitter 0..1Reference(Organization)Organization which submitted the claim
.... payee 0..1Reference(Organization)Organization which is receiving the payment
.... date 0..1dateInvoice date
.... amount 0..1MoneyAmount being paid
... form 0..1CodeableConceptPrinted Form Identifier
Form Codes (Example)
... total 0..1MoneyTotal amount of Payment
... processNote 0..*BackboneElementProcessing comments
.... type 0..1CodeableConceptdisplay | print | printoper
NoteType (Required)
.... text 0..1stringComment on the processing

doco Documentation for this format

UML Diagram (Legend)

PaymentReconciliation (DomainResource)The Response business identifieridentifier : Identifier [0..*]The status of the resource instance (this element modifies the meaning of other elements)status : code [0..1] A code specifying the state of the resource instance. (Strength=Required)Financial Resource Status ! The period of time for which payments have been gathered into this bulk payment for settlementperiod : Period [0..1]The date when the enclosed suite of services were performed or completedcreated : dateTime [0..1]The Insurer who produced this adjudicated responseorganization : Reference [0..1] Organization Original request resource referencerequest : Reference [0..1] ProcessRequest Transaction status: error, completeoutcome : CodeableConcept [0..1] The outcome of the processing. (Strength=Required)RemittanceOutcome! A description of the status of the adjudicationdisposition : string [0..1]The practitioner who is responsible for the services rendered to the patientrequestProvider : Reference [0..1] Practitioner The organization which is responsible for the services rendered to the patientrequestOrganization : Reference [0..1] Organization The form to be used for printing the contentform : CodeableConcept [0..1] The forms codes. (Strength=Example)Form ?? Total payment amounttotal : Money [0..1]DetailsCode to indicate the nature of the payment, adjustment, funds advance, etctype : CodeableConcept [1..1] The reason for the amount: payment, adjustment, advance. (Strength=Example)Payment Type ?? The claim or financial resourcerequest : Reference [0..1] Any The claim response resourceresponse : Reference [0..1] Any The Organization which submitted the claim or financial transactionsubmitter : Reference [0..1] Organization The organization which is receiving the paymentpayee : Reference [0..1] Organization The date of the invoice or financial resourcedate : date [0..1]Amount paid for this detailamount : Money [0..1]NotesThe note purpose: Print/Displaytype : CodeableConcept [0..1] The presentation types of notes. (Strength=Required)NoteType! The note texttext : string [0..1]List of individual settlement amounts and the corresponding transactiondetail[0..*]Suite of notesprocessNote[0..*]

XML Template

<PaymentReconciliation xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <status value="[code]"/><!-- 0..1 active | cancelled | draft | entered-in-error -->
 <period><!-- 0..1 Period Period covered --></period>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <organization><!-- 0..1 Reference(Organization) Insurer --></organization>
 <request><!-- 0..1 Reference(ProcessRequest) Claim reference --></request>
 <outcome><!-- 0..1 CodeableConcept complete | error | partial --></outcome>
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <requestProvider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></requestProvider>
 <requestOrganization><!-- 0..1 Reference(Organization) Responsible organization --></requestOrganization>
 <detail>  <!-- 0..* List of settlements -->
  <type><!-- 1..1 CodeableConcept Type code --></type>
  <request><!-- 0..1 Reference(Any) Claim --></request>
  <response><!-- 0..1 Reference(Any) Claim Response --></response>
  <submitter><!-- 0..1 Reference(Organization) Organization which submitted the claim --></submitter>
  <payee><!-- 0..1 Reference(Organization) Organization which is receiving the payment --></payee>
  <date value="[date]"/><!-- 0..1 Invoice date -->
  <amount><!-- 0..1 Money Amount being paid --></amount>
 </detail>
 <form><!-- 0..1 CodeableConcept Printed Form Identifier --></form>
 <total><!-- 0..1 Money Total amount of Payment --></total>
 <processNote>  <!-- 0..* Processing comments -->
  <type><!-- 0..1 CodeableConcept display | print | printoper --></type>
  <text value="[string]"/><!-- 0..1 Comment on the processing -->
 </processNote>
</PaymentReconciliation>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:PaymentReconciliation;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:PaymentReconciliation.identifier [ Identifier ], ... ; # 0..* Business Identifier
  fhir:PaymentReconciliation.status [ code ]; # 0..1 active | cancelled | draft | entered-in-error
  fhir:PaymentReconciliation.period [ Period ]; # 0..1 Period covered
  fhir:PaymentReconciliation.created [ dateTime ]; # 0..1 Creation date
  fhir:PaymentReconciliation.organization [ Reference(Organization) ]; # 0..1 Insurer
  fhir:PaymentReconciliation.request [ Reference(ProcessRequest) ]; # 0..1 Claim reference
  fhir:PaymentReconciliation.outcome [ CodeableConcept ]; # 0..1 complete | error | partial
  fhir:PaymentReconciliation.disposition [ string ]; # 0..1 Disposition Message
  fhir:PaymentReconciliation.requestProvider [ Reference(Practitioner) ]; # 0..1 Responsible practitioner
  fhir:PaymentReconciliation.requestOrganization [ Reference(Organization) ]; # 0..1 Responsible organization
  fhir:PaymentReconciliation.detail [ # 0..* List of settlements
    fhir:PaymentReconciliation.detail.type [ CodeableConcept ]; # 1..1 Type code
    fhir:PaymentReconciliation.detail.request [ Reference(Any) ]; # 0..1 Claim
    fhir:PaymentReconciliation.detail.response [ Reference(Any) ]; # 0..1 Claim Response
    fhir:PaymentReconciliation.detail.submitter [ Reference(Organization) ]; # 0..1 Organization which submitted the claim
    fhir:PaymentReconciliation.detail.payee [ Reference(Organization) ]; # 0..1 Organization which is receiving the payment
    fhir:PaymentReconciliation.detail.date [ date ]; # 0..1 Invoice date
    fhir:PaymentReconciliation.detail.amount [ Money ]; # 0..1 Amount being paid
  ], ...;
  fhir:PaymentReconciliation.form [ CodeableConcept ]; # 0..1 Printed Form Identifier
  fhir:PaymentReconciliation.total [ Money ]; # 0..1 Total amount of Payment
  fhir:PaymentReconciliation.processNote [ # 0..* Processing comments
    fhir:PaymentReconciliation.processNote.type [ CodeableConcept ]; # 0..1 display | print | printoper
    fhir:PaymentReconciliation.processNote.text [ string ]; # 0..1 Comment on the processing
  ], ...;
]

Changes since DSTU2

PaymentReconciliation
PaymentReconciliation.status
  • Added Element
PaymentReconciliation.outcome
  • Type changed from code to CodeableConcept
PaymentReconciliation.detail.type
  • Type changed from Coding to CodeableConcept
PaymentReconciliation.detail.response
  • Added Element
PaymentReconciliation.detail.amount
  • Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money
PaymentReconciliation.form
  • Type changed from Coding to CodeableConcept
  • Remove Binding http://hl7.org/fhir/ValueSet/forms (required)
PaymentReconciliation.total
  • Min Cardinality changed from 1 to 0
  • Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money
PaymentReconciliation.processNote
  • Added Element
PaymentReconciliation.processNote.type
  • Added Element
PaymentReconciliation.processNote.text
  • Added Element
PaymentReconciliation.ruleset
  • deleted
PaymentReconciliation.originalRuleset
  • deleted
PaymentReconciliation.detail.responce
  • deleted
PaymentReconciliation.note
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

13.9.2.1 Terminology Bindings

PathDefinitionTypeReference
PaymentReconciliation.status A code specifying the state of the resource instance.RequiredFinancial Resource Status Codes
PaymentReconciliation.outcome The outcome of the processing.RequiredRemittanceOutcome
PaymentReconciliation.detail.type The reason for the amount: payment, adjustment, advance.ExamplePayment Type Codes
PaymentReconciliation.form The forms codes.ExampleForm Codes
PaymentReconciliation.processNote.type The presentation types of notes.RequiredNoteType

13.9.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
createddateThe creation datePaymentReconciliation.created
dispositionstringThe contents of the disposition messagePaymentReconciliation.disposition
identifiertokenThe business identifier of the Explanation of BenefitPaymentReconciliation.identifier
organizationreferenceThe organization who generated this resourcePaymentReconciliation.organization
(Organization)
outcometokenThe processing outcomePaymentReconciliation.outcome
requestreferenceThe reference to the claimPaymentReconciliation.request
(ProcessRequest)
request-organizationreferenceThe organization who generated this resourcePaymentReconciliation.requestOrganization
(Organization)
request-providerreferenceThe reference to the provider who sumbitted the claimPaymentReconciliation.requestProvider
(Practitioner)