STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

8.8 Resource Account - Content

Patient Administration Work GroupMaturity Level: 0Compartments: Device, Patient, Practitioner

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.

8.8.1 Scope and Usage

Todo

This resource is referenced by Encounter and EpisodeOfCare

8.8.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Account ΣDomainResourceTracks balance, charges, for patient or cost center
... identifier Σ0..*IdentifierAccount number
... name Σ0..1stringHuman-readable label
... type Σ0..1CodeableConceptE.g. patient, expense, depreciation
... status ?!Σ0..1codeactive | inactive | entered-in-error
AccountStatus (Required)
... active Σ0..1PeriodTime window that transactions may be posted to this account
... currency Σ0..1CodingBase currency in which balance is tracked
AccountCurrency (Example)
... balance Σ0..1MoneyHow much is in account?
... coverage Σ0..*Reference(Coverage)The party(s) that are responsible for covering the payment of this account
... coveragePeriod Σ0..1PeriodTransaction window
... subject Σ0..1Reference(Patient | Device | Practitioner | Location | HealthcareService | Organization)What is account tied to?
... owner Σ0..1Reference(Organization)Who is responsible?
... description Σ0..1stringExplanation of purpose/use
... guarantor Σ0..*BackboneElementResponsible for the account
.... party Σ1..1Reference(Patient | RelatedPerson | Organization)Responsible entity
.... onHold Σ0..1booleanCredit or other hold applied
.... period Σ0..1PeriodGuarrantee account during

doco Documentation for this format

UML Diagram (Legend)

Account (DomainResource)Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number)identifier : Identifier [0..*]Name used for the account when displaying it to humans in reports, etcname : string [0..1]Categorizes the account for reporting and searching purposestype : CodeableConcept [0..1]Indicates whether the account is presently used/useable or not (this element modifies the meaning of other elements)status : code [0..1] « Indicates whether the account is available to be used. (Strength=Required)AccountStatus! »Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occuractive : Period [0..1]Identifies the currency to which transactions must be converted when crediting or debiting the accountcurrency : Coding [0..1] « The monetary currency in which this account records values. (Strength=Example)AccountCurrency?? »Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negativebalance : Money [0..1]The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay). A coverage may only be resposible for specific types of charges, and the sequence of the coverages in the account could be important when processing billingcoverage : Reference [0..*] « Coverage »Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etccoveragePeriod : Period [0..1]Identifies the patient, device, practitioner, location or other object the account is associated withsubject : Reference [0..1] « Patient|Device|Practitioner|Location| HealthcareService|Organization »Indicates the organization, department, etc. with responsibility for the accountowner : Reference [0..1] « Organization »Provides additional information about what the account tracks and how it is useddescription : string [0..1]GuarantorThe entity who is responsibleparty : Reference [1..1] « Patient|RelatedPerson|Organization »A guarantor may be placed on credit hold or otherwise have their role temporarily suspendedonHold : boolean [0..1]The timeframe during which the guarantor accepts responsibility for the accountperiod : Period [0..1]Parties financially responsible for the accountguarantor[0..*]

XML Template

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Account;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Account.identifier [ Identifier ], ... ; # 0..* Account number
  fhir:Account.name [ string ]; # 0..1 Human-readable label
  fhir:Account.type [ CodeableConcept ]; # 0..1 E.g. patient, expense, depreciation
  fhir:Account.status [ code ]; # 0..1 active | inactive | entered-in-error
  fhir:Account.active [ Period ]; # 0..1 Time window that transactions may be posted to this account
  fhir:Account.currency [ Coding ]; # 0..1 Base currency in which balance is tracked
  fhir:Account.balance [ Money ]; # 0..1 How much is in account?
  fhir:Account.coverage [ Reference(Coverage) ], ... ; # 0..* The party(s) that are responsible for covering the payment of this account
  fhir:Account.coveragePeriod [ Period ]; # 0..1 Transaction window
  fhir:Account.subject [ Reference(Patient|Device|Practitioner|Location|HealthcareService|Organization) ]; # 0..1 What is account tied to?
  fhir:Account.owner [ Reference(Organization) ]; # 0..1 Who is responsible?
  fhir:Account.description [ string ]; # 0..1 Explanation of purpose/use
  fhir:Account.guarantor [ # 0..* Responsible for the account
    fhir:Account.guarantor.party [ Reference(Patient|RelatedPerson|Organization) ]; # 1..1 Responsible entity
    fhir:Account.guarantor.onHold [ boolean ]; # 0..1 Credit or other hold applied
    fhir:Account.guarantor.period [ Period ]; # 0..1 Guarrantee account during
  ], ...;
]

Changes since DSTU2

Account
Account.status Add Binding http://hl7.org/fhir/ValueSet/account-status (required)
Account.active Renamed from activePeriod to active
Account.balance Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money
Account.coverage added Element
Account.guarantor added Element
Account.guarantor.party added Element
Account.guarantor.onHold added Element
Account.guarantor.period added Element

