Current Build

Переводит команда Health Samurai . Приглашаем поучаствовать в русификации стандарта FHIR: GitHub , Email.

13.9 JSON Schema for PaymentReconciliation

Financial Management Work GroupMaturity Level: N/ABallot 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": "Метаданные ресурса. Это такая информация, которая поддерживается инфраструктурой. Изменения этой информации не всегда можно ассоциировать с версионными изменениями ресурса.",
          "$ref": "Meta.schema.json#/definitions/Meta"
        },
        "implicitRules": {
          "description": "Ссылка на свод правил, которым следовали при создании этого ресурса и которые необходимо понимать при обработке этого содержимого. 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": "Основной язык, на котором написан ресурс.",
          "$ref": "#/definitions/code"
        },
        "_language": {
          "description": "Extensions for language",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "text": {
          "description": "Человекочитаемая описательная часть, содержащая краткое изложение ресурса, которая может использоваться для представления содержимого ресурса человеку. От описательной части не требуется кодировать все структурированные данные, но она должна содержать достаточно сведений, чтобы простое её прочтение человеком было \"клинически безопасным\". Определения ресурсов могут описывать, какое содержимое должно быть представлено в описательной части для обеспечения клинической безопасной.",
          "$ref": "Narrative.schema.json#/definitions/Narrative"
        },
        "contained": {
          "description": "Эти ресурсы не обладают независимым существованием вне ресурса, который их содержит - их нельзя идентифицировать независимо, и они не могут иметь своей собственной независимой транзакционной области действия.",
          "items": {
            "$ref": "ResourceList.schema.json#/definitions/ResourceList"
          },
          "type": "array"
        },
        "extension": {
          "description": "Может использоваться для представления дополнительной информации, не являющейся частью базового определения ресурса. Чтобы сделать использование расширений надежным и управляемым, существует строгий набор управления применительно к определению и использованию расширений. Хотя каждому реализатору разрешается определять расширения, имеется набор требований, которые должны выполняться в рамках определения расширения.",
          "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. 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"
        },
        "status": {
          "description": "The status of the resource instance.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "period": {
          "description": "Период времени, для которого платежи были собраны в этот массовый платёж для погашения.",
          "$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"
        },
        "paymentIssuer": {
          "description": "The party who generated the payment.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "request": {
          "description": "Ссылка на ресурс исходного запроса.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "requestor": {
          "description": "Врач, ответственный за оказанные пациенту услуги.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "outcome": {
          "description": "The outcome of a request for a reconciliation.",
          "enum": [
            "queued",
            "complete",
            "error",
            "partial"
          ]
        },
        "_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"
        },
        "paymentDate": {
          "description": "The date of payment as indicated on the financial instrument.",
          "$ref": "#/definitions/date"
        },
        "_paymentDate": {
          "description": "Extensions for paymentDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "paymentAmount": {
          "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"
        },
        "detail": {
          "description": "Distribution of the payment amount for a previously acknowledged payable.",
          "items": {
            "$ref": "#/definitions/PaymentReconciliation_Detail"
          },
          "type": "array"
        },
        "formCode": {
          "description": "A code for Форма для печати содержимого.",
          "$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"
        }
      },
      "additionalProperties": false,
      "required": [
        "paymentAmount",
        "resourceType"
      ]
    },
    "PaymentReconciliation_Detail": {
      "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. 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"
        },
        "type": {
          "description": "Code to indicate the nature of the payment.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "request": {
          "description": "A resource, such as a Иск, the evaluation of which could lead to payment.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "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"
        }
      },
      "additionalProperties": false,
      "required": [
        "type"
      ]
    },
    "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. 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.",
          "enum": [
            "display",
            "print",
            "printoper"
          ]
        },
        "_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"
        }
      },
      "additionalProperties": false
    }
  }
}