Account - FHIR Resource (stu3)


This Account Resource uses the FHIR API standard for access and structure.

Validate an Account FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
activefalsePeriod# Time window that transactions may be posted to this account
balancefalseMoney# How much is in account?
coveragetrueData Type# The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
descriptionfalsestring# Explanation of purpose/use
guarantortrueData Type# Responsible for the account
identifiertrueIdentifier# Account number
namefalsestring# Human-readable label
ownerfalseReference# Who is responsible?
periodfalsePeriod# Transaction window
statusfalsecode# active | inactive | entered-in-error
subjectfalseReference# "subject" : { Reference(Patient|Device|Practitioner|Location|
typefalseCodeableConcept# E.g. patient, expense, depreciation

Account Example

{
  "status": "active",
  "balance": {
    "code": "USD",
    "unit": "USD",
    "value": -1200,
    "system": "urn:iso:std:iso:4217"
  },
  "name": "HACC Funded Billing for Peter James Chalmers",
  "resourceType": "Account",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">HACC Funded Billing for Peter James Chalmers</div>"
  },
  "description": "Hospital charges",
  "period": {
    "start": "2016-01-01",
    "end": "2016-06-30"
  },
  "owner": {
    "reference": "Organization/hl7"
  },
  "coverage": [
    {
      "priority": 1,
      "coverage": {
        "reference": "Coverage/7546D"
      }
    }
  ],
  "active": {
    "start": "2016-01-01",
    "end": "2016-06-30"
  },
  "identifier": [
    {
      "system": "urn:oid:0.1.2.3.4.5.6.7",
      "value": "654321"
    }
  ],
  "type": {
    "text": "patient",
    "coding": [
      {
        "code": "PBILLACCT",
        "system": "http://hl7.org/fhir/v3/ActCode",
        "display": "patient billing account"
      }
    ]
  },
  "id": "example",
  "subject": {
    "display": "Peter James Chalmers",
    "reference": "Patient/example"
  }
}

Account Structure


  
{
  "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
  }]
}


 

Account Search Parameters

The following search parameters can be used to query Account resources. Just submit the like so:

https://api.1up.health/fhir/stu3/Account?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
balancequantitybalance
identifiertextidentifier
nametextname
ownerreferenceowner
patientreferencesubject
perioddateperiod
statustextstatus
subjectreferencesubject
typetexttype