This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
(v3.5.0:
R4
Ballot
#2).
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
Patient
Administration
Work
Group
|
Maturity Level : 2 | Trial Use | 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 centers, etc.
Todo
The
Account
resource
acts
as
a
central
record
against
which
charges,
payments,
and
adjustments
are
applied.
It
contains
information
about
which
parties
are
responsible
for
payment
of
the
account.
While the Account does conceptually have a balance, expressing that balance directly as a resource property is challenging due to the complexity of pricing contracts. An operation to retrieve the current balance of an account is in consideration as future work.
The Account itself does not include information about the charges, payments or adjustments, but rather those resources, such as ChargeItem point to the account to which they apply. Payment and adjustment resources have not yet been developed.
The Account resource can be considered a "bucket" to which ChargeItem resources are linked. These charges are processed by a billing system, which determines the responsible parties for the balance of the account. The billing system then submits claims or sends statements to the appropriate parties. Once payment is received, an adjustment is applied to the Account. The internal calculation of balances and allocation of responsibility is expected to be internal to the billing systems. Only the inputs and outputs of the billing process is communicated in the relevant financial FHIR resources.
This
resource
is
referenced
by
itself,
ChargeItem
,
Encounter
,
EpisodeOfCare
and
EpisodeOfCare
Invoice
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Tracks
balance,
charges,
for
patient
or
cost
center
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Account
number
|
|
?! Σ |
|
code |
active
|
inactive
|
entered-in-error
|
on-hold
|
unknown
AccountStatus ( Required ) |
|
Σ | 0..1 | CodeableConcept |
E.g.
patient,
expense,
depreciation
Account Types ( Example ) |
|
Σ | 0..1 | string | Human-readable label |
|
Σ |
|
Reference ( Patient | Device | Practitioner | Location | HealthcareService | Organization ) |
What
is
account
tied
to?
|
|
Σ | 0..1 | Period |
|
|
Σ | 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
|
|
Σ | 1..1 | Reference ( Coverage ) |
The
|
|
Σ | 0..1 | positiveInt | The priority of the coverage in the context of this account |
|
Σ | 0..1 | Reference ( Organization ) | Who is responsible? |
|
Σ | 0..1 | string | Explanation of purpose/use |
|
0..* | BackboneElement |
Responsible
for
the
account
|
|
|
1..1 | Reference ( Patient | RelatedPerson | Organization ) | Responsible entity | |
|
0..1 | boolean | Credit or other hold applied | |
|
0..1 | Period |
|
|
| 0..1 | Reference ( Account ) | Reference to a parent Account | |
Documentation
for
this
format
|
||||
UML Diagram ( Legend )
XML Template
<<Account xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> <<identifier><!-- 0..* Identifier Account number --></identifier> <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error | on-hold | unknown --> <type><!-- 0..1 CodeableConcept E.g. patient, expense, depreciation --></type>< <|<name value="[string]"/><!-- 0..1 Human-readable label --> <subject><!-- 0..* Reference(Patient|Device|Practitioner|Location| HealthcareService|Organization) What is account tied to? --></subject><</period> <<a href="account-definitions.html#Account.active" title="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." class="dict"></active> <</balance><servicePeriod><!-- 0..1 Period Transaction window --></servicePeriod> <coverage> <!-- 0..* The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account --><<a href="account-definitions.html#Account.coverage.coverage" title="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." class="dict"></coverage> < 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." class="dict">coverage><!-- 1..1 Reference(Coverage) The party(s), such as insurances, that may contribute to the payment of this account --></coverage> <priority value="[positiveInt]"/><!-- 0..1 The priority of the coverage in the context of this account --> </coverage> <owner><!-- 0..1 Reference(Organization) Who is responsible? --></owner><<description value="[string]"/><!-- 0..1 Explanation of purpose/use --> <guarantor> <!-- 0..* Responsible for the account --> <party><!-- 1..1 Reference(Patient|RelatedPerson|Organization) Responsible entity --></party>< <</period><onHold value="[boolean]"/><!-- 0..1 Credit or other hold applied --> <period><!-- 0..1 Period Guarantee account during --></period> </guarantor> <partOf><!-- 0..1 Reference(Account) Reference to a parent Account --></partOf> </Account>
JSON Template
{
"resourceType" : "",
"resourceType" : "Account",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"|
"
"<a href="account-definitions.html#Account.active" title="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." class="dict">active
"
"
"<a href="account-definitions.html#Account.coverage.coverage" title="The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay).
"identifier" : [{ Identifier }], // Account number
"status" : "<code>", // R! active | inactive | entered-in-error | on-hold | unknown
"type" : { CodeableConcept }, // E.g. patient, expense, depreciation
"name" : "<string>", // Human-readable label
"subject" : [{ Reference(Patient|Device|Practitioner|Location|
HealthcareService|Organization) }], // What is account tied to?
"servicePeriod" : { Period }, // Transaction window
"coverage" : [{ // The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
"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." class="dict">coverage
"
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." class="dict">coverage" : { Reference(Coverage) }, // R! The party(s), such as insurances, that may contribute to the payment of this account
"priority" : "<positiveInt>" // The priority of the coverage in the context of this account
}],
"
"
"
"
"
"
}]
"owner" : { Reference(Organization) }, // Who is responsible?
"description" : "<string>", // Explanation of purpose/use
"guarantor" : [{ // Responsible for the account
"party" : { Reference(Patient|RelatedPerson|Organization) }, // R! Responsible entity
"onHold" : <boolean>, // Credit or other hold applied
"period" : { Period } // Guarantee account during
}],
"partOf" : { Reference(Account) } // Reference to a parent Account
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ 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: fhir:fhir:Account.identifier [ Identifier ], ... ; # 0..* Account number fhir:Account.status [ code ]; # 1..1 active | inactive | entered-in-error | on-hold | unknown fhir:Account.type [ CodeableConcept ]; # 0..1 E.g. patient, expense, depreciation fhir:Account.name [ string ]; # 0..1 Human-readable labelfhir: fhir: fhir:<a href="account-definitions.html#Account.active" title="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." class="dict">Account.active fhir:fhir:Account.subject [ Reference(Patient|Device|Practitioner|Location|HealthcareService|Organization) ], ... ; # 0..* What is account tied to? fhir:Account.servicePeriod [ Period ]; # 0..1 Transaction window fhir:Account.coverage [ # 0..* The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the accountfhir:<a href="account-definitions.html#Account.coverage.coverage" title="The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay).fhir: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." class="dict">Account.coverage.coverage 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." class="dict">Account.coverage.coverage [ Reference(Coverage) ]; # 1..1 The party(s), such as insurances, that may contribute to the payment of this account fhir:Account.coverage.priority [ positiveInt ]; # 0..1 The priority of the coverage in the context of this account ], ...; fhir:Account.owner [ Reference(Organization) ]; # 0..1 Who is responsible? fhir:Account.description [ string ]; # 0..1 Explanation of purpose/use fhir:Account.guarantor [ # 0..* Responsible for the account fhir:Account.guarantor.party [ Reference(Patient|RelatedPerson|Organization) ]; # 1..1 Responsible entity fhir:Account.guarantor.onHold [ boolean ]; # 0..1 Credit or other hold appliedfhir:fhir:Account.guarantor.period [ Period ]; # 0..1 Guarantee account during ], ...; fhir:Account.partOf [ Reference(Account) ]; # 0..1 Reference to a parent Account ]
Changes
since
DSTU2
R3
| Account |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See
R2
<-->
R3
<-->
R4
Conversion
Maps
(status
=
1
test
that
all
execute
ok.
All
2
tests
pass
round-trip
testing
and
all
r3
resources
are
valid.).
of
which
2
fail
to
execute
.)
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Tracks
balance,
charges,
for
patient
or
cost
center
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Account
number
|
|
?! Σ |
|
code |
active
|
inactive
|
entered-in-error
|
on-hold
|
unknown
AccountStatus ( Required ) |
|
Σ | 0..1 | CodeableConcept |
E.g.
patient,
expense,
depreciation
Account Types ( Example ) |
|
Σ | 0..1 | string | Human-readable label |
|
Σ |
|
Reference ( Patient | Device | Practitioner | Location | HealthcareService | Organization ) |
What
is
account
tied
to?
|
|
Σ | 0..1 | Period |
|
|
Σ | 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
|
|
Σ | 1..1 | Reference ( Coverage ) |
The
|
|
Σ | 0..1 | positiveInt | The priority of the coverage in the context of this account |
|
Σ | 0..1 | Reference ( Organization ) | Who is responsible? |
|
Σ | 0..1 | string | Explanation of purpose/use |
|
0..* | BackboneElement |
Responsible
for
the
account
|
|
|
1..1 | Reference ( Patient | RelatedPerson | Organization ) | Responsible entity | |
|
0..1 | boolean | Credit or other hold applied | |
|
0..1 | Period |
|
|
| 0..1 | Reference ( Account ) | Reference to a parent Account | |
Documentation
for
this
format
|
||||
XML Template
<<Account xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> <<identifier><!-- 0..* Identifier Account number --></identifier> <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error | on-hold | unknown --> <type><!-- 0..1 CodeableConcept E.g. patient, expense, depreciation --></type>< <|<name value="[string]"/><!-- 0..1 Human-readable label --> <subject><!-- 0..* Reference(Patient|Device|Practitioner|Location| HealthcareService|Organization) What is account tied to? --></subject><</period> <<a href="account-definitions.html#Account.active" title="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." class="dict"></active> <</balance><servicePeriod><!-- 0..1 Period Transaction window --></servicePeriod> <coverage> <!-- 0..* The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account --><<a href="account-definitions.html#Account.coverage.coverage" title="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." class="dict"></coverage> < 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." class="dict">coverage><!-- 1..1 Reference(Coverage) The party(s), such as insurances, that may contribute to the payment of this account --></coverage> <priority value="[positiveInt]"/><!-- 0..1 The priority of the coverage in the context of this account --> </coverage> <owner><!-- 0..1 Reference(Organization) Who is responsible? --></owner><<description value="[string]"/><!-- 0..1 Explanation of purpose/use --> <guarantor> <!-- 0..* Responsible for the account --> <party><!-- 1..1 Reference(Patient|RelatedPerson|Organization) Responsible entity --></party>< <</period><onHold value="[boolean]"/><!-- 0..1 Credit or other hold applied --> <period><!-- 0..1 Period Guarantee account during --></period> </guarantor> <partOf><!-- 0..1 Reference(Account) Reference to a parent Account --></partOf> </Account>
JSON Template
{
"resourceType" : "",
"resourceType" : "Account",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"|
"
"<a href="account-definitions.html#Account.active" title="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." class="dict">active
"
"
"<a href="account-definitions.html#Account.coverage.coverage" title="The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay).
"identifier" : [{ Identifier }], // Account number
"status" : "<code>", // R! active | inactive | entered-in-error | on-hold | unknown
"type" : { CodeableConcept }, // E.g. patient, expense, depreciation
"name" : "<string>", // Human-readable label
"subject" : [{ Reference(Patient|Device|Practitioner|Location|
HealthcareService|Organization) }], // What is account tied to?
"servicePeriod" : { Period }, // Transaction window
"coverage" : [{ // The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
"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." class="dict">coverage
"
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." class="dict">coverage" : { Reference(Coverage) }, // R! The party(s), such as insurances, that may contribute to the payment of this account
"priority" : "<positiveInt>" // The priority of the coverage in the context of this account
}],
"
"
"
"
"
"
}]
"owner" : { Reference(Organization) }, // Who is responsible?
"description" : "<string>", // Explanation of purpose/use
"guarantor" : [{ // Responsible for the account
"party" : { Reference(Patient|RelatedPerson|Organization) }, // R! Responsible entity
"onHold" : <boolean>, // Credit or other hold applied
"period" : { Period } // Guarantee account during
}],
"partOf" : { Reference(Account) } // Reference to a parent Account
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ 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: fhir:fhir:Account.identifier [ Identifier ], ... ; # 0..* Account number fhir:Account.status [ code ]; # 1..1 active | inactive | entered-in-error | on-hold | unknown fhir:Account.type [ CodeableConcept ]; # 0..1 E.g. patient, expense, depreciation fhir:Account.name [ string ]; # 0..1 Human-readable labelfhir: fhir: fhir:<a href="account-definitions.html#Account.active" title="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." class="dict">Account.active fhir:fhir:Account.subject [ Reference(Patient|Device|Practitioner|Location|HealthcareService|Organization) ], ... ; # 0..* What is account tied to? fhir:Account.servicePeriod [ Period ]; # 0..1 Transaction window fhir:Account.coverage [ # 0..* The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the accountfhir:<a href="account-definitions.html#Account.coverage.coverage" title="The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay).fhir: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." class="dict">Account.coverage.coverage 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." class="dict">Account.coverage.coverage [ Reference(Coverage) ]; # 1..1 The party(s), such as insurances, that may contribute to the payment of this account fhir:Account.coverage.priority [ positiveInt ]; # 0..1 The priority of the coverage in the context of this account ], ...; fhir:Account.owner [ Reference(Organization) ]; # 0..1 Who is responsible? fhir:Account.description [ string ]; # 0..1 Explanation of purpose/use fhir:Account.guarantor [ # 0..* Responsible for the account fhir:Account.guarantor.party [ Reference(Patient|RelatedPerson|Organization) ]; # 1..1 Responsible entity fhir:Account.guarantor.onHold [ boolean ]; # 0..1 Credit or other hold appliedfhir:fhir:Account.guarantor.period [ Period ]; # 0..1 Guarantee account during ], ...; fhir:Account.partOf [ Reference(Account) ]; # 0..1 Reference to a parent Account ]
Changes
since
DSTU2
Release
3
| Account |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See
R2
<-->
R3
<-->
R4
Conversion
Maps
(status
=
1
test
that
all
execute
ok.
All
2
tests
pass
round-trip
testing
and
all
r3
resources
are
valid.).
of
which
2
fail
to
execute
.)
Alternate
See
the
Profiles
&
Extensions
and
the
alternate
definitions:
Master
Definition
(
XML
,
+
JSON
),
,
XML
Schema
/
Schematron
(for
)
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
&
the
dependency
analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| Account.status | Indicates whether the account is available to be used. | Required | AccountStatus |
| Account.type | The usage type of this account, permits categorization of accounts. | Example |
|
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
|
|
token | Account number | Account.identifier | |
| name | string | Human-readable label | Account.name | |
| owner | reference | Who is responsible? |
( Organization ) |
|
| patient | reference | What is account tied to? |
( Patient ) |
|
| period | date | Transaction window |
|
|
| status | token | active | inactive | entered-in-error | on-hold | unknown | Account.status | |
| subject | reference | What is account tied to? |
Account.subject
( Practitioner , Organization , Device , Patient , HealthcareService , Location ) |
|
| type | token | E.g. patient, expense, depreciation | Account.type |