This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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.10 Resource PaymentReconciliation - Content

Financial Management

Work Group

Maturity Level: 1

Compartments: Not linked to any defined compartments

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

13.10.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.

Structure

Name	Flags	Card.	Type	Description & Constraints
PaymentReconciliation			DomainResource	PaymentReconciliation resource
identifier		0..*	Identifier	Business Identifier
status	?!Σ	1..1	code	active \| cancelled \| draft \| entered-in-error PaymentReconciliationStatus (Required)
request[x]		0..1		Claim reference
requestIdentifier			Identifier
requestReference			Reference(ProcessRequest)
outcome		0..1	code	complete \| error \| partial RemittanceOutcome (Required)
disposition		0..1	string	Disposition Message
ruleset		0..1	Coding	Resource version Ruleset Codes (Example)
originalRuleset		0..1	Coding	Original version Ruleset Codes (Example)
created		0..1	dateTime	Creation date
period		0..1	Period	Period covered
organization[x]		0..1		Insurer
organizationIdentifier			Identifier
organizationReference			Reference(Organization)
requestProvider[x]		0..1		Responsible practitioner
requestProviderIdentifier			Identifier
requestProviderReference			Reference(Practitioner)
requestOrganization[x]		0..1		Responsible organization
requestOrganizationIdentifier			Identifier
requestOrganizationReference			Reference(Organization)
detail		0..*	BackboneElement	Details
type		1..1	Coding	Type code Payment Type Codes (Example)
request[x]		0..1		Claim
requestIdentifier			Identifier
requestReference			Reference(Any)
response[x]		0..1		Claim Response
responseIdentifier			Identifier
responseReference			Reference(Any)
submitter[x]		0..1		Submitter
submitterIdentifier			Identifier
submitterReference			Reference(Organization)
payee[x]		0..1		Payee
payeeIdentifier			Identifier
payeeReference			Reference(Organization)
date		0..1	date	Invoice date
amount		0..1	Money	Detail amount
form		0..1	Coding	Printed Form Identifier Form Codes (Required)
total		1..1	Money	Total amount of Payment
note		0..*	BackboneElement	Note text
type		0..1	Coding	display \| print \| printoper NoteType (Required)
text		0..1	string	Notes text
Documentation for this format

UML Diagram (Legend)

XML Template

<PaymentReconciliation xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error -->
 <request[x]><!-- 0..1 Identifier|Reference(ProcessRequest) Claim reference --></request[x]>
 <outcome value="[code]"/><!-- 0..1 complete | error | partial -->
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <period><!-- 0..1 Period Period covered --></period>
 <organization[x]><!-- 0..1 Identifier|Reference(Organization) Insurer --></organization[x]>
 <requestProvider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible practitioner --></requestProvider[x]>
 <requestOrganization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization --></requestOrganization[x]>
 <detail>  <!-- 0..* Details -->
  <type><!-- 1..1 Coding Type code --></type>
  <request[x]><!-- 0..1 Identifier|Reference(Any) Claim --></request[x]>
  <response[x]><!-- 0..1 Identifier|Reference(Any) Claim Response --></response[x]>
  <submitter[x]><!-- 0..1 Identifier|Reference(Organization) Submitter --></submitter[x]>
  <payee[x]><!-- 0..1 Identifier|Reference(Organization) Payee --></payee[x]>
  <date value="[date]"/><!-- 0..1 Invoice date -->
  <amount><!-- 0..1 Money Detail amount --></amount>
 </detail>
 <form><!-- 0..1 Coding Printed Form Identifier --></form>
 <total><!-- 1..1 Money Total amount of Payment --></total>
 <note>  <!-- 0..* Note text -->
  <type><!-- 0..1 Coding display | print | printoper --></type>
  <text value="[string]"/><!-- 0..1 Notes text -->
 </note>
</PaymentReconciliation>

JSON Template

