Account

ResourceFinancial · GeneralTrial useMaturity 2

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

8 of 8 parameters tested

Structure

Show inherited elements (14)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Account number
statusRequired?!Σ	1..1	code	active | inactive | entered-in-error | on-hold | unknownBinding (required): account-status
typeΣ	0..1	CodeableConcept	E.g. patient, expense, depreciationBinding (example): account-type
nameΣ	0..1	string	Human-readable label
subjectΣ	0..*	Reference(Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization)	The entity that caused the expenses
servicePeriodΣ	0..1	Period	Transaction window
coverageΣ	0..*	BackboneElement	The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
coverageRequiredΣ	1..1	Reference(Coverage)	The party(s), such as insurances, that may contribute to the payment of this account
priorityΣ	0..1	positiveInt	The priority of the coverage in the context of this account
ownerΣ	0..1	Reference(Organization)	Entity managing the Account
descriptionΣ	0..1	string	Explanation of purpose/use
guarantor	0..*	BackboneElement	The parties ultimately responsible for balancing the Account
partyRequired	1..1	Reference(Patient | RelatedPerson | Organization)	Responsible entity
onHold	0..1	boolean	Credit or other hold applied
period	0..1	Period	Guarantee account during
partOf	0..1	Reference(Account)	Reference to a parent Account

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Account?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
identifier	token	Account number Account.identifier
name	string	Human-readable label Account.name
owner	reference	Entity managing the Account Account.owner
patient	reference	The entity that caused the expenses Account.subject.where(resolve() is Patient)
period	date	Transaction window Account.servicePeriod
status	token	active | inactive | entered-in-error | on-hold | unknown Account.status
subject	reference	The entity that caused the expenses Account.subject
type	token	E.g. patient, expense, depreciation Account.type

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition