Account
Overview
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. The account resource supports multiple account types and relationships to other accounts.
Account Relationships
Account Types
The account resource supports multiple account types which are defined below.
-
charge-group
- A grouping of charges for billing -
financial-account
- Top level patient account -
guarantor-balance
- Self pay balance account -
insurance-balance
- Insurance balance account -
statement
- Snapshot in time of a patient statement
The following fields are returned if valued:
- Account id
- Account Identifier
- Status
- Type
- Subject
- Service period
- Owner
- Guarantor
- Part of
- Extensions including related parts, balance, and state
Terminology Bindings
Account.identifier |
|
Account.type |
|
Account.extension[x].valueMoney.currency |
|
Account.extension[x].valueCodeableConcept |
|
Extensions
Custom Extensions
All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}
ID | Value[x] Type | Description |
---|---|---|
account-related-parts |
Reference |
A reference to other related Accounts. |
account-balance |
Money |
Represents the account balance. |
account-state |
CodeableConcept |
The status of the Account within the billing or correspondence workflow. |
Search
Search for Accounts that meet supplied query parameters:
GET /Account?:parameters
Implementation Notes
- The Account Balance extension is only returned on statement, guarantor-balance, and insurance-benefit types
- Account.subject is only returned on statement and financial-account types
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
See notes | token |
The logical resource id associated with the resource. Example: F703726
|
identifier |
See notes | token |
Aliases of the Account like Statement Number. Example: https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/statement-number|500000078
|
type |
See notes | token |
The specific type of account. Example: financial-account
|
patient |
See notes | reference |
The entity that caused the expenses. Example: Patient/12345
|
-guarantor |
See notes | reference |
The parties responsible for balancing the account. Example: 6330015-6330017
|
_count |
no | number |
The maximum number of results to return. Defaults to 10 . |
Notes:
- You may search via:
-
_id
alone -
patient
,identifier
, andtype
set to ‘statement’ -
-guarantor
andtype
set to ‘financial-account’
-
- When searching via
identifier
, the system must be ‘https://fhir.cerner.com/<EHR source id>/statement-number’. You may not search viaidentifier
with a system of ‘https://fhir.cerner.com/<EHR source id>/account-number’. - The
-guarantor
search parameter should contain a reference to a RelatedPerson when set.
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request - _id
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account?_id=F703726
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "4d239408-a451-436e-a55a-f7e5427f62f6",
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account?_id=F703726"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account/F703726",
"resource": {
"resourceType": "Account",
"id": "F703726",
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Account</b></p><p><b>Account Type</b>: financial-account</p><p><b>Service Period Start Date</b>: Sep 27, 2013 4:12 P.M. UTC</p><p><b>Account Number</b>: 10000381</p></div>"
},
"identifier": [
{
"use": "usual",
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/account-number",
"value": "10000381"
}
],
"status": "active",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "ACCTRECEIVABLE",
"display": "account receivable"
}
],
"text": "financial-account"
},
"subject": [
{
"reference": "Patient/1914010"
}
],
"servicePeriod": {
"start": "2013-09-27T16:12:15Z"
},
"owner": {
"reference": "Organization/647851"
}
}
}
]
}
Request - patient
, identifier
, and type
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account?identifier=https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/statement-number|68002&patient=6330017&type=statement
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "43d52c34-385f-4871-889d-f974b2422fab",
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account?patient=6330017&identifier=https%3A%2F%2Ffhir.cerner.com%2Fec2458f2-1e24-41c8-b71b-0e701af7583d%2FcodeSet%2F28200%7C68002&type=statement"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account/S2580833",
"resource": {
"resourceType": "Account",
"id": "S2580833",
"text": {
"status": "generated",
"div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Account</b></p><p><b>Account Type</b>: statement</p><p><b>Service Period Start Date</b>: Aug 13, 2019 3:01 P.M. UTC</p><p><b>Statement Number</b>: 68002</p><p><b>Guarantor</b>: 6330015-6330017</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/account-balance",
"valueMoney": {
"value": "2000.00",
"currency": "USD"
}
},
{
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/account-state",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4002640",
"code": "20752989",
"display": "Pending",
"userSelected": true
}
],
"text": "Pending"
}
},
{
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/account-related-parts",
"valueReference": {
"reference": "Account/G2572738"
}
}
],
"identifier": [
{
"use": "usual",
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/statement-number",
"value": "68002"
}
],
"status": "active",
"type": {
"text": "statement"
},
"subject": [
{
"reference": "Patient/6330017"
}
],
"servicePeriod": {
"start": "2019-08-13T15:01:17Z"
},
"owner": {
"reference": "Organization/1259855"
},
"guarantor": [
{
"party": {
"reference": "RelatedPerson/6330015-6330017"
}
}
]
}
}
]
}
Request - -guarantor
and type
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account?-guarantor=6330015-6330015&type=financial-account
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "0b8ec3aa-805f-486c-8fb6-61a252d0a8cb",
"type": "searchset",
"total": 3,
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account?-guarantor=6330015-6330015&type=financial-account"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account/F1127724",
"resource": {
"resourceType": "Account",
"id": "F1127724",
"text": {
"status": "generated",
"div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Account</b></p><p><b>Account Type</b>: financial-account</p><p><b>Service Period Start Date</b>: Aug 2, 2019 7:14 P.M. UTC</p><p><b>Account Number</b>: 344</p><p><b>Guarantor</b>: 6330014-6330015</p><p><b>Guarantor</b>: 6330015-6330015</p></div>"
},
"identifier": [
{
"use": "usual",
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/account-number",
"value": "344"
}
],
"status": "active",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "ACCTRECEIVABLE",
"display": "account receivable"
}
],
"text": "financial-account"
},
"subject": [
{
"reference": "Patient/6330015"
}
],
"servicePeriod": {
"start": "2019-08-02T19:14:17Z"
},
"owner": {
"reference": "Organization/1259855"
},
"guarantor": [
{
"party": {
"reference": "RelatedPerson/6330014-6330015"
},
"period": {
"start": "2019-08-02T05:00:00Z"
}
},
{
"party": {
"reference": "RelatedPerson/6330015-6330015"
},
"period": {
"start": "2019-08-02T05:00:00Z"
}
}
]
}
},
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account/F1131724",
"resource": {
"resourceType": "Account",
"id": "F1131724",
"text": {
"status": "generated",
"div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Account</b></p><p><b>Account Type</b>: financial-account</p><p><b>Service Period Start Date</b>: Aug 12, 2019 10:29 P.M. UTC</p><p><b>Account Number</b>: 343</p><p><b>Guarantor</b>: 6330015-6330017</p></div>"
},
"identifier": [
{
"use": "usual",
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/account-number",
"value": "343"
}
],
"status": "active",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "ACCTRECEIVABLE",
"display": "account receivable"
}
],
"text": "financial-account"
},
"subject": [
{
"reference": "Patient/6330017"
}
],
"servicePeriod": {
"start": "2019-08-12T22:29:39Z"
},
"owner": {
"reference": "Organization/1259855"
},
"guarantor": [
{
"party": {
"reference": "RelatedPerson/6330015-6330017"
},
"period": {
"start": "2019-08-02T05:00:00Z"
}
}
]
}
},
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account/F1131725",
"resource": {
"resourceType": "Account",
"id": "F1131725",
"text": {
"status": "generated",
"div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Account</b></p><p><b>Account Type</b>: financial-account</p><p><b>Service Period Start Date</b>: Aug 12, 2019 10:59 P.M. UTC</p><p><b>Account Number</b>: 347</p><p><b>Guarantor</b>: 6330014-6330016</p><p><b>Guarantor</b>: 6330015-6330016</p></div>"
},
"identifier": [
{
"use": "usual",
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/account-number",
"value": "347"
}
],
"status": "active",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "ACCTRECEIVABLE",
"display": "account receivable"
}
],
"text": "financial-account"
},
"subject": [
{
"reference": "Patient/6330016"
}
],
"servicePeriod": {
"start": "2019-08-12T22:59:16Z"
},
"owner": {
"reference": "Organization/1259855"
},
"guarantor": [
{
"party": {
"reference": "RelatedPerson/6330014-6330016"
},
"period": {
"start": "2019-08-02T05:00:00Z"
}
},
{
"party": {
"reference": "RelatedPerson/6330015-6330016"
},
"period": {
"start": "2019-08-02T05:00:00Z"
}
}
]
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Retrieve by id
List an individual Account by its id:
GET /Account/:id
Authorization Types
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Account/G2572738
Response
Status: 200 OK
{
"resourceType": "Account",
"id": "G2572738",
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Account</b></p><p><b>Account Type</b>: guarantor-balance</p><p><b>Service Period Start Date</b>: Aug 5, 2019 5:00 A.M. UTC</p><p><b>Service Period End Date</b>: Aug 6, 2019 4:59 A.M. UTC</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/account-balance",
"valueMoney": {
"value": "1250.00",
"currency": "USD"
}
},
{
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/account-state",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/24451",
"code": "629234",
"display": "Ready to bill",
"userSelected": true
}
],
"text": "Ready to bill"
}
}
],
"status": "active",
"type": {
"text": "guarantor-balance"
},
"servicePeriod": {
"start": "2019-08-05T05:00:00Z",
"end": "2019-08-06T04:59:59Z"
},
"partOf": {
"reference": "Account/F1131724"
}
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.