Account

Trial Use 2 Financial

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.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/Account

Interaction	Method	Path
Read	GET	/fhir/R5/Account/[id]
Vread	GET	/fhir/R5/Account/[id]/_history/[vid]
Update	PUT	/fhir/R5/Account/[id]
Patch	PATCH	/fhir/R5/Account/[id]
Delete	DELETE	/fhir/R5/Account/[id]
Create	POST	/fhir/R5/Account
Search	GET	/fhir/R5/Account?...
History	GET	/fhir/R5/Account/[id]/_history
Type-history	GET	/fhir/R5/Account/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	Account number
status	code	1..1	active
billingStatus	CodeableConcept	0..1	Tracks the lifecycle of the account through the billing process
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	markdown	0..1	Explanation of purpose/use
guarantor	BackboneElement	0..*	The parties ultimately responsible for balancing the Account
diagnosis	BackboneElement	0..*	The list of diagnoses relevant to this account
procedure	BackboneElement	0..*	The list of procedures relevant to this account
relatedAccount	BackboneElement	0..*	Other associated accounts related to this account
currency	CodeableConcept	0..1	The base or default currency
balance	BackboneElement	0..*	Calculated account balance(s)
calculatedAt	instant	0..1	Time the balance amount was calculated

Resource-specific search parameters

Parameter	Type	Description
guarantor	reference	The parties ultimately responsible for balancing the Account
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
relatedaccount	reference	Parent and other related accounts
status	token	active
subject	reference	The entity that caused the expenses
type	token	E.g. patient, expense, depreciation

Reference

• Official FHIR R5 spec: Account
• Maturity: Trial Use 2 (FMM 2).