DSTU2 STU 3 Ballot
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

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

5.7 8.8 Resource Account - Content Resource Account - Content

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.
Patient Administration Patient Administration Work Group Work Group Maturity Level : 0 Maturity Level : 0 Compartments : : 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.7.1 Scope and Usage 8.8.1 Scope and Usage Todo

Todo

This resource is referenced by Encounter and EpisodeOfCare

5.7.2 Resource Content 8.8.2 Resource Content

Structure

Name Flags Card. Type Description & Constraints Description & Constraints doco
. . Account Σ DomainResource
. . . identifier Σ 0..* Identifier Account number Account number
. . . name Σ 0..1 string Human-readable label Human-readable label
. . . type Σ 0..1 CodeableConcept E.g. patient, expense, depreciation E.g. patient, expense, depreciation
. . . status ?! Σ 0..1 code active | inactive active | inactive | entered-in-error
AccountStatus ( Preferred ( Required )
. . activePeriod . active Σ 0..1 Period Valid from..to Time window that transactions may be posted to this account
. . . currency Σ 0..1 Coding Base currency in which balance is tracked Base currency in which balance is tracked
AccountCurrency AccountCurrency ( ( Example )
. . . balance Σ 0..1 Money How much is in account? How much is in account?
. . coveragePeriod . coverage Σ 0..* Reference ( Coverage ) The party(s) that are responsible for covering the payment of this account
... coveragePeriod Σ 0..1 Period Transaction window Transaction window
. . . subject Σ 0..1 Reference ( Patient | | Device | | Practitioner | | Location | | HealthcareService | | Organization ) What is account tied to? What is account tied to?
. . . owner Σ 0..1 Reference ( Organization ) Who is responsible? Who is responsible?
. . . description Σ 0..1 string Explanation of purpose/use Explanation of purpose/use

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram ( Legend )

Account ( ( DomainResource ) Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number) Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number) identifier : : Identifier [0..*] [0..*] Name used for the account when displaying it to humans in reports, etc Name used for the account when displaying it to humans in reports, etc name : : string [0..1] [0..1] Categorizes the account for reporting and searching purposes Categorizes the account for reporting and searching purposes type : : CodeableConcept [0..1] [0..1] Indicates whether the account is presently used/useable or not (this element modifies the meaning of other elements) Indicates whether the account is presently used/useable or not (this element modifies the meaning of other elements) status : : code [0..1] « [0..1] « Indicates whether the account is available to be used. (Strength=Preferred) Indicates whether the account is available to be used. (Strength=Required) AccountStatus ? » ! » Indicates the period of time over which the account is allowed Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occur activePeriod : active : Period [0..1] [0..1] Identifies the currency to which transactions must be converted when crediting or debiting the account Identifies the currency to which transactions must be converted when crediting or debiting the account currency : : Coding [0..1] « [0..1] « The monetary currency in which this account records values. (Strength=Example) 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 negative Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative balance : Quantity ( : Money ) [0..1] [0..1] The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay). A coverage may only be resposible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing coverage : Reference [0..*] « Coverage » Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc coveragePeriod : : Period [0..1] [0..1] Identifies the patient, device, practitioner, location or other object the account is associated with Identifies the patient, device, practitioner, location or other object the account is associated with subject : : Reference [0..1] « [0..1] « Patient | Device | Practitioner | Location | HealthcareService | Organization » » Indicates the organization, department, etc. with responsibility for the account Indicates the organization, department, etc. with responsibility for the account owner : : Reference [0..1] « [0..1] « Organization » » Provides additional information about what the account tracks and how it is used Provides additional information about what the account tracks and how it is used description : : string [0..1] [0..1]

XML Template XML Template < 

<Account xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</identifier>
 <
 <</type>
 <
 <</activePeriod>
 <</currency>
 <</balance>
 <</coveragePeriod>
 <|

 <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 | entered-in-error -->
 <active><!-- 0..1 Period Time window that transactions may be posted to this account --></active>
 <currency><!-- 0..1 Coding Base currency in which balance is tracked  --></currency>
 <balance><!-- 0..1 Money How much is in account? --></balance>
 <coverage><!-- 0..* Reference(Coverage) The party(s) that are responsible for covering the payment of this account --></coverage>
 <coveragePeriod><!-- 0..1 Period Transaction window --></coveragePeriod>
 <subject><!-- 0..1 Reference(Patient|Device|Practitioner|Location|

   HealthcareService|Organization) What is account tied to? --></subject>
 <</owner>
 <

 <owner><!-- 0..1 Reference(Organization) Who is responsible? --></owner>
 <description value="[string]"/><!-- 0..1 Explanation of purpose/use -->

