Account - FHIR Resource (r4)


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

Validate an Account FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
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# The parties ultimately responsible for balancing the Account
identifiertrueIdentifier# Account number
namefalsestring# Human-readable label
ownerfalseReference# Entity managing the Account
partOffalseReference# Reference to a parent Account
servicePeriodfalsePeriod# Transaction window
statusfalsecode# active | inactive | entered-in-error | on-hold | unknown
subjecttrueReference# "subject" : [{ Reference(Patient|Device|Practitioner|PractitionerRole|
typefalseCodeableConcept# E.g. patient, expense, depreciation

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 ParameterField TypeResource Fields Searched
identifiertextidentifier
nametextname
ownerreferenceowner
patientreferencesubject.where
perioddateservicePeriod
statustextstatus
subjectreferencesubject
typetexttype