Skip to main content

HS.FHIR.DTL.vSTU3.Model.Resource.Account

class HS.FHIR.DTL.vSTU3.Model.Resource.Account extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

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.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = Account;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = Account;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property active as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "active", XMLPROJECTION = "ELEMENT");
Period

Time window that transactions may be posted to this account.

Property methods: activeGet(), activeGetSwizzled(), activeIsValid(), activeNewObject(), activeSet()
property balance as HS.FHIR.DTL.vSTU3.Model.Datatype.Money (XMLNAME = "balance", XMLPROJECTION = "ELEMENT");
Money

How much is in account?

Property methods: balanceGet(), balanceGetSwizzled(), balanceIsValid(), balanceNewObject(), balanceSet()
property coverage as list of HS.FHIR.DTL.vSTU3.Model.Element.Account.coverage (XMLNAME = "coverage", XMLPROJECTION = "ELEMENT");
BackboneElement

The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.

Property methods: coverageBuildValueArray(), coverageCollectionToDisplay(), coverageCollectionToOdbc(), coverageDisplayToCollection(), coverageGet(), coverageGetObject(), coverageGetObjectId(), coverageGetSwizzled(), coverageIsValid(), coverageOdbcToCollection(), coverageSet(), coverageSetObject(), coverageSetObjectId()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

Explanation of purpose/use.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property guarantor as list of HS.FHIR.DTL.vSTU3.Model.Element.Account.guarantor (XMLNAME = "guarantor", XMLPROJECTION = "ELEMENT");
BackboneElement

Responsible for the account.

Property methods: guarantorBuildValueArray(), guarantorCollectionToDisplay(), guarantorCollectionToOdbc(), guarantorDisplayToCollection(), guarantorGet(), guarantorGetObject(), guarantorGetObjectId(), guarantorGetSwizzled(), guarantorIsValid(), guarantorOdbcToCollection(), guarantorSet(), guarantorSetObject(), guarantorSetObjectId()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Account number.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");
string

Human-readable label.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property owner as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "owner", XMLPROJECTION = "ELEMENT");
Reference

Who is responsible?

Organization

Property methods: ownerGet(), ownerGetSwizzled(), ownerIsValid(), ownerNewObject(), ownerSet()
property period as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Period

Transaction window.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");
code

active | inactive | entered-in-error

account-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend account-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
Reference

What is account tied to?

Patient | Device | Practitioner | Location | HealthcareService | Organization

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property type as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

E.g. patient, expense, depreciation.

any FHIR3 code may be used; account-type shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab