8.30.10 JSON Schema for Invoice

Financial Management Work Group

Maturity Level: N/A

Standards 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": "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": "Identifier of this Invoice, often used for reference in correspondence 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.",
          "$ref": "#/definitions/code"
        },
        "_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 (e.g. 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": "Depricared by the element below.",
          "$ref": "#/definitions/dateTime"
        },
        "_date": {
          "description": "Extensions for date",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "creation": {
          "description": "Date/time(s) of when this Invoice was posted.",
          "$ref": "#/definitions/dateTime"
        },
        "_creation": {
          "description": "Extensions for creation",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "periodDate": {
          "description": "Date/time(s) range of services included in this invoice.",
          "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
          "type": "string"
        },
        "_periodDate": {
          "description": "Extensions for periodDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "periodPeriod": {
          "description": "Date/time(s) range of services included in this invoice.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "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 and 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": "MonetaryComponent.schema.json#/definitions/MonetaryComponent"
          },
          "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, deductibles, 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"
        }
      },
      "type": "object",
      "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 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"
        },
        "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"
        }
      },
      "type": "object",
      "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 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"
        },
        "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"
        },
        "servicedDate": {
          "description": "Date/time(s) range when this service was delivered or completed.",
          "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
          "type": "string"
        },
        "_servicedDate": {
          "description": "Extensions for servicedDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "servicedPeriod": {
          "description": "Date/time(s) range when this service was delivered or completed.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "chargeItemReference": {
          "description": "The ChargeItem contains information such as the billing code, date, amount etc. If 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. If 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 development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated.",
          "items": {
            "$ref": "MonetaryComponent.schema.json#/definitions/MonetaryComponent"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  }
}