Current Build

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

8.35 JSON Schema for Invoice

Financial Management Work GroupMaturity Level: N/ABallot Status: Informative Compartments: Device, Patient, Practitioner, RelatedPerson

This is a representation of the json schema for Invoice, 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/Invoice",
  "$ref": "#/definitions/Invoice",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "Invoice": {
      "description": "Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.",
      "properties": {
        "resourceType": {
          "description": "This is a Invoice resource",
          "const": "Invoice"
        },
        "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": "Identifier of this Invoice, often used for reference in corresponcence about this invoice or for tracking of payments.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "status": {
          "description": "The current state of the Invoice.",
          "enum": [
            "draft",
            "issued",
            "balanced",
            "cancelled",
            "entered-in-error"
          ]
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "cancelledReason": {
          "description": "In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).",
          "$ref": "#/definitions/string"
        },
        "_cancelledReason": {
          "description": "Extensions for cancelledReason",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "type": {
          "description": "Type of Invoice depending on domain, realm an usage (eg. internal/external, dental, preliminary).",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "subject": {
          "description": "The individual or set of individuals receiving the goods and services billed in this invoice.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "recipient": {
          "description": "The individual or Organization responsible for balancing of this invoice.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "date": {
          "description": "Date/time(s) of when this Invoice was posted.",
          "$ref": "#/definitions/dateTime"
        },
        "_date": {
          "description": "Extensions for date",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "participant": {
          "description": "Indicates who or what performed or participated in the charged service.",
          "items": {
            "$ref": "#/definitions/Invoice_Participant"
          },
          "type": "array"
        },
        "issuer": {
          "description": "The organizationissuing the Invoice.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "account": {
          "description": "Account which is supposed to be balanced with this Invoice.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "lineItem": {
          "description": "Each line item represents one charge for goods ond services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.",
          "items": {
            "$ref": "#/definitions/Invoice_LineItem"
          },
          "type": "array"
        },
        "totalPriceComponent": {
          "description": "The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions.  The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.",
          "items": {
            "$ref": "#/definitions/Invoice_PriceComponent"
          },
          "type": "array"
        },
        "totalNet": {
          "description": "Invoice total , taxes excluded.",
          "$ref": "Money.schema.json#/definitions/Money"
        },
        "totalGross": {
          "description": "Invoice total, tax included.",
          "$ref": "Money.schema.json#/definitions/Money"
        },
        "paymentTerms": {
          "description": "Payment details such as banking details, period of payment, deductables, methods of payment.",
          "$ref": "#/definitions/markdown"
        },
        "_paymentTerms": {
          "description": "Extensions for paymentTerms",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "note": {
          "description": "Comments made about the invoice by the issuer, subject or other participants.",
          "items": {
            "$ref": "Annotation.schema.json#/definitions/Annotation"
          },
          "type": "array"
        }
      },
      "additionalProperties": false,
      "required": [
        "resourceType"
      ]
    },
    "Invoice_Participant": {
      "description": "Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.",
      "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"
        },
        "role": {
          "description": "Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "actor": {
          "description": "The device, practitioner, etc. who performed or participated in the service.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        }
      },
      "additionalProperties": false,
      "required": [
        "actor"
      ]
    },
    "Invoice_LineItem": {
      "description": "Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.",
      "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"
        },
        "sequence": {
          "description": "Sequence in which the items appear on the invoice.",
          "$ref": "#/definitions/positiveInt"
        },
        "_sequence": {
          "description": "Extensions for sequence",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "chargeItemReference": {
          "description": "The ChargeItem contains information such as the billing code, date, amount etc. Of no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "chargeItemCodeableConcept": {
          "description": "The ChargeItem contains information such as the billing code, date, amount etc. Of no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "priceComponent": {
          "description": "The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under developement. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.",
          "items": {
            "$ref": "#/definitions/Invoice_PriceComponent"
          },
          "type": "array"
        }
      },
      "additionalProperties": false
    },
    "Invoice_PriceComponent": {
      "description": "Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.",
      "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": "This code identifies the type of the component.",
          "enum": [
            "base",
            "surcharge",
            "deduction",
            "discount",
            "tax",
            "informational"
          ]
        },
        "_type": {
          "description": "Extensions for type",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "code": {
          "description": "A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "factor": {
          "description": "The factor that has been applied on the base price for calculating this component.",
          "$ref": "#/definitions/decimal"
        },
        "_factor": {
          "description": "Extensions for factor",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "amount": {
          "description": "The amount calculated for this component.",
          "$ref": "Money.schema.json#/definitions/Money"
        }
      },
      "additionalProperties": false
    }
  }
}