See the Full Difference for further information

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Account ΣDomainResourceTracks balance, charges, for patient or cost center
... identifier Σ0..*IdentifierAccount number
... name Σ0..1stringHuman-readable label
... type Σ0..1CodeableConceptE.g. patient, expense, depreciation
... status ?!Σ0..1codeactive | inactive | entered-in-error
AccountStatus (Required)
... active Σ0..1PeriodTime window that transactions may be posted to this account
... currency Σ0..1CodingBase currency in which balance is tracked
AccountCurrency (Example)
... balance Σ0..1MoneyHow much is in account?
... coverage Σ0..*Reference(Coverage)The party(s) that are responsible for covering the payment of this account
... coveragePeriod Σ0..1PeriodTransaction window
... subject Σ0..1Reference(Patient | Device | Practitioner | Location | HealthcareService | Organization)What is account tied to?
... owner Σ0..1Reference(Organization)Who is responsible?
... description Σ0..1stringExplanation of purpose/use
... guarantor Σ0..*BackboneElementResponsible for the account
.... party Σ1..1Reference(Patient | RelatedPerson | Organization)Responsible entity
.... onHold Σ0..1booleanCredit or other hold applied
.... period Σ0..1PeriodGuarrantee account during

doco Documentation for this format

UML Diagram (Legend)

Account (DomainResource)Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number)identifier : Identifier [0..*]Name used for the account when displaying it to humans in reports, etcname : string [0..1]Categorizes the account for reporting and searching purposestype : CodeableConcept [0..1]Indicates whether the account is presently used/useable or not (this element modifies the meaning of other elements)status : code [0..1] « Indicates whether the account is available to be used. (Strength=Required)AccountStatus! »Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occuractive : Period [0..1]Identifies the currency to which transactions must be converted when crediting or debiting the accountcurrency : Coding [0..1] « The monetary currency in which this account records values. (Strength=Example)AccountCurrency?? »Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negativebalance : Money [0..1]The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay). A coverage may only be resposible for specific types of charges, and the sequence of the coverages in the account could be important when processing billingcoverage : Reference [0..*] « Coverage »Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etccoveragePeriod : Period [0..1]Identifies the patient, device, practitioner, location or other object the account is associated withsubject : Reference [0..1] « Patient|Device|Practitioner|Location| HealthcareService|Organization »Indicates the organization, department, etc. with responsibility for the accountowner : Reference [0..1] « Organization »Provides additional information about what the account tracks and how it is useddescription : string [0..1]GuarantorThe entity who is responsibleparty : Reference [1..1] « Patient|RelatedPerson|Organization »A guarantor may be placed on credit hold or otherwise have their role temporarily suspendedonHold : boolean [0..1]The timeframe during which the guarantor accepts responsibility for the accountperiod : Period [0..1]Parties financially responsible for the accountguarantor[0..*]

XML Template

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Account;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Account.identifier [ Identifier ], ... ; # 0..* Account number
  fhir:Account.name [ string ]; # 0..1 Human-readable label
  fhir:Account.type [ CodeableConcept ]; # 0..1 E.g. patient, expense, depreciation
  fhir:Account.status [ code ]; # 0..1 active | inactive | entered-in-error
  fhir:Account.active [ Period ]; # 0..1 Time window that transactions may be posted to this account
  fhir:Account.currency [ Coding ]; # 0..1 Base currency in which balance is tracked
  fhir:Account.balance [ Money ]; # 0..1 How much is in account?
  fhir:Account.coverage [ Reference(Coverage) ], ... ; # 0..* The party(s) that are responsible for covering the payment of this account
  fhir:Account.coveragePeriod [ Period ]; # 0..1 Transaction window
  fhir:Account.subject [ Reference(Patient|Device|Practitioner|Location|HealthcareService|Organization) ]; # 0..1 What is account tied to?
  fhir:Account.owner [ Reference(Organization) ]; # 0..1 Who is responsible?
  fhir:Account.description [ string ]; # 0..1 Explanation of purpose/use
  fhir:Account.guarantor [ # 0..* Responsible for the account
    fhir:Account.guarantor.party [ Reference(Patient|RelatedPerson|Organization) ]; # 1..1 Responsible entity
    fhir:Account.guarantor.onHold [ boolean ]; # 0..1 Credit or other hold applied
    fhir:Account.guarantor.period [ Period ]; # 0..1 Guarrantee account during
  ], ...;
]

Changes since DSTU2

Account
Account.status Add Binding http://hl7.org/fhir/ValueSet/account-status (required)
Account.active Renamed from activePeriod to active
Account.balance Type changed from Quantity{http://hl7.org/fhir/StructureDefinition/Money} to Money
Account.coverage added Element
Account.guarantor added Element
Account.guarantor.party added Element
Account.guarantor.onHold added Element
Account.guarantor.period added Element

See the Full Difference for further information

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),

8.8.2.1 Terminology Bindings

PathDefinitionTypeReference
Account.type The usage type of this account, permits categorization of accounts.UnknownNo details provided yet
Account.status Indicates whether the account is available to be used.RequiredAccountStatus
Account.currency The monetary currency in which this account records values.ExampleCurrency codes - ISO 4217

8.8.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPathsIn Common
balancequantityHow much is in account?Account.balance
identifiertokenAccount numberAccount.identifier
namestringHuman-readable labelAccount.name
ownerreferenceWho is responsible?Account.owner
(Organization)
patientreferenceWhat is account tied to?Account.subject
(Patient)
perioddateTransaction windowAccount.coveragePeriod
statustokenactive | inactive | entered-in-errorAccount.status
subjectreferenceWhat is account tied to?Account.subject
(Practitioner, Organization, Device, Patient, HealthcareService, Location)
typetokenE.g. patient, expense, depreciationAccount.type