{
  "resourceType" : "PaymentReconciliation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "status" : "<code>", // R!  active | cancelled | draft | entered-in-error
  // request[x]: Claim reference. One of these 2:
  "requestIdentifier" : { Identifier },
  "requestReference" : { Reference(ProcessRequest) },
  "outcome" : "<code>", // complete | error | partial
  "disposition" : "<string>", // Disposition Message
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  "period" : { Period }, // Period covered
  // organization[x]: Insurer. One of these 2:
  "organizationIdentifier" : { Identifier },
  "organizationReference" : { Reference(Organization) },
  // requestProvider[x]: Responsible practitioner. One of these 2:
  "requestProviderIdentifier" : { Identifier },
  "requestProviderReference" : { Reference(Practitioner) },
  // requestOrganization[x]: Responsible organization. One of these 2:
  "requestOrganizationIdentifier" : { Identifier },
  "requestOrganizationReference" : { Reference(Organization) },
  "detail" : [{ // Details
    "type" : { Coding }, // R!  Type code
    // request[x]: Claim. One of these 2:
    "requestIdentifier" : { Identifier },
    "requestReference" : { Reference(Any) },
    // response[x]: Claim Response. One of these 2:
    "responseIdentifier" : { Identifier },
    "responseReference" : { Reference(Any) },
    // submitter[x]: Submitter. One of these 2:
    "submitterIdentifier" : { Identifier },
    "submitterReference" : { Reference(Organization) },
    // payee[x]: Payee. One of these 2:
    "payeeIdentifier" : { Identifier },
    "payeeReference" : { Reference(Organization) },
    "date" : "<date>", // Invoice date
    "amount" : { Money } // Detail amount
  }],
  "form" : { Coding }, // Printed Form Identifier
  "total" : { Money }, // R!  Total amount of Payment
  "note" : [{ // Note text
    "type" : { Coding }, // display | print | printoper
    "text" : "<string>" // Notes text
  }]
}

Turtle Template

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


[ 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 ]; # 1..1 active | cancelled | draft | entered-in-error
  # PaymentReconciliation.request[x] : 0..1 Claim reference. One of these 2
    fhir:PaymentReconciliation.requestIdentifier [ Identifier ]
    fhir:PaymentReconciliation.requestReference [ Reference(ProcessRequest) ]
  fhir:PaymentReconciliation.outcome [ code ]; # 0..1 complete | error | partial
  fhir:PaymentReconciliation.disposition [ string ]; # 0..1 Disposition Message
  fhir:PaymentReconciliation.ruleset [ Coding ]; # 0..1 Resource version
  fhir:PaymentReconciliation.originalRuleset [ Coding ]; # 0..1 Original version
  fhir:PaymentReconciliation.created [ dateTime ]; # 0..1 Creation date
  fhir:PaymentReconciliation.period [ Period ]; # 0..1 Period covered
  # PaymentReconciliation.organization[x] : 0..1 Insurer. One of these 2
    fhir:PaymentReconciliation.organizationIdentifier [ Identifier ]
    fhir:PaymentReconciliation.organizationReference [ Reference(Organization) ]
  # PaymentReconciliation.requestProvider[x] : 0..1 Responsible practitioner. One of these 2
    fhir:PaymentReconciliation.requestProviderIdentifier [ Identifier ]
    fhir:PaymentReconciliation.requestProviderReference [ Reference(Practitioner) ]
  # PaymentReconciliation.requestOrganization[x] : 0..1 Responsible organization. One of these 2
    fhir:PaymentReconciliation.requestOrganizationIdentifier [ Identifier ]
    fhir:PaymentReconciliation.requestOrganizationReference [ Reference(Organization) ]
  fhir:PaymentReconciliation.detail [ # 0..* Details
    fhir:PaymentReconciliation.detail.type [ Coding ]; # 1..1 Type code
    # PaymentReconciliation.detail.request[x] : 0..1 Claim. One of these 2
      fhir:PaymentReconciliation.detail.requestIdentifier [ Identifier ]
      fhir:PaymentReconciliation.detail.requestReference [ Reference(Any) ]
    # PaymentReconciliation.detail.response[x] : 0..1 Claim Response. One of these 2
      fhir:PaymentReconciliation.detail.responseIdentifier [ Identifier ]
      fhir:PaymentReconciliation.detail.responseReference [ Reference(Any) ]
    # PaymentReconciliation.detail.submitter[x] : 0..1 Submitter. One of these 2
      fhir:PaymentReconciliation.detail.submitterIdentifier [ Identifier ]
      fhir:PaymentReconciliation.detail.submitterReference [ Reference(Organization) ]
    # PaymentReconciliation.detail.payee[x] : 0..1 Payee. One of these 2
      fhir:PaymentReconciliation.detail.payeeIdentifier [ Identifier ]
      fhir:PaymentReconciliation.detail.payeeReference [ Reference(Organization) ]
    fhir:PaymentReconciliation.detail.date [ date ]; # 0..1 Invoice date
    fhir:PaymentReconciliation.detail.amount [ Money ]; # 0..1 Detail amount
  ], ...;
  fhir:PaymentReconciliation.form [ Coding ]; # 0..1 Printed Form Identifier
  fhir:PaymentReconciliation.total [ Money ]; # 1..1 Total amount of Payment
  fhir:PaymentReconciliation.note [ # 0..* Note text
    fhir:PaymentReconciliation.note.type [ Coding ]; # 0..1 display | print | printoper
    fhir:PaymentReconciliation.note.text [ string ]; # 0..1 Notes text
  ], ...;
]

