Account - FHIR Resource (r4)
This Account Resource uses the FHIR API standard for access and structure.
Validate an Account FHIR Resource (r4)
Account Attributes
AttributeField is listTypeDescription
Description: Account number
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "urn:oid:0.1.2.3.4.5.6.7",
"value": "654321"
}
]Learn more about the (Account) identifier FHIR attribute
Description: active | inactive | entered-in-error | on-hold | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (Account) status FHIR attribute
Description: E.g. patient, expense, depreciation
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "PBILLACCT",
"display": "patient billing account"
}
],
"text": "patient"
}Learn more about the (Account) type FHIR attribute
Description: Human-readable label
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": "HACC Funded Billing for Peter James Chalmers"Learn more about the (Account) name FHIR attribute
Description: "subject" : [{ Reference(Patient|Device|Practitioner|PractitionerRole|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": [
{
"reference": "Patient/example",
"display": "Peter James Chalmers"
}
]Learn more about the (Account) subject FHIR attribute
Description: Transaction window
FHIR Version: r4
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"servicePeriod": {
"start": "2016-01-01",
"end": "2016-06-30"
}Learn more about the (Account) servicePeriod FHIR attribute
Description: The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"coverage": [
{
"coverage": {
"reference": "Coverage/7546D"
},
"priority": 1
}
]Learn more about the (Account) coverage FHIR attribute
Description: Entity managing the Account
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"owner": {
"reference": "Organization/hl7"
}Learn more about the (Account) owner FHIR attribute
Description: Explanation of purpose/use
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "Hospital charges"Learn more about the (Account) description FHIR attribute
Description: The parties ultimately responsible for balancing the Account
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"guarantor": Learn more about the (Account) guarantor FHIR attribute
Description: Reference to a parent Account
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"partOf": Learn more about the (Account) partOf FHIR attribute
Account Example
{
"resourceType": "Account",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">HACC Funded Billing for Peter James Chalmers</div>"
},
"identifier": [
{
"system": "urn:oid:0.1.2.3.4.5.6.7",
"value": "654321"
}
],
"status": "active",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "PBILLACCT",
"display": "patient billing account"
}
],
"text": "patient"
},
"name": "HACC Funded Billing for Peter James Chalmers",
"subject": [
{
"reference": "Patient/example",
"display": "Peter James Chalmers"
}
],
"servicePeriod": {
"start": "2016-01-01",
"end": "2016-06-30"
},
"coverage": [
{
"coverage": {
"reference": "Coverage/7546D"
},
"priority": 1
}
],
"owner": {
"reference": "Organization/hl7"
},
"description": "Hospital charges"
}Account Structure
{
"resourceType" : "Account",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"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|PractitionerRole|
Location|HealthcareService|Organization) }], // The entity that caused the expenses
"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
"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) }, // Entity managing the Account
"description" : "<string>", // Explanation of purpose/use
"guarantor" : [{ // The parties ultimately responsible for balancing 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
}
Account Search Parameters
The following search parameters can be used to query Account resources. Just submit them like so:
https://api.1up.health/fhir/r4/Account?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
identifier | text | identifier |
name | text | name |
owner | reference | owner |
patient | reference | subject.where |
period | date | servicePeriod |
status | text | status |
subject | reference | subject |
type | text | type |
