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
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Account number |
status | code | 1..1 | active | inactive | entered-in-error | on-hold | unknown |
type | CodeableConcept | 0..1 | E.g. patient, expense, depreciation |
name | string | 0..1 | Human-readable label |
subject | Reference | 0..* | The entity that caused the expenses |
servicePeriod | Period | 0..1 | Transaction window |
coverage | BackboneElement | 0..* | The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account |
owner | Reference | 0..1 | Entity managing the Account |
description | string | 0..1 | Explanation of purpose/use |
guarantor | BackboneElement | 0..* | The parties ultimately responsible for balancing the Account |
partOf | Reference | 0..1 | Reference to a parent Account |
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
Official FHIR R4 spec: Account.
Maturity: Trial Use 2 (FMM 2).