Data Model Libraries
    Preparing search index...

    Class Account

    Account Class

    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.

    FHIR Specification

    • Short: Tracks balance, charges, for patient or cost center
    • Definition: 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.
    • FHIR Version: 5.0.0

    FHIR Account

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? accountStatusEnum status billingStatus? type_? name? subject? servicePeriod? coverage? owner? description? guarantor? diagnosis? procedure? relatedAccount? currency? balance? calculatedAt?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getBillingStatus setBillingStatus hasBillingStatus getType setType hasType getNameElement setNameElement hasNameElement getName setName hasName getSubject setSubject addSubject hasSubject getServicePeriod setServicePeriod hasServicePeriod getCoverage setCoverage addCoverage hasCoverage getOwner setOwner hasOwner getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getGuarantor setGuarantor addGuarantor hasGuarantor getDiagnosis setDiagnosis addDiagnosis hasDiagnosis getProcedure setProcedure addProcedure hasProcedure getRelatedAccount setRelatedAccount addRelatedAccount hasRelatedAccount getCurrency setCurrency hasCurrency getBalance setBalance addBalance hasBalance getCalculatedAtElement setCalculatedAtElement hasCalculatedAtElement getCalculatedAt setCalculatedAt hasCalculatedAt fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initSubject initCoverage initGuarantor initDiagnosis initProcedure initRelatedAccount initBalance

    Constructors

    Properties

    identifier?: Identifier[]

    Account.identifier Element

    FHIR Specification

    • Short: Account number
    • Definition: Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    accountStatusEnum: AccountStatusEnum

    FHIR CodeSystem: AccountStatus

    AccountStatusEnum

    status: null | EnumCodeType

    Account.status Element

    FHIR Specification

    • Short: active | inactive | entered-in-error | on-hold | unknown
    • Definition: Indicates whether the account is presently used/usable or not.
    • Comment: This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the Account as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: AccountStatusEnum

    billingStatus?: CodeableConcept

    Account.billingStatus Element

    FHIR Specification

    • Short: Tracks the lifecycle of the account through the billing process
    • Definition: The BillingStatus tracks the lifecycle of the account through the billing process. It indicates how transactions are treated when they are allocated to the account.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Private Optionaltype_

    type_?: CodeableConcept

    Account.type Element

    FHIR Specification

    • Short: E.g. patient, expense, depreciation
    • Definition: Categorizes the account for reporting and searching purposes.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    Account.name Element

    FHIR Specification

    • Short: Human-readable label
    • Definition: Name used for the account when displaying it to humans in reports, etc.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    subject?: Reference[]

    Account.subject Element

    FHIR Specification

    servicePeriod?: Period

    Account.servicePeriod Element

    FHIR Specification

    • Short: Transaction window
    • Definition: The date range of services associated with this account.
    • Comment: It is possible for transactions to be posted outside the service period, as long as the service was provided within the defined service period.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    coverage?: AccountCoverageComponent[]

    Account.coverage Element

    FHIR Specification

    • Short: The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
    • Definition: The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.
    • Comment: Typically. this may be some form of insurance, internal charges, or self-pay. Local or jurisdictional business rules may determine which coverage covers which types of billable items charged to the account, and in which order. Where the order is important, a local/jurisdictional extension may be defined to specify the order for the type of charge.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    owner?: Reference

    Account.owner Element

    FHIR Specification

    • Short: Entity managing the Account
    • Definition: Indicates the service area, hospital, department, etc. with responsibility for managing the Account.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    Account.description Element

    FHIR Specification

    • Short: Explanation of purpose/use
    • Definition: Provides additional information about what the account tracks and how it is used.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    guarantor?: AccountGuarantorComponent[]

    Account.guarantor Element

    FHIR Specification

    • Short: The parties ultimately responsible for balancing the Account
    • Definition: The parties responsible for balancing the account if other payment options fall short.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    diagnosis?: AccountDiagnosisComponent[]

    Account.diagnosis Element

    FHIR Specification

    • Short: The list of diagnoses relevant to this account
    • Definition: When using an account for billing a specific Encounter the set of diagnoses that are relevant for billing are stored here on the account where they are able to be sequenced appropriately prior to processing to produce claim(s).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    procedure?: AccountProcedureComponent[]

    Account.procedure Element

    FHIR Specification

    • Short: The list of procedures relevant to this account
    • Definition: When using an account for billing a specific Encounter the set of procedures that are relevant for billing are stored here on the account where they are able to be sequenced appropriately prior to processing to produce claim(s).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    relatedAccount?: AccountRelatedAccountComponent[]

    Account.relatedAccount Element

    FHIR Specification

    • Short: Other associated accounts related to this account
    • Definition: Other associated accounts related to this account.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    currency?: CodeableConcept

    Account.currency Element

    FHIR Specification

    • Short: The base or default currency
    • Definition: The default currency for the account.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    balance?: AccountBalanceComponent[]

    Account.balance Element

    FHIR Specification

    • Short: Calculated account balance(s)
    • Definition: The calculated account balances - these are calculated and processed by the finance system. The balances with a term that is not current are usually generated/updated by an invoicing or similar process.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    calculatedAt?: InstantType

    Account.calculatedAt Element

    FHIR Specification

    • Short: Time the balance amount was calculated
    • Definition: Time the balance amount was calculated.
    • Comment: The total(s) are not typically updated using the restful API but more often by back-end processes included in a typical finance system.
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided Account JSON to instantiate the Account data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Account

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Account

      Returns undefined | Account

      Account data model or undefined for Account

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the subject property.

      Parameters

      • value: undefined | Reference[]

        the subject array value

      Returns this

      this

      @ReferenceTargets('Account.subject', ['Patient','Device','Practitioner','PractitionerRole','Location','HealthcareService','Organization',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the subject array property.

      Parameters

      • value: undefined | Reference

        the subject value

      Returns this

      this

      @ReferenceTargets('Account.subject', ['Patient','Device','Practitioner','PractitionerRole','Location','HealthcareService','Organization',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetBillingStatussetBillingStatushasBillingStatusgetTypesetTypehasTypegetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetSubjectsetSubjectaddSubjecthasSubjectgetServicePeriodsetServicePeriodhasServicePeriodgetCoveragesetCoverageaddCoveragehasCoveragegetOwnersetOwnerhasOwnergetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetGuarantorsetGuarantoraddGuarantorhasGuarantorgetDiagnosissetDiagnosisaddDiagnosishasDiagnosisgetProceduresetProcedureaddProcedurehasProceduregetRelatedAccountsetRelatedAccountaddRelatedAccounthasRelatedAccountgetCurrencysetCurrencyhasCurrencygetBalancesetBalanceaddBalancehasBalancegetCalculatedAtElementsetCalculatedAtElementhasCalculatedAtElementgetCalculatedAtsetCalculatedAthasCalculatedAtfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitSubjectinitCoverageinitGuarantorinitDiagnosisinitProcedureinitRelatedAccountinitBalance