13.9.11 JSON Schema for PaymentReconciliation

Financial Management Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Practitioner

This is a representation of the json schema for PaymentReconciliation, which is just a part of the full JSON Schema.

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "id": "http://hl7.org/fhir/json-schema/PaymentReconciliation",
  "$ref": "#/definitions/PaymentReconciliation",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "PaymentReconciliation": {
      "description": "This resource provides the details including amount of a payment and allocates the payment items being paid.",
      "properties": {
        "resourceType": {
          "description": "This is a PaymentReconciliation resource",
          "const": "PaymentReconciliation"
        },
        "id": {
          "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
          "$ref": "id.schema.json#/definitions/id"
        },
        "meta": {
          "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
          "$ref": "#/definitions/uri"
        },
        "_implicitRules": {
          "description": "Extensions for implicitRules",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "language": {
          "description": "The base language in which the resource is written.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "identifier": {
          "description": "A unique identifier assigned to this payment reconciliation.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "type": {
          "description": "Code to indicate the nature of the payment such as payment, adjustment.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "status": {
          "description": "The status of the resource instance.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "kind": {
          "description": "The workflow or activity which gave rise to or during which the payment ocurred such as a kiosk, deposit on account, periodic payment etc.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "period": {
          "description": "The period of time for which payments have been gathered into this bulk payment for settlement.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "created": {
          "description": "The date when the resource was created.",
          "$ref": "#/definitions/dateTime"
        },
        "_created": {
          "description": "Extensions for created",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "enterer": {
          "description": "Payment enterer if not the actual payment issuer.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "issuerType": {
          "description": "The type of the source such as patient or insurance.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "paymentIssuer": {
          "description": "The party who generated the payment.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "request": {
          "description": "Original request resource reference.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "requestor": {
          "description": "The practitioner who is responsible for the services rendered to the patient.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "outcome": {
          "description": "The outcome of a request for a reconciliation.",
          "$ref": "#/definitions/code"
        },
        "_outcome": {
          "description": "Extensions for outcome",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "disposition": {
          "description": "A human readable description of the status of the request for the reconciliation.",
          "$ref": "#/definitions/string"
        },
        "_disposition": {
          "description": "Extensions for disposition",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "date": {
          "description": "The date of payment as indicated on the financial instrument.",
          "$ref": "#/definitions/date"
        },
        "_date": {
          "description": "Extensions for date",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "location": {
          "description": "The location of the site or device for electronic transfers or physical location for cash payments.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "method": {
          "description": "The means of payment such as check, card cash, or electronic funds transfer.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "cardBrand": {
          "description": "The card brand such as debit, Visa, Amex etc. used if a card is the method of payment.",
          "$ref": "#/definitions/string"
        },
        "_cardBrand": {
          "description": "Extensions for cardBrand",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "accountNumber": {
          "description": "A portion of the account number, often the last 4 digits, used for verification not charging purposes.",
          "$ref": "#/definitions/string"
        },
        "_accountNumber": {
          "description": "Extensions for accountNumber",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "expirationDate": {
          "description": "The year and month (YYYY-MM) when the instrument, typically card, expires.",
          "$ref": "#/definitions/date"
        },
        "_expirationDate": {
          "description": "Extensions for expirationDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "processor": {
          "description": "The name of the card processor, etf processor, bank for checks.",
          "$ref": "#/definitions/string"
        },
        "_processor": {
          "description": "Extensions for processor",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "referenceNumber": {
          "description": "The check number, eft reference, car processor reference.",
          "$ref": "#/definitions/string"
        },
        "_referenceNumber": {
          "description": "Extensions for referenceNumber",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "authorization": {
          "description": "An alphanumeric issued by the processor to confirm the successful issuance of payment.",
          "$ref": "#/definitions/string"
        },
        "_authorization": {
          "description": "Extensions for authorization",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "tenderedAmount": {
          "description": "The amount offered by the issuer, typically applies to cash when the issuer provides an amount in bank note denominations equal to or excess of the amount actually being paid.",
          "$ref": "Money.schema.json#/definitions/Money"
        },
        "returnedAmount": {
          "description": "The amount returned by the receiver which is excess to the amount payable, often referred to as \u0027change\u0027.",
          "$ref": "Money.schema.json#/definitions/Money"
        },
        "amount": {
          "description": "Total payment amount as indicated on the financial instrument.",
          "$ref": "Money.schema.json#/definitions/Money"
        },
        "paymentIdentifier": {
          "description": "Issuer\u0027s unique identifier for the payment instrument.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "allocation": {
          "description": "Distribution of the payment amount for a previously acknowledged payable.",
          "items": {
            "$ref": "#/definitions/PaymentReconciliation_Allocation"
          },
          "type": "array"
        },
        "formCode": {
          "description": "A code for the form to be used for printing the content.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "processNote": {
          "description": "A note that describes or explains the processing in a human readable form.",
          "items": {
            "$ref": "#/definitions/PaymentReconciliation_ProcessNote"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "amount",
        "type",
        "resourceType"
      ]
    },
    "PaymentReconciliation_Allocation": {
      "description": "This resource provides the details including amount of a payment and allocates the payment items being paid.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "identifier": {
          "description": "Unique identifier for the current payment item for the referenced payable.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "predecessor": {
          "description": "Unique identifier for the prior payment item for the referenced payable.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "target": {
          "description": "Specific resource to which the payment/adjustment/advance applies.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "targetItemString": {
          "description": " Identifies the claim line item, encounter or other sub-element being paid. Note payment may be partial, that is not match the then outstanding balance or amount incurred.",
          "pattern": "^[ \\r\\n\\t\\S]+$",
          "type": "string"
        },
        "_targetItemString": {
          "description": "Extensions for targetItemString",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "targetItemIdentifier": {
          "description": " Identifies the claim line item, encounter or other sub-element being paid. Note payment may be partial, that is not match the then outstanding balance or amount incurred.",
          "$ref": "Identifier.schema.json#/definitions/Identifier"
        },
        "targetItemPositiveInt": {
          "description": " Identifies the claim line item, encounter or other sub-element being paid. Note payment may be partial, that is not match the then outstanding balance or amount incurred.",
          "pattern": "^[1-9][0-9]*$",
          "type": "number"
        },
        "_targetItemPositiveInt": {
          "description": "Extensions for targetItemPositiveInt",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "encounter": {
          "description": "The Encounter to which this payment applies, may be completed by the receiver, used for search.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "account": {
          "description": "The Account to which this payment applies, may be completed by the receiver, used for search.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "type": {
          "description": "Code to indicate the nature of the payment.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "submitter": {
          "description": "The party which submitted the claim or financial transaction.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "response": {
          "description": "A resource, such as a ClaimResponse, which contains a commitment to payment.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "date": {
          "description": "The date from the response resource containing a commitment to pay.",
          "$ref": "#/definitions/date"
        },
        "_date": {
          "description": "Extensions for date",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "responsible": {
          "description": "A reference to the individual who is responsible for inquiries regarding the response and its payment.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "payee": {
          "description": "The party which is receiving the payment.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "amount": {
          "description": "The monetary amount allocated from the total payment to the payable.",
          "$ref": "Money.schema.json#/definitions/Money"
        }
      },
      "type": "object",
      "additionalProperties": false
    },
    "PaymentReconciliation_ProcessNote": {
      "description": "This resource provides the details including amount of a payment and allocates the payment items being paid.",
      "properties": {
        "id": {
          "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
          "$ref": "string.schema.json#/definitions/string"
        },
        "extension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "modifierExtension": {
          "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
          "items": {
            "$ref": "Extension.schema.json#/definitions/Extension"
          },
          "type": "array"
        },
        "type": {
          "description": "The business purpose of the note text.",
          "$ref": "#/definitions/code"
        },
        "_type": {
          "description": "Extensions for type",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "The explanation or description associated with the processing.",
          "$ref": "#/definitions/string"
        },
        "_text": {
          "description": "Extensions for text",
          "$ref": "Element.schema.json#/definitions/Element"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  }
}