# Account

Canonical page: https://docs.ovok.com/api/fhir/r4/account

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.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/Account/[id]` |
| Vread | `GET` | `/fhir/R4/Account/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Account/[id]` |
| Patch | `PATCH` | `/fhir/R4/Account/[id]` |
| Delete | `DELETE` | `/fhir/R4/Account/[id]` |
| Create | `POST` | `/fhir/R4/Account` |
| Search | `GET` | `/fhir/R4/Account` |
| History | `GET` | `/fhir/R4/Account/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Account number |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | active \| inactive \| entered-in-error \| on-hold \| unknown |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | E.g. patient, expense, depreciation |
| <span id="element-name"></span>`name` | [string](/fhir-elements/primitive/string) | `0..1` | Human-readable label |
| <span id="element-subject"></span>`subject` | [Reference](/fhir-elements/complex/reference) | `0..*` | The entity that caused the expenses |
| <span id="element-service-period"></span>`servicePeriod` | [Period](/fhir-elements/complex/period) | `0..1` | Transaction window |
| <span id="element-coverage"></span>`coverage` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account |
| <span id="element-owner"></span>`owner` | [Reference](/fhir-elements/complex/reference) | `0..1` | Entity managing the Account |
| <span id="element-description"></span>`description` | [string](/fhir-elements/primitive/string) | `0..1` | Explanation of purpose/use |
| <span id="element-guarantor"></span>`guarantor` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | The parties ultimately responsible for balancing the Account |
| <span id="element-part-of"></span>`partOf` | [Reference](/fhir-elements/complex/reference) | `0..1` | Reference to a parent Account |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `identifier` | token | Account number |
| `name` | string | Human-readable label |
| `owner` | reference | Entity managing the Account |
| `patient` | reference | The entity that caused the expenses |
| `period` | date | Transaction window |
| `status` | token | active \| inactive \| entered-in-error \| on-hold \| unknown |
| `subject` | reference | The entity that caused the expenses |
| `type` | token | E.g. patient, expense, depreciation |

## Reference [#reference]

Official FHIR R4 spec: [Account](https://hl7.org/fhir/R4/account.html).  
Maturity: Trial Use 2 (FMM 2).