</Account>

Turtle Template 


@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Account;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Account.identifier [ Identifier ], ... ; # 0..* Account number
  fhir:Account.name [ string ]; # 0..1 Human-readable label
  fhir:Account.type [ CodeableConcept ]; # 0..1 E.g. patient, expense, depreciation
  fhir:Account.status [ code ]; # 0..1 active | inactive | entered-in-error
  fhir:Account.active [ Period ]; # 0..1 Time window that transactions may be posted to this account
  fhir:Account.currency [ Coding ]; # 0..1 Base currency in which balance is tracked
  fhir:Account.balance [ Money ]; # 0..1 How much is in account?
  fhir:Account.coverage [ Reference(Coverage) ], ... ; # 0..* The party(s) that are responsible for covering the payment of this account
  fhir:Account.coveragePeriod [ Period ]; # 0..1 Transaction window
  fhir:Account.subject [ Reference(Patient|Device|Practitioner|Location|HealthcareService|Organization) ]; # 0..1 What is account tied to?
  fhir:Account.owner [ Reference(Organization) ]; # 0..1 Who is responsible?
  fhir:Account.description [ string ]; # 0..1 Explanation of purpose/use
]

Changes since DSTU2

Account
Account.status Add Binding http://hl7.org/fhir/ValueSet/account-status (required)
Account.active Renamed from activePeriod to active
Account.balance Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money
Account.coverage added

See the Full Difference for further information

Structure

Name Flags Card. Type Description & Constraints Description & Constraints doco
. . Account Σ DomainResource
. . . identifier Σ 0..* Identifier Account number Account number
. . . name Σ 0..1 string Human-readable label Human-readable label
. . . type Σ 0..1 CodeableConcept E.g. patient, expense, depreciation E.g. patient, expense, depreciation
. . . status ?! Σ 0..1 code active | inactive active | inactive | entered-in-error
AccountStatus ( Preferred ( Required )
. . activePeriod . active Σ 0..1 Period Valid from..to Time window that transactions may be posted to this account
. . . currency Σ 0..1 Coding Base currency in which balance is tracked Base currency in which balance is tracked
AccountCurrency AccountCurrency ( ( Example )
. . . balance Σ 0..1 Money How much is in account? How much is in account?
. . coveragePeriod . coverage Σ 0..* Reference ( Coverage ) The party(s) that are responsible for covering the payment of this account
... coveragePeriod Σ 0..1 Period Transaction window Transaction window
. . . subject Σ 0..1 Reference ( Patient | | Device | | Practitioner | | Location | | HealthcareService | | Organization ) What is account tied to? What is account tied to?
. . . owner Σ 0..1 Reference ( Organization ) Who is responsible? Who is responsible?
. . . description Σ 0..1 string Explanation of purpose/use Explanation of purpose/use

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram ( Legend )

Account ( ( DomainResource ) Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number) Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number) identifier : : Identifier [0..*] [0..*] Name used for the account when displaying it to humans in reports, etc Name used for the account when displaying it to humans in reports, etc name : : string [0..1] [0..1] Categorizes the account for reporting and searching purposes Categorizes the account for reporting and searching purposes type : : CodeableConcept [0..1] [0..1] Indicates whether the account is presently used/useable or not (this element modifies the meaning of other elements) Indicates whether the account is presently used/useable or not (this element modifies the meaning of other elements) status : : code [0..1] « [0..1] « Indicates whether the account is available to be used. (Strength=Preferred) Indicates whether the account is available to be used. (Strength=Required) AccountStatus ? » ! » Indicates the period of time over which the account is allowed Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occur activePeriod : active : Period [0..1] [0..1] Identifies the currency to which transactions must be converted when crediting or debiting the account Identifies the currency to which transactions must be converted when crediting or debiting the account currency : : Coding [0..1] « [0..1] « The monetary currency in which this account records values. (Strength=Example) 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 negative Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative balance : Quantity ( : Money ) [0..1] [0..1] The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay). A coverage may only be resposible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing coverage : Reference [0..*] « Coverage » Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc coveragePeriod : : Period [0..1] [0..1] Identifies the patient, device, practitioner, location or other object the account is associated with Identifies the patient, device, practitioner, location or other object the account is associated with subject : : Reference [0..1] « [0..1] « Patient | Device | Practitioner | Location | HealthcareService | Organization » » Indicates the organization, department, etc. with responsibility for the account Indicates the organization, department, etc. with responsibility for the account owner : : Reference [0..1] « [0..1] « Organization » » Provides additional information about what the account tracks and how it is used Provides additional information about what the account tracks and how it is used description : : string [0..1] [0..1]

