http://hl7.org/fhir/StructureDefinition/PaymentReconciliation|5.0.0

This resource provides the details including amount of a payment and allocates the payment items being paid.
Structure JSON Dependencies FHIRSchema Other Versions Dependant (0)Elements Summary
description: This resource provides the details including amount of a payment and allocates the payment items being paid.
derivation: specialization
name: PaymentReconciliation
type: PaymentReconciliation
elements:
  requestor: {isModifier: false, short: Responsible practitioner, mustSupport: false, isSummary: false, index: 10}
  amount: {isModifier: false, short: Total amount of Payment, mustSupport: false, isSummary: true, index: 24}
  date: {isModifier: false, short: When payment issued, mustSupport: false, isSummary: true, index: 13}
  request: {isModifier: false, short: Reference to requesting resource, mustSupport: false, isSummary: false, index: 9}
  processNote:
    isModifier: false
    short: Note concerning processing
    mustSupport: false
    array: true
    isSummary: false
    index: 42
    elements:
      type:
        isModifier: false
        short: display | print | printoper
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/note-type|5.0.0'}
        isSummary: false
        index: 43
      text: {isModifier: false, short: Note explanatory text, mustSupport: false, isSummary: false, index: 44}
  cardBrand: {isModifier: false, short: Type of card, mustSupport: false, isSummary: false, index: 16}
  accountNumber: {isModifier: false, short: Digits for verification, mustSupport: false, isSummary: false, index: 17}
  returnedAmount: {isModifier: false, short: Amount returned by the receiver, mustSupport: false, isSummary: false, index: 23}
  enterer: {isModifier: false, short: Who entered the payment, mustSupport: false, isSummary: false, index: 6}
  method:
    isModifier: false
    short: Payment instrument
    mustSupport: false
    binding: {strength: extensible, valueSet: 'http://terminology.hl7.org/ValueSet/v2-0570'}
    isSummary: false
    index: 15
  authorization: {isModifier: false, short: Authorization number, mustSupport: false, isSummary: false, index: 21}
  tenderedAmount: {isModifier: false, short: Amount offered by the issuer, mustSupport: false, isSummary: false, index: 22}
  type:
    isModifier: false
    short: Category of payment
    mustSupport: false
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/payment-type'}
    isSummary: true
    index: 1
  created: {isModifier: false, short: Creation date, mustSupport: false, isSummary: true, index: 5}
  outcome:
    isModifier: false
    short: queued | complete | error | partial
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/payment-outcome|5.0.0'}
    isSummary: false
    index: 11
  referenceNumber: {isModifier: false, short: Check number or payment reference, mustSupport: false, isSummary: false, index: 20}
  disposition: {isModifier: false, short: Disposition message, mustSupport: false, isSummary: false, index: 12}
  paymentIdentifier: {isModifier: false, short: Business identifier for the payment, mustSupport: false, isSummary: false, index: 25}
  status:
    isModifier: true
    short: active | cancelled | draft | entered-in-error
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/fm-status|5.0.0'}
    isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    isSummary: true
    index: 2
  kind:
    isModifier: false
    short: Workflow originating payment
    mustSupport: false
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/payment-kind'}
    isSummary: false
    index: 3
  identifier: {isModifier: false, short: Business Identifier for a payment reconciliation, mustSupport: false, array: true, isSummary: false, index: 0}
  issuerType:
    isModifier: false
    short: Nature of the source
    mustSupport: false
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/payment-issuertype'}
    isSummary: false
    index: 7
  period: {isModifier: false, short: Period covered, mustSupport: false, isSummary: true, index: 4}
  paymentIssuer: {isModifier: false, short: Party generating payment, mustSupport: false, isSummary: true, index: 8}
  formCode:
    isModifier: false
    short: Printed form identifier
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/forms'}
    isSummary: false
    index: 41
  location: {isModifier: false, short: Where payment collected, mustSupport: false, isSummary: false, index: 14}
  processor: {isModifier: false, short: Processor name, mustSupport: false, isSummary: false, index: 19}
  allocation:
    isModifier: false
    short: Settlement particulars
    mustSupport: false
    array: true
    isSummary: false
    index: 26
    elements:
      response: {isModifier: false, short: Response committing to a payment, mustSupport: false, isSummary: false, index: 36}
      amount: {isModifier: false, short: Amount allocated to this payable, mustSupport: false, isSummary: false, index: 40}
      date: {isModifier: false, short: Date of commitment to pay, mustSupport: false, isSummary: false, index: 37}
      encounter: {isModifier: false, short: Applied-to encounter, mustSupport: false, isSummary: false, index: 32}
      type:
        isModifier: false
        short: Category of payment
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/payment-type'}
        isSummary: false
        index: 34
      account: {isModifier: false, short: Applied-to account, mustSupport: false, isSummary: false, index: 33}
      responsible: {isModifier: false, short: Contact for the response, mustSupport: false, isSummary: false, index: 38}
      payee: {isModifier: false, short: Recipient of the payment, mustSupport: false, isSummary: false, index: 39}
      predecessor: {isModifier: false, short: Business identifier of the prior payment detail, mustSupport: false, isSummary: false, index: 28}
      targetItem:
        isModifier: false
        short: Sub-element of the subject
        mustSupport: false
        choices: []
        isSummary: false
        index: 31
      identifier: {isModifier: false, short: Business identifier of the payment detail, mustSupport: false, isSummary: false, index: 27}
      target: {isModifier: false, short: Subject of the payment, mustSupport: false, isSummary: false, index: 29}
      submitter: {isModifier: false, short: Submitter of the request, mustSupport: false, isSummary: false, index: 35}
  expirationDate: {isModifier: false, short: Expiration year-month, mustSupport: false, isSummary: false, index: 18}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/PaymentReconciliation
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0
required: [created, status, type, amount, date]