fhir-schemas/fhir.schema.json/Account.schema.json

Schemas for Fast Healthcare Interoperability Resources.

{
  "schema": "http://json-schema.org/draft-04/schema#",
  "$id": "http://hl7.org/fhir/json-schema/Account",
  "$ref": "#/definitions/Account",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "Account": {
      "allOf": [
        {
          "$ref": "DomainResource#/definitions/DomainResource"
        },
        {
          "description": "A financial tool for tracking value accrued for a particular purpose.  In the healthcare field, used to track charges for a patient, cost centers, etc.",
          "properties": {
            "resourceType": {
              "description": "This is a Account resource",
              "type": "string",
              "enum": [
                "Account"
              ]
            },
            "identifier": {
              "description": "Unique identifier used to reference the account.  May or may not be intended for human use (e.g. credit card number).",
              "type": "array",
              "items": {
                "$ref": "http://hl7.org/fhir/json-schema/Identifier#/definitions/Identifier"
              }
            },
            "status": {
              "description": "Indicates whether the account is presently used/usable or not.",
              "enum": [
                "active",
                "inactive",
                "entered-in-error"
              ],
              "type": "string"
            },
            "_status": {
              "description": "Extensions for status",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "type": {
              "description": "Categorizes the account for reporting and searching purposes.",
              "$ref": "http://hl7.org/fhir/json-schema/CodeableConcept#/definitions/CodeableConcept"
            },
            "name": {
              "description": "Name used for the account when displaying it to humans in reports, etc.",
              "type": "string"
            },
            "_name": {
              "description": "Extensions for name",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "subject": {
              "description": "Identifies the patient, device, practitioner, location or other object the account is associated with.",
              "$ref": "http://hl7.org/fhir/json-schema/Reference#/definitions/Reference"
            },
            "period": {
              "description": "Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.",
              "$ref": "http://hl7.org/fhir/json-schema/Period#/definitions/Period"
            },
            "active": {
              "description": "Indicates the period of time over which the account is allowed to have transactions posted to it.\nThis period may be different to the coveragePeriod which is the duration of time that services may occur.",
              "$ref": "http://hl7.org/fhir/json-schema/Period#/definitions/Period"
            },
            "balance": {
              "description": "Represents the sum of all credits less all debits associated with the account.  Might be positive, zero or negative.",
              "$ref": "http://hl7.org/fhir/json-schema/Money#/definitions/Money"
            },
            "coverage": {
              "description": "The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.",
              "type": "array",
              "items": {
                "$ref": "#/definitions/Account_Coverage"
              }
            },
            "owner": {
              "description": "Indicates the organization, department, etc. with responsibility for the account.",
              "$ref": "http://hl7.org/fhir/json-schema/Reference#/definitions/Reference"
            },
            "description": {
              "description": "Provides additional information about what the account tracks and how it is used.",
              "type": "string"
            },
            "_description": {
              "description": "Extensions for description",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "guarantor": {
              "description": "Parties financially responsible for the account.",
              "type": "array",
              "items": {
                "$ref": "#/definitions/Account_Guarantor"
              }
            }
          },
          "required": [
            "resourceType"
          ]
        }
      ]
    },
    "Account_Coverage": {
      "allOf": [
        {
          "$ref": "BackboneElement#/definitions/BackboneElement"
        },
        {
          "description": "A financial tool for tracking value accrued for a particular purpose.  In the healthcare field, used to track charges for a patient, cost centers, etc.",
          "properties": {
            "coverage": {
              "description": "The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay).\n\nA coverage may only be resposible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.",
              "$ref": "http://hl7.org/fhir/json-schema/Reference#/definitions/Reference"
            },
            "priority": {
              "description": "The priority of the coverage in the context of this account.",
              "type": "number",
              "pattern": "[1-9][0-9]*"
            },
            "_priority": {
              "description": "Extensions for priority",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            }
          },
          "required": [
            "coverage"
          ]
        }
      ]
    },
    "Account_Guarantor": {
      "allOf": [
        {
          "$ref": "BackboneElement#/definitions/BackboneElement"
        },
        {
          "description": "A financial tool for tracking value accrued for a particular purpose.  In the healthcare field, used to track charges for a patient, cost centers, etc.",
          "properties": {
            "party": {
              "description": "The entity who is responsible.",
              "$ref": "http://hl7.org/fhir/json-schema/Reference#/definitions/Reference"
            },
            "onHold": {
              "description": "A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.",
              "type": "boolean"
            },
            "_onHold": {
              "description": "Extensions for onHold",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "period": {
              "description": "The timeframe during which the guarantor accepts responsibility for the account.",
              "$ref": "http://hl7.org/fhir/json-schema/Period#/definitions/Period"
            }
          },
          "required": [
            "party"
          ]
        }
      ]
    }
  }
}