Changes since DSTU2

PaymentReconciliation

PaymentReconciliation.status

added

PaymentReconciliation.request[x]

Renamed from request to request[x]
Add Identifier

PaymentReconciliation.organization[x]

Renamed from organization to organization[x]
Add Identifier

PaymentReconciliation.requestProvider[x]

Renamed from requestProvider to requestProvider[x]
Add Identifier

PaymentReconciliation.requestOrganization[x]

Renamed from requestOrganization to requestOrganization[x]
Add Identifier

PaymentReconciliation.detail.request[x]

Renamed from request to request[x]
Add Identifier

PaymentReconciliation.detail.response[x]

added

PaymentReconciliation.detail.submitter[x]

Renamed from submitter to submitter[x]
Add Identifier

PaymentReconciliation.detail.payee[x]

Renamed from payee to payee[x]
Add Identifier

PaymentReconciliation.detail.amount

Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money

PaymentReconciliation.total

Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money

PaymentReconciliation.detail.responce

deleted

See the Full Difference for further information

Structure

Name	Flags	Card.	Type	Description & Constraints
PaymentReconciliation			DomainResource	PaymentReconciliation resource
identifier		0..*	Identifier	Business Identifier
status	?!Σ	1..1	code	active \| cancelled \| draft \| entered-in-error PaymentReconciliationStatus (Required)
request[x]		0..1		Claim reference
requestIdentifier			Identifier
requestReference			Reference(ProcessRequest)
outcome		0..1	code	complete \| error \| partial RemittanceOutcome (Required)
disposition		0..1	string	Disposition Message
ruleset		0..1	Coding	Resource version Ruleset Codes (Example)
originalRuleset		0..1	Coding	Original version Ruleset Codes (Example)
created		0..1	dateTime	Creation date
period		0..1	Period	Period covered
organization[x]		0..1		Insurer
organizationIdentifier			Identifier
organizationReference			Reference(Organization)
requestProvider[x]		0..1		Responsible practitioner
requestProviderIdentifier			Identifier
requestProviderReference			Reference(Practitioner)
requestOrganization[x]		0..1		Responsible organization
requestOrganizationIdentifier			Identifier
requestOrganizationReference			Reference(Organization)
detail		0..*	BackboneElement	Details
type		1..1	Coding	Type code Payment Type Codes (Example)
request[x]		0..1		Claim
requestIdentifier			Identifier
requestReference			Reference(Any)
response[x]		0..1		Claim Response
responseIdentifier			Identifier
responseReference			Reference(Any)
submitter[x]		0..1		Submitter
submitterIdentifier			Identifier
submitterReference			Reference(Organization)
payee[x]		0..1		Payee
payeeIdentifier			Identifier
payeeReference			Reference(Organization)
date		0..1	date	Invoice date
amount		0..1	Money	Detail amount
form		0..1	Coding	Printed Form Identifier Form Codes (Required)
total		1..1	Money	Total amount of Payment
note		0..*	BackboneElement	Note text
type		0..1	Coding	display \| print \| printoper NoteType (Required)
text		0..1	string	Notes text
Documentation for this format

UML Diagram (Legend)

XML Template

<PaymentReconciliation xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business Identifier --></identifier>
 <status value="[code]"/><!-- 1..1 active | cancelled | draft | entered-in-error -->
 <request[x]><!-- 0..1 Identifier|Reference(ProcessRequest) Claim reference --></request[x]>
 <outcome value="[code]"/><!-- 0..1 complete | error | partial -->
 <disposition value="[string]"/><!-- 0..1 Disposition Message -->
 <ruleset><!-- 0..1 Coding Resource version --></ruleset>
 <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset>
 <created value="[dateTime]"/><!-- 0..1 Creation date -->
 <period><!-- 0..1 Period Period covered --></period>
 <organization[x]><!-- 0..1 Identifier|Reference(Organization) Insurer --></organization[x]>
 <requestProvider[x]><!-- 0..1 Identifier|Reference(Practitioner) Responsible practitioner --></requestProvider[x]>
 <requestOrganization[x]><!-- 0..1 Identifier|Reference(Organization) Responsible organization --></requestOrganization[x]>
 <detail>  <!-- 0..* Details -->
  <type><!-- 1..1 Coding Type code --></type>
  <request[x]><!-- 0..1 Identifier|Reference(Any) Claim --></request[x]>
  <response[x]><!-- 0..1 Identifier|Reference(Any) Claim Response --></response[x]>
  <submitter[x]><!-- 0..1 Identifier|Reference(Organization) Submitter --></submitter[x]>
  <payee[x]><!-- 0..1 Identifier|Reference(Organization) Payee --></payee[x]>
  <date value="[date]"/><!-- 0..1 Invoice date -->
  <amount><!-- 0..1 Money Detail amount --></amount>
 </detail>
 <form><!-- 0..1 Coding Printed Form Identifier --></form>
 <total><!-- 1..1 Money Total amount of Payment --></total>
 <note>  <!-- 0..* Note text -->
  <type><!-- 0..1 Coding display | print | printoper --></type>
  <text value="[string]"/><!-- 0..1 Notes text -->
 </note>
</PaymentReconciliation>

JSON Template

{
  "resourceType" : "PaymentReconciliation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business Identifier
  "status" : "<code>", // R!  active | cancelled | draft | entered-in-error
  // request[x]: Claim reference. One of these 2:
  "requestIdentifier" : { Identifier },
  "requestReference" : { Reference(ProcessRequest) },
  "outcome" : "<code>", // complete | error | partial
  "disposition" : "<string>", // Disposition Message
  "ruleset" : { Coding }, // Resource version
  "originalRuleset" : { Coding }, // Original version
  "created" : "<dateTime>", // Creation date
  "period" : { Period }, // Period covered
  // organization[x]: Insurer. One of these 2:
  "organizationIdentifier" : { Identifier },
  "organizationReference" : { Reference(Organization) },
  // requestProvider[x]: Responsible practitioner. One of these 2:
  "requestProviderIdentifier" : { Identifier },
  "requestProviderReference" : { Reference(Practitioner) },
  // requestOrganization[x]: Responsible organization. One of these 2:
  "requestOrganizationIdentifier" : { Identifier },
  "requestOrganizationReference" : { Reference(Organization) },
  "detail" : [{ // Details
    "type" : { Coding }, // R!  Type code
    // request[x]: Claim. One of these 2:
    "requestIdentifier" : { Identifier },
    "requestReference" : { Reference(Any) },
    // response[x]: Claim Response. One of these 2:
    "responseIdentifier" : { Identifier },
    "responseReference" : { Reference(Any) },
    // submitter[x]: Submitter. One of these 2:
    "submitterIdentifier" : { Identifier },
    "submitterReference" : { Reference(Organization) },
    // payee[x]: Payee. One of these 2:
    "payeeIdentifier" : { Identifier },
    "payeeReference" : { Reference(Organization) },
    "date" : "<date>", // Invoice date
    "amount" : { Money } // Detail amount
  }],
  "form" : { Coding }, // Printed Form Identifier
  "total" : { Money }, // R!  Total amount of Payment
  "note" : [{ // Note text
    "type" : { Coding }, // display | print | printoper
    "text" : "<string>" // Notes text
  }]
}

