STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

5.8 Resource Account - Content

Patient Administration Work GroupMaturity Level: 0Compartments: Device, Patient, Practitioner

A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centres, etc.

5.8.1 Scope and Usage

Todo

5.8.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Account ΣDomainResource
... identifier Σ0..*IdentifierAccount number
... name Σ0..1stringHuman-readable label
... type Σ0..1CodeableConceptE.g. patient, expense, depreciation
... status ?! Σ0..1codeactive | inactive
AccountStatus (Preferred)
... activePeriod Σ0..1PeriodValid from..to
... currency Σ0..1CodingBase currency in which balance is tracked
AccountCurrency (Example)
... balance Σ0..1MoneyHow much is in account?
... coveragePeriod Σ0..1PeriodTransaction window
... subject Σ0..1Reference(Patient | Device | Practitioner | Location | HealthcareService | Organization)What is account tied to?
... owner Σ0..1Reference(Organization)Who is responsible?
... description Σ0..1stringExplanation of purpose/use

doco Documentation for this format

UML Diagram

Account (DomainResource)Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number)identifier : Identifier [0..*]Name used for the account when displaying it to humans in reports, etcname : string [0..1]Categorizes the account for reporting and searching purposestype : CodeableConcept [0..1]Indicates whether the account is presently used/useable or not (this element modifies the meaning of other elements)status : code [0..1] « Indicates whether the account is available to be used. (Strength=Preferred)AccountStatus? »Indicates the period of time over which the account is allowedactivePeriod : Period [0..1]Identifies the currency to which transactions must be converted when crediting or debiting the accountcurrency : Coding [0..1] « The monetary currency in which this account records values. (Strength=Example)AccountCurrency?? »Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negativebalance : Quantity(Money) [0..1]Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etccoveragePeriod : Period [0..1]Identifies the patient, device, practitioner, location or other object the account is associated withsubject : Reference [0..1] « Patient|Device|Practitioner|Location| HealthcareService|Organization »Indicates the organization, department, etc. with responsibility for the accountowner : Reference [0..1] « Organization »Provides additional information about what the account tracks and how it is useddescription : string [0..1]

XML Template

<Account xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Account number --></identifier>
 <name value="[string]"/><!-- 0..1 Human-readable label -->
 <type><!-- 0..1 CodeableConcept E.g. patient, expense, depreciation --></type>
 <status value="[code]"/><!-- 0..1 active | inactive -->
 <activePeriod><!-- 0..1 Period Valid from..to --></activePeriod>
 <currency><!-- 0..1 Coding Base currency in which balance is tracked  --></currency>
 <balance><!-- 0..1 Quantity(Money) How much is in account? --></balance>
 <coveragePeriod><!-- 0..1 Period Transaction window --></coveragePeriod>
 <subject><!-- 0..1 Reference(Patient|Device|Practitioner|Location|
   HealthcareService|Organization) What is account tied to? --></subject>
 <owner><!-- 0..1 Reference(Organization) Who is responsible? --></owner>
 <description value="[string]"/><!-- 0..1 Explanation of purpose/use -->
</Account>

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Account ΣDomainResource
... identifier Σ0..*IdentifierAccount number
... name Σ0..1stringHuman-readable label
... type Σ0..1CodeableConceptE.g. patient, expense, depreciation
... status ?! Σ0..1codeactive | inactive
AccountStatus (Preferred)
... activePeriod Σ0..1PeriodValid from..to
... currency Σ0..1CodingBase currency in which balance is tracked
AccountCurrency (Example)
... balance Σ0..1MoneyHow much is in account?
... coveragePeriod Σ0..1PeriodTransaction window
... subject Σ0..1Reference(Patient | Device | Practitioner | Location | HealthcareService | Organization)What is account tied to?
... owner Σ0..1Reference(Organization)Who is responsible?
... description Σ0..1stringExplanation of purpose/use

doco Documentation for this format

UML Diagram

Account (DomainResource)Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number)identifier : Identifier [0..*]Name used for the account when displaying it to humans in reports, etcname : string [0..1]Categorizes the account for reporting and searching purposestype : CodeableConcept [0..1]Indicates whether the account is presently used/useable or not (this element modifies the meaning of other elements)status : code [0..1] « Indicates whether the account is available to be used. (Strength=Preferred)AccountStatus? »Indicates the period of time over which the account is allowedactivePeriod : Period [0..1]Identifies the currency to which transactions must be converted when crediting or debiting the accountcurrency : Coding [0..1] « The monetary currency in which this account records values. (Strength=Example)AccountCurrency?? »Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negativebalance : Quantity(Money) [0..1]Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etccoveragePeriod : Period [0..1]Identifies the patient, device, practitioner, location or other object the account is associated withsubject : Reference [0..1] « Patient|Device|Practitioner|Location| HealthcareService|Organization »Indicates the organization, department, etc. with responsibility for the accountowner : Reference [0..1] « Organization »Provides additional information about what the account tracks and how it is useddescription : string [0..1]

XML Template

<Account xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Account number --></identifier>
 <name value="[string]"/><!-- 0..1 Human-readable label -->
 <type><!-- 0..1 CodeableConcept E.g. patient, expense, depreciation --></type>
 <status value="[code]"/><!-- 0..1 active | inactive -->
 <activePeriod><!-- 0..1 Period Valid from..to --></activePeriod>
 <currency><!-- 0..1 Coding Base currency in which balance is tracked  --></currency>
 <balance><!-- 0..1 Quantity(Money) How much is in account? --></balance>
 <coveragePeriod><!-- 0..1 Period Transaction window --></coveragePeriod>
 <subject><!-- 0..1 Reference(Patient|Device|Practitioner|Location|
   HealthcareService|Organization) What is account tied to? --></subject>
 <owner><!-- 0..1 Reference(Organization) Who is responsible? --></owner>
 <description value="[string]"/><!-- 0..1 Explanation of purpose/use -->
</Account>

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

5.8.2.1 Terminology Bindings

PathDefinitionTypeReference
Account.type The usage type of this account, permits categorization of accounts.UnknownNo details provided yet
Account.status Indicates whether the account is available to be used.PreferredAccountStatus
Account.currency The monetary currency in which this account records values.ExampleCurrency codes - ISO 4217

5.8.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
balancequantityHow much is in account?Account.balance
identifiertokenAccount numberAccount.identifier
namestringHuman-readable labelAccount.name
ownerreferenceWho is responsible?Account.owner
(Organization)
patientreferenceWhat is account tied to?Account.subject
(Patient)
perioddateTransaction windowAccount.coveragePeriod
statustokenactive | inactiveAccount.status
subjectreferenceWhat is account tied to?Account.subject
(Device, Organization, HealthcareService, Location, Patient, Practitioner)
typetokenE.g. patient, expense, depreciationAccount.type