8.24.11 JSON Schema for ChargeItem

Patient Administration Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

This is a representation of the json schema for ChargeItem, 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/ChargeItem",
  "$ref": "#/definitions/ChargeItem",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "ChargeItem": {
      "description": "The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.",
      "properties": {
        "resourceType": {
          "description": "This is a ChargeItem resource",
          "const": "ChargeItem"
        },
        "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": "Identifiers assigned to this event performer or other systems.",
          "items": {
            "$ref": "Identifier.schema.json#/definitions/Identifier"
          },
          "type": "array"
        },
        "definitionUri": {
          "description": "References the (external) source of pricing information, rules of application for the code this ChargeItem uses.",
          "items": {
            "$ref": "#/definitions/uri"
          },
          "type": "array"
        },
        "_definitionUri": {
          "description": "Extensions for definitionUri",
          "items": {
            "$ref": "Element.schema.json#/definitions/Element"
          },
          "type": "array"
        },
        "definitionCanonical": {
          "description": "References the source of pricing information, rules of application for the code this ChargeItem uses.",
          "items": {
            "$ref": "canonical.schema.json#/definitions/canonical"
          },
          "type": "array"
        },
        "status": {
          "description": "The current state of the ChargeItem.",
          "$ref": "#/definitions/code"
        },
        "_status": {
          "description": "Extensions for status",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "partOf": {
          "description": "ChargeItems can be grouped to larger ChargeItems covering the whole set.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "code": {
          "description": "A code that identifies the charge, like a billing code.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "subject": {
          "description": "The individual or set of individuals the action is being or was performed on.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "encounter": {
          "description": "This ChargeItem has the details of how the associated Encounter should be billed or otherwise be handled by finance systems.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "occurrenceDateTime": {
          "description": "Date/time(s) or duration when the charged service was applied.",
          "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])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?$",
          "type": "string"
        },
        "_occurrenceDateTime": {
          "description": "Extensions for occurrenceDateTime",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "occurrencePeriod": {
          "description": "Date/time(s) or duration when the charged service was applied.",
          "$ref": "Period.schema.json#/definitions/Period"
        },
        "occurrenceTiming": {
          "description": "Date/time(s) or duration when the charged service was applied.",
          "$ref": "Timing.schema.json#/definitions/Timing"
        },
        "performer": {
          "description": "Indicates who or what performed or participated in the charged service.",
          "items": {
            "$ref": "#/definitions/ChargeItem_Performer"
          },
          "type": "array"
        },
        "performingOrganization": {
          "description": "The organization performing the service.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "requestingOrganization": {
          "description": "The organization requesting the service.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "costCenter": {
          "description": "The financial cost center permits the tracking of charge attribution.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "quantity": {
          "description": "Quantity of which the charge item has been serviced.",
          "$ref": "Quantity.schema.json#/definitions/Quantity"
        },
        "bodysite": {
          "description": "The anatomical location where the related service has been applied.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "unitPriceComponent": {
          "description": "The unit price of the chargable item.",
          "$ref": "MonetaryComponent.schema.json#/definitions/MonetaryComponent"
        },
        "totalPriceComponent": {
          "description": "The total price for the chargable item, accounting for the quantity.",
          "$ref": "MonetaryComponent.schema.json#/definitions/MonetaryComponent"
        },
        "overrideReason": {
          "description": "If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the  reason for this action.",
          "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
        },
        "enterer": {
          "description": "The device, practitioner, etc. who entered the charge item.",
          "$ref": "Reference.schema.json#/definitions/Reference"
        },
        "enteredDate": {
          "description": "Date the charge item was entered.",
          "$ref": "#/definitions/dateTime"
        },
        "_enteredDate": {
          "description": "Extensions for enteredDate",
          "$ref": "Element.schema.json#/definitions/Element"
        },
        "reason": {
          "description": "Describes why the event occurred in coded or textual form.",
          "items": {
            "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
          },
          "type": "array"
        },
        "service": {
          "description": "Indicated the rendered service that caused this charge.",
          "items": {
            "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
          },
          "type": "array"
        },
        "product": {
          "description": "Identifies the device, food, drug or other product being charged either by type code or reference to an instance.",
          "items": {
            "$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
          },
          "type": "array"
        },
        "account": {
          "description": "Account into which this ChargeItems belongs.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        },
        "note": {
          "description": "Comments made about the event by the performer, subject or other participants.",
          "items": {
            "$ref": "Annotation.schema.json#/definitions/Annotation"
          },
          "type": "array"
        },
        "supportingInformation": {
          "description": "Further information supporting this charge.",
          "items": {
            "$ref": "Reference.schema.json#/definitions/Reference"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false,
      "required": [
        "code",
        "subject",
        "resourceType"
      ]
    },
    "ChargeItem_Performer": {
      "description": "The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.",
      "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"
        },
        "function": {
          "description": "Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).",
          "$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"
      ]
    }
  }
}