XML Template XML Template < 

<Account xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</identifier>
 <
 <</type>
 <
 <</activePeriod>
 <</currency>
 <</balance>
 <</coveragePeriod>
 <|

 <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 | entered-in-error -->
 <active><!-- 0..1 Period Time window that transactions may be posted to this account --></active>
 <currency><!-- 0..1 Coding Base currency in which balance is tracked  --></currency>
 <balance><!-- 0..1 Money How much is in account? --></balance>
 <coverage><!-- 0..* Reference(Coverage) The party(s) that are responsible for covering the payment of this account --></coverage>
 <coveragePeriod><!-- 0..1 Period Transaction window --></coveragePeriod>
 <subject><!-- 0..1 Reference(Patient|Device|Practitioner|Location|

   HealthcareService|Organization) What is account tied to? --></subject>
 <</owner>
 <

 <owner><!-- 0..1 Reference(Organization) Who is responsible? --></owner>
 <description value="[string]"/><!-- 0..1 Explanation of purpose/use -->

</Account>

Turtle Template 


@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Account;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Account.identifier [ Identifier ], ... ; # 0..* Account number
  fhir:Account.name [ string ]; # 0..1 Human-readable label
  fhir:Account.type [ CodeableConcept ]; # 0..1 E.g. patient, expense, depreciation
  fhir:Account.status [ code ]; # 0..1 active | inactive | entered-in-error
  fhir:Account.active [ Period ]; # 0..1 Time window that transactions may be posted to this account
  fhir:Account.currency [ Coding ]; # 0..1 Base currency in which balance is tracked
  fhir:Account.balance [ Money ]; # 0..1 How much is in account?
  fhir:Account.coverage [ Reference(Coverage) ], ... ; # 0..* The party(s) that are responsible for covering the payment of this account
  fhir:Account.coveragePeriod [ Period ]; # 0..1 Transaction window
  fhir:Account.subject [ Reference(Patient|Device|Practitioner|Location|HealthcareService|Organization) ]; # 0..1 What is account tied to?
  fhir:Account.owner [ Reference(Organization) ]; # 0..1 Who is responsible?
  fhir:Account.description [ string ]; # 0..1 Explanation of purpose/use
]

Changes since DSTU2

Account
Account.status Add Binding http://hl7.org/fhir/ValueSet/account-status (required)
Account.active Renamed from activePeriod to active
Account.balance Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money
Account.coverage added

See the Full Difference for further information

 

Alternate definitions: Master Definition ( XML , JSON ), XML Schema / Schematron , Resource Profile ( XML , (for ) + JSON Schema , ShEx (for Turtle ), Questionnaire )

5.7.2.1 Terminology Bindings 8.8.2.1 Terminology Bindings

Account.type Account.status Account.currency
Path Definition Type Reference
Account.type The usage type of this account, permits categorization of accounts. The usage type of this account, permits categorization of accounts. Unknown No details provided yet No details provided yet
Account.status Indicates whether the account is available to be used. Indicates whether the account is available to be used. Preferred Required AccountStatus
Account.currency The monetary currency in which this account records values. The monetary currency in which this account records values. Example Currency codes - ISO 4217 Currency codes - ISO 4217

5.7.3 Search Parameters 8.8.3 Search Parameters Search parameters for this resource. The common parameters also apply. See

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

© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100. Links: Search | Version History | Table of Contents | Compare to DSTU1
Name Type Description Paths
balance quantity How much is in account? How much is in account? Account.balance
identifier token Account number Account number Account.identifier
name string Human-readable label Human-readable label Account.name
owner reference Who is responsible? Who is responsible? Account.owner
( Organization )
patient reference What is account tied to? What is account tied to? Account.subject
( Patient )
period date Transaction window Transaction window Account.coveragePeriod
status token active | inactive active | inactive | entered-in-error Account.status
subject reference What is account tied to? What is account tied to? Account.subject
( Device , Practitioner , Organization , , Device , Patient , HealthcareService , , Location , Patient , Practitioner )
type token E.g. patient, expense, depreciation E.g. patient, expense, depreciation Account.type