Turtle Template

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


[ 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 ]; # 1..1 active | cancelled | draft | entered-in-error
  # PaymentReconciliation.request[x] : 0..1 Claim reference. One of these 2
    fhir:PaymentReconciliation.requestIdentifier [ Identifier ]
    fhir:PaymentReconciliation.requestReference [ Reference(ProcessRequest) ]
  fhir:PaymentReconciliation.outcome [ code ]; # 0..1 complete | error | partial
  fhir:PaymentReconciliation.disposition [ string ]; # 0..1 Disposition Message
  fhir:PaymentReconciliation.ruleset [ Coding ]; # 0..1 Resource version
  fhir:PaymentReconciliation.originalRuleset [ Coding ]; # 0..1 Original version
  fhir:PaymentReconciliation.created [ dateTime ]; # 0..1 Creation date
  fhir:PaymentReconciliation.period [ Period ]; # 0..1 Period covered
  # PaymentReconciliation.organization[x] : 0..1 Insurer. One of these 2
    fhir:PaymentReconciliation.organizationIdentifier [ Identifier ]
    fhir:PaymentReconciliation.organizationReference [ Reference(Organization) ]
  # PaymentReconciliation.requestProvider[x] : 0..1 Responsible practitioner. One of these 2
    fhir:PaymentReconciliation.requestProviderIdentifier [ Identifier ]
    fhir:PaymentReconciliation.requestProviderReference [ Reference(Practitioner) ]
  # PaymentReconciliation.requestOrganization[x] : 0..1 Responsible organization. One of these 2
    fhir:PaymentReconciliation.requestOrganizationIdentifier [ Identifier ]
    fhir:PaymentReconciliation.requestOrganizationReference [ Reference(Organization) ]
  fhir:PaymentReconciliation.detail [ # 0..* Details
    fhir:PaymentReconciliation.detail.type [ Coding ]; # 1..1 Type code
    # PaymentReconciliation.detail.request[x] : 0..1 Claim. One of these 2
      fhir:PaymentReconciliation.detail.requestIdentifier [ Identifier ]
      fhir:PaymentReconciliation.detail.requestReference [ Reference(Any) ]
    # PaymentReconciliation.detail.response[x] : 0..1 Claim Response. One of these 2
      fhir:PaymentReconciliation.detail.responseIdentifier [ Identifier ]
      fhir:PaymentReconciliation.detail.responseReference [ Reference(Any) ]
    # PaymentReconciliation.detail.submitter[x] : 0..1 Submitter. One of these 2
      fhir:PaymentReconciliation.detail.submitterIdentifier [ Identifier ]
      fhir:PaymentReconciliation.detail.submitterReference [ Reference(Organization) ]
    # PaymentReconciliation.detail.payee[x] : 0..1 Payee. One of these 2
      fhir:PaymentReconciliation.detail.payeeIdentifier [ Identifier ]
      fhir:PaymentReconciliation.detail.payeeReference [ Reference(Organization) ]
    fhir:PaymentReconciliation.detail.date [ date ]; # 0..1 Invoice date
    fhir:PaymentReconciliation.detail.amount [ Money ]; # 0..1 Detail amount
  ], ...;
  fhir:PaymentReconciliation.form [ Coding ]; # 0..1 Printed Form Identifier
  fhir:PaymentReconciliation.total [ Money ]; # 1..1 Total amount of Payment
  fhir:PaymentReconciliation.note [ # 0..* Note text
    fhir:PaymentReconciliation.note.type [ Coding ]; # 0..1 display | print | printoper
    fhir:PaymentReconciliation.note.text [ string ]; # 0..1 Notes text
  ], ...;
]

Changes since DSTU2

PaymentReconciliation

PaymentReconciliation.status

added

PaymentReconciliation.request[x]

Renamed from request to request[x]
Add Identifier

PaymentReconciliation.organization[x]

Renamed from organization to organization[x]
Add Identifier

PaymentReconciliation.requestProvider[x]

Renamed from requestProvider to requestProvider[x]
Add Identifier

PaymentReconciliation.requestOrganization[x]

Renamed from requestOrganization to requestOrganization[x]
Add Identifier

PaymentReconciliation.detail.request[x]

Renamed from request to request[x]
Add Identifier

PaymentReconciliation.detail.response[x]

added

PaymentReconciliation.detail.submitter[x]

Renamed from submitter to submitter[x]
Add Identifier

PaymentReconciliation.detail.payee[x]

Renamed from payee to payee[x]
Add Identifier

PaymentReconciliation.detail.amount

Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money

PaymentReconciliation.total

Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money

PaymentReconciliation.detail.responce

deleted

See the Full Difference for further information

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

13.10.2.1 Terminology Bindings

Path	Definition	Type	Reference
PaymentReconciliation.status	A code specifying the state of the resource instance.	Required	PaymentReconciliationStatus
PaymentReconciliation.outcome	The outcome of the processing.	Required	RemittanceOutcome
PaymentReconciliation.ruleset PaymentReconciliation.originalRuleset	The static and dynamic model to which contents conform, which may be business version or standard/version.	Example	Ruleset Codes
PaymentReconciliation.detail.type	The reason for the amount: payment, adjustment, advance.	Example	Payment Type Codes
PaymentReconciliation.form	The forms codes.	Required	Form Codes
PaymentReconciliation.note.type	The presentation types of notes.	Required	NoteType

Path

Definition

Type

Reference

PaymentReconciliation.status

A code specifying the state of the resource instance.

Required

PaymentReconciliationStatus

PaymentReconciliation.outcome

The outcome of the processing.

Required

RemittanceOutcome

PaymentReconciliation.ruleset
PaymentReconciliation.originalRuleset

The static and dynamic model to which contents conform, which may be business version or standard/version.

Example

Ruleset Codes

PaymentReconciliation.detail.type

The reason for the amount: payment, adjustment, advance.

Example

Payment Type Codes

PaymentReconciliation.form

The forms codes.

Required

Form Codes

PaymentReconciliation.note.type

The presentation types of notes.

Required

NoteType

13.10.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.

Name	Type	Description	Paths
created	date	The creation date	PaymentReconciliation.created
disposition	string	The contents of the disposition message	PaymentReconciliation.disposition
identifier	token	The business identifier of the Explanation of Benefit	PaymentReconciliation.identifier
organization-identifier	token	The organization who generated this resource	PaymentReconciliation.organizationIdentifier
organization-reference	reference	The organization who generated this resource	PaymentReconciliation.organizationReference (Organization)
outcome	token	The processing outcome	PaymentReconciliation.outcome
request-identifier	token	The reference to the claim	PaymentReconciliation.requestIdentifier
request-organization-identifier	token	The organization who generated this resource	PaymentReconciliation.requestOrganizationIdentifier
request-organization-reference	reference	The organization who generated this resource	PaymentReconciliation.requestOrganizationReference (Organization)
request-provider-identifier	token	The reference to the provider who sumbitted the claim	PaymentReconciliation.requestProviderIdentifier
request-provider-reference	reference	The reference to the provider who sumbitted the claim	PaymentReconciliation.requestProviderReference (Practitioner)
request-reference	reference	The reference to the claim	PaymentReconciliation.requestReference (ProcessRequest)