PATIENT ADMINISTRTAION (PA) Workgroup Development Draft

5.7 Resource Account - Content

This resource maintained by the Patient Administration Work Group. Maturity Level: null

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.7.1 Scope and Usage

Todo

5.7.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
AccountType (Required)
... status ?!0..1codeactive | inactive
AccountStatus (Preferred)
... activePeriod 0..1PeriodValid from..to
... currency 0..1CodingBase currency in which balance is tracked
Currency (Preferred)
... balance 0..1MoneyHow much is in account?
... coveragePeriod 0..1PeriodTransaction window
... subject 0..1Patient | Device | Practitioner | Location | HealthcareService | OrganizationWhat is account tied to?
... owner 0..1OrganizationWho is responsible?
... description 0..1stringExplanation of purpose/use

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..1Categorizes the account for reporting and searching purposestype : CodeableConcept 0..1 « Identifies the "category" an account falls in (expenses, cost center, etc.)AccountType »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 usedAccountStatus+ »Indicates the period of time over which the account is allowedactivePeriod : Period 0..1Identifies the currency to which transactions must be converted when crediting or debiting the accountcurrency : Coding 0..1 « Currency that this account operates inCurrency+ »Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negativebalance : Money 0..1Identifies the period of time the account applies to. E.g. accounts created per fiscal year, quarter, etccoveragePeriod : Period 0..1Identifies the patient, device, practitioner, location or other object the account is associated withsubject : Reference(Patient|Device|Practitioner| Location|HealthcareService|Organization) 0..1Indicates the organization, department, etc. with responsibility for the accountowner : Reference(Organization) 0..1Provides 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 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
AccountType (Required)
... status ?!0..1codeactive | inactive
AccountStatus (Preferred)
... activePeriod 0..1PeriodValid from..to
... currency 0..1CodingBase currency in which balance is tracked
Currency (Preferred)
... balance 0..1MoneyHow much is in account?
... coveragePeriod 0..1PeriodTransaction window
... subject 0..1Patient | Device | Practitioner | Location | HealthcareService | OrganizationWhat is account tied to?
... owner 0..1OrganizationWho is responsible?
... description 0..1stringExplanation of purpose/use

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..1Categorizes the account for reporting and searching purposestype : CodeableConcept 0..1 « Identifies the "category" an account falls in (expenses, cost center, etc.)AccountType »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 usedAccountStatus+ »Indicates the period of time over which the account is allowedactivePeriod : Period 0..1Identifies the currency to which transactions must be converted when crediting or debiting the accountcurrency : Coding 0..1 « Currency that this account operates inCurrency+ »Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negativebalance : Money 0..1Identifies the period of time the account applies to. E.g. accounts created per fiscal year, quarter, etccoveragePeriod : Period 0..1Identifies the patient, device, practitioner, location or other object the account is associated withsubject : Reference(Patient|Device|Practitioner| Location|HealthcareService|Organization) 0..1Indicates the organization, department, etc. with responsibility for the accountowner : Reference(Organization) 0..1Provides 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 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)

5.7.2.1 Terminology Bindings

PathDefinitionTypeReference
Account.type Identifies the "category" an account falls in (expenses, cost center, etc.)Requiredhttp://hl7.org/fhir/account-type
Account.status Indicates whether the account is available to be usedPreferredhttp://hl7.org/fhir/account-status
Account.currency Currency that this account operates inPreferredhttp://hl7.org/fhir/account-currency

5.7.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
balancenumberHow 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
typetokenE.g. patient, expense, depreciationAccount.type