GET fhir/v1/{clientId}/{vendor}/{vendorversion}/account/{id}

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.

Request Information

URI Parameters

Name	Type	Additional information
clientId	string	Required
vendor	EHRVendor	Required
vendorversion	string	Required
id	string	Required

Body Parameters

None.

Response Information

Resource Description

Account

None.

Response Formats

application/json, text/json

Sample:

{
  "resourceType" : "Account",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Account number
  "status" : "<code>", // active | inactive | entered-in-error
  "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?
  "period" : { Period }, // Transaction window
  "active" : { Period }, // Time window that transactions may be posted to this account
  "balance" : { Money }, // How much is in account?
  "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) that are responsible for covering 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 } // Guarrantee account during
  }]
}

application/xml, text/xml

Sample:

<Account xmlns="http://hl7.org/fhir">
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Account number --></identifier>
 <status value="[code]"/><!-- 0..1 active | inactive | entered-in-error -->
 <type><!-- 0..1 CodeableConcept E.g. patient, expense, depreciation --></type>
 <name value="[string]"/><!-- 0..1 Human-readable label -->
 <subject><!-- 0..1 Reference(Patient|Device|Practitioner|Location|
   HealthcareService|Organization) What is account tied to? --></subject>
 <period><!-- 0..1 Period Transaction window --></period>
 <active><!-- 0..1 Period Time window that transactions may be posted to this account --></active>
 <balance><!-- 0..1 Money How much is in account? --></balance>
 <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 -->
  <coverage><!-- 1..1 Reference(Coverage) The party(s) that are responsible for covering 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>
  <onHold value="[boolean]"/><!-- 0..1 Credit or other hold applied -->
  <period><!-- 0..1 Period Guarrantee account during --></period>
 </guarantor>
</Account>