Implementation Guide
25.0.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena Account

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition-athena-account-profile.html Version: 25.0.0
Active as of 2022-03-01 Computable Name: AthenaAccount

athena account profile

This Account profile is part of the set of resource profiles supported by the API Server used with the athenaPractice 12.3. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

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

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access Account resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The Account resource is used to track charges for a patient, cost centers, etc. It is derived from PatientVisit, PatientVisitAgg, PatientVisitResource, Guarantor, PatientProfile, DoctorFacility tables in athenaPractice. Specific detail can be found in the Mappings tab in the profile detail page.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Account 0..* Account Account
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... versionId Σ 0..1 id Version specific identifier
ele-1: All FHIR elements must have a @value or children
.... lastUpdated Σ 0..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
ele-1: All FHIR elements must have a @value or children
..... profile:Account Profile Σ 1..1 canonical() Profiles this resource claims to conform to
ele-1: All FHIR elements must have a @value or children

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
.... visitDate 0..1 (Complex) Visit Date
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-visitDate
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-visitDate"
..... value[x] 1..1 dateTime Value of extension
ele-1: All FHIR elements must have a @value or children
.... billStatus 0..1 (Complex) Bill status
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-billStatus
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-billStatus"
..... value[x] 1..1 string Value of extension
ele-1: All FHIR elements must have a @value or children
.... currentCarrier 0..1 (Complex) Current carrier
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-currentCarrier
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-currentCarrier"
..... value[x] 1..1 integer Value of extension
ele-1: All FHIR elements must have a @value or children
.... patientVisitId 0..1 (Complex) Patient Visit Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-patientVisitId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-patientVisitId"
..... value[x] 1..1 integer Value of extension
ele-1: All FHIR elements must have a @value or children
.... doctorId 0..1 (Complex) Doctor Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-doctorId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-doctorId"
..... value[x] 1..1 Reference() Value of extension
ele-1: All FHIR elements must have a @value or children
.... facilityId 0..1 (Complex) Facility Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-facilityId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-facilityId"
..... value[x] 1..1 Reference() Value of extension
ele-1: All FHIR elements must have a @value or children
.... companyId 0..1 (Complex) Company Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-companyId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-companyId"
..... value[x] 1..1 Reference() Value of extension
ele-1: All FHIR elements must have a @value or children
.... extension:Total Balance 0..1 Extension Total Balance
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:Insurance Balance 0..1 Extension Insurance Balance
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:Patient Balance 0..1 Extension Patient Balance
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:Deposit 0..1 Extension Deposit
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... financialClassMid 0..1 (Complex) Financial Class Mid
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-financialClassMid
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-financialClassMid"
..... value[x] 1..1 integer Value of extension
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 0..* Identifier External ids for this item
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code account status
Binding: AccountStatus (required): Indicates whether the account is available to be used.


ele-1: All FHIR elements must have a @value or children
... type Σ 0..1 CodeableConcept E.g. patient, expense, depreciation
Binding: AccountTypes (example): The usage type of this account, permits categorization of accounts.


ele-1: All FHIR elements must have a @value or children
... subject Σ 0..* Reference(Patient) Who the sensitivity is for
ele-1: All FHIR elements must have a @value or children
... servicePeriod Σ 0..1 Period Transaction window
ele-1: All FHIR elements must have a @value or children
... coverage Σ 0..* BackboneElement The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... coverage Σ 1..1 Reference() The party(s), such as insurances, that may contribute to the payment of this account
ele-1: All FHIR elements must have a @value or children
... owner Σ 0..1 Reference(Organization) Entity Managing the account
ele-1: All FHIR elements must have a @value or children
... description Σ 0..1 string Explanation of purpose/use
ele-1: All FHIR elements must have a @value or children
... guarantor 0..* BackboneElement The parties ultimately responsible for balancing the Account
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... party 1..1 Reference(RelatedPerson) Responsible entity
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Account.statusrequiredAccountStatus
http://hl7.org/fhir/ValueSet/account-status|4.0.1
from the FHIR Standard
Account.typeexampleAccountTypes
http://hl7.org/fhir/ValueSet/account-type
from the FHIR Standard

This structure is derived from Account

NameFlagsCard.TypeDescription & Constraintsdoco
.. Account 0..* Account Account
... id S 1..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... versionId 0..1 id Version specific identifier
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Account Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-profile
... Slices for extension Content/Rules for all slices
.... visitDate 0..1 (Complex) Visit Date
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-visitDate
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-visitDate"
..... value[x] 1..1 dateTime Value of extension
.... billStatus 0..1 (Complex) Bill status
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-billStatus
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-billStatus"
..... value[x] 1..1 string Value of extension
.... currentCarrier 0..1 (Complex) Current carrier
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-currentCarrier
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-currentCarrier"
..... value[x] 1..1 integer Value of extension
.... patientVisitId 0..1 (Complex) Patient Visit Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-patientVisitId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-patientVisitId"
..... value[x] 1..1 integer Value of extension
.... doctorId 0..1 (Complex) Doctor Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-doctorId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-doctorId"
..... value[x] 1..1 Reference() Value of extension
.... facilityId 0..1 (Complex) Facility Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-facilityId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-facilityId"
..... value[x] 1..1 Reference() Value of extension
.... companyId 0..1 (Complex) Company Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-companyId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-companyId"
..... value[x] 1..1 Reference() Value of extension
.... extension:Total Balance 0..1 Extension Total Balance
.... extension:Insurance Balance 0..1 Extension Insurance Balance
.... extension:Patient Balance 0..1 Extension Patient Balance
.... extension:Deposit 0..1 Extension Deposit
.... financialClassMid 0..1 (Complex) Financial Class Mid
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-financialClassMid
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-financialClassMid"
..... value[x] 1..1 integer Value of extension
... status S 1..1 code account status
... type 0..1 CodeableConcept E.g. patient, expense, depreciation
... subject 0..* Reference(Patient) Who the sensitivity is for
... servicePeriod 0..1 Period Transaction window
... coverage 0..* BackboneElement The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
.... coverage 1..1 Reference() The party(s), such as insurances, that may contribute to the payment of this account
... owner 0..1 Reference(Organization) Entity Managing the account
... description 0..1 string Explanation of purpose/use
... guarantor 0..* BackboneElement The parties ultimately responsible for balancing the Account
.... party 1..1 Reference(RelatedPerson) Responsible entity

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Account 0..* Account Account
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Account Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-profile
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... visitDate 0..1 (Complex) Visit Date
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-visitDate
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-visitDate"
..... value[x] 1..1 dateTime Value of extension
.... billStatus 0..1 (Complex) Bill status
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-billStatus
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-billStatus"
..... value[x] 1..1 string Value of extension
.... currentCarrier 0..1 (Complex) Current carrier
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-currentCarrier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-currentCarrier"
..... value[x] 1..1 integer Value of extension
.... patientVisitId 0..1 (Complex) Patient Visit Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-patientVisitId
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-patientVisitId"
..... value[x] 1..1 integer Value of extension
.... doctorId 0..1 (Complex) Doctor Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-doctorId
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-doctorId"
..... value[x] 1..1 Reference() Value of extension
.... facilityId 0..1 (Complex) Facility Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-facilityId
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-facilityId"
..... value[x] 1..1 Reference() Value of extension
.... companyId 0..1 (Complex) Company Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-companyId
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-companyId"
..... value[x] 1..1 Reference() Value of extension
.... extension:Total Balance 0..1 Extension Total Balance
.... extension:Insurance Balance 0..1 Extension Insurance Balance
.... extension:Patient Balance 0..1 Extension Patient Balance
.... extension:Deposit 0..1 Extension Deposit
.... financialClassMid 0..1 (Complex) Financial Class Mid
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-financialClassMid
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-financialClassMid"
..... value[x] 1..1 integer Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... status ?!SΣ 1..1 code account status
Binding: AccountStatus (required): Indicates whether the account is available to be used.

... type Σ 0..1 CodeableConcept E.g. patient, expense, depreciation
Binding: AccountTypes (example): The usage type of this account, permits categorization of accounts.

... name Σ 0..1 string Human-readable label
... subject Σ 0..* Reference(Patient) Who the sensitivity is for
... servicePeriod Σ 0..1 Period Transaction window
... coverage Σ 0..* BackboneElement The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... coverage Σ 1..1 Reference() The party(s), such as insurances, that may contribute to the payment of this account
.... priority Σ 0..1 positiveInt The priority of the coverage in the context of this account
... owner Σ 0..1 Reference(Organization) Entity Managing the account
... description Σ 0..1 string Explanation of purpose/use
... guarantor 0..* BackboneElement The parties ultimately responsible for balancing the Account
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... party 1..1 Reference(RelatedPerson) Responsible entity
.... onHold 0..1 boolean Credit or other hold applied
.... period 0..1 Period Guarantee account during
... partOf 0..1 Reference(Account) Reference to a parent Account

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Account.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Account.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Account.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Account.statusrequiredAccountStatus
http://hl7.org/fhir/ValueSet/account-status|4.0.1
from the FHIR Standard
Account.typeexampleAccountTypes
http://hl7.org/fhir/ValueSet/account-type
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Account 0..* Account Account
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... versionId Σ 0..1 id Version specific identifier
ele-1: All FHIR elements must have a @value or children
.... lastUpdated Σ 0..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
ele-1: All FHIR elements must have a @value or children
..... profile:Account Profile Σ 1..1 canonical() Profiles this resource claims to conform to
ele-1: All FHIR elements must have a @value or children

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
.... visitDate 0..1 (Complex) Visit Date
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-visitDate
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-visitDate"
..... value[x] 1..1 dateTime Value of extension
ele-1: All FHIR elements must have a @value or children
.... billStatus 0..1 (Complex) Bill status
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-billStatus
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-billStatus"
..... value[x] 1..1 string Value of extension
ele-1: All FHIR elements must have a @value or children
.... currentCarrier 0..1 (Complex) Current carrier
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-currentCarrier
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-currentCarrier"
..... value[x] 1..1 integer Value of extension
ele-1: All FHIR elements must have a @value or children
.... patientVisitId 0..1 (Complex) Patient Visit Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-patientVisitId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-patientVisitId"
..... value[x] 1..1 integer Value of extension
ele-1: All FHIR elements must have a @value or children
.... doctorId 0..1 (Complex) Doctor Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-doctorId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-doctorId"
..... value[x] 1..1 Reference() Value of extension
ele-1: All FHIR elements must have a @value or children
.... facilityId 0..1 (Complex) Facility Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-facilityId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-facilityId"
..... value[x] 1..1 Reference() Value of extension
ele-1: All FHIR elements must have a @value or children
.... companyId 0..1 (Complex) Company Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-companyId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-companyId"
..... value[x] 1..1 Reference() Value of extension
ele-1: All FHIR elements must have a @value or children
.... extension:Total Balance 0..1 Extension Total Balance
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:Insurance Balance 0..1 Extension Insurance Balance
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:Patient Balance 0..1 Extension Patient Balance
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:Deposit 0..1 Extension Deposit
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... financialClassMid 0..1 (Complex) Financial Class Mid
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-financialClassMid
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-financialClassMid"
..... value[x] 1..1 integer Value of extension
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 0..* Identifier External ids for this item
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code account status
Binding: AccountStatus (required): Indicates whether the account is available to be used.


ele-1: All FHIR elements must have a @value or children
... type Σ 0..1 CodeableConcept E.g. patient, expense, depreciation
Binding: AccountTypes (example): The usage type of this account, permits categorization of accounts.


ele-1: All FHIR elements must have a @value or children
... subject Σ 0..* Reference(Patient) Who the sensitivity is for
ele-1: All FHIR elements must have a @value or children
... servicePeriod Σ 0..1 Period Transaction window
ele-1: All FHIR elements must have a @value or children
... coverage Σ 0..* BackboneElement The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... coverage Σ 1..1 Reference() The party(s), such as insurances, that may contribute to the payment of this account
ele-1: All FHIR elements must have a @value or children
... owner Σ 0..1 Reference(Organization) Entity Managing the account
ele-1: All FHIR elements must have a @value or children
... description Σ 0..1 string Explanation of purpose/use
ele-1: All FHIR elements must have a @value or children
... guarantor 0..* BackboneElement The parties ultimately responsible for balancing the Account
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... party 1..1 Reference(RelatedPerson) Responsible entity
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Account.statusrequiredAccountStatus
http://hl7.org/fhir/ValueSet/account-status|4.0.1
from the FHIR Standard
Account.typeexampleAccountTypes
http://hl7.org/fhir/ValueSet/account-type
from the FHIR Standard

Differential View

This structure is derived from Account

NameFlagsCard.TypeDescription & Constraintsdoco
.. Account 0..* Account Account
... id S 1..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... versionId 0..1 id Version specific identifier
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Account Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-profile
... Slices for extension Content/Rules for all slices
.... visitDate 0..1 (Complex) Visit Date
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-visitDate
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-visitDate"
..... value[x] 1..1 dateTime Value of extension
.... billStatus 0..1 (Complex) Bill status
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-billStatus
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-billStatus"
..... value[x] 1..1 string Value of extension
.... currentCarrier 0..1 (Complex) Current carrier
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-currentCarrier
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-currentCarrier"
..... value[x] 1..1 integer Value of extension
.... patientVisitId 0..1 (Complex) Patient Visit Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-patientVisitId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-patientVisitId"
..... value[x] 1..1 integer Value of extension
.... doctorId 0..1 (Complex) Doctor Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-doctorId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-doctorId"
..... value[x] 1..1 Reference() Value of extension
.... facilityId 0..1 (Complex) Facility Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-facilityId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-facilityId"
..... value[x] 1..1 Reference() Value of extension
.... companyId 0..1 (Complex) Company Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-companyId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-companyId"
..... value[x] 1..1 Reference() Value of extension
.... extension:Total Balance 0..1 Extension Total Balance
.... extension:Insurance Balance 0..1 Extension Insurance Balance
.... extension:Patient Balance 0..1 Extension Patient Balance
.... extension:Deposit 0..1 Extension Deposit
.... financialClassMid 0..1 (Complex) Financial Class Mid
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-financialClassMid
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-financialClassMid"
..... value[x] 1..1 integer Value of extension
... status S 1..1 code account status
... type 0..1 CodeableConcept E.g. patient, expense, depreciation
... subject 0..* Reference(Patient) Who the sensitivity is for
... servicePeriod 0..1 Period Transaction window
... coverage 0..* BackboneElement The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
.... coverage 1..1 Reference() The party(s), such as insurances, that may contribute to the payment of this account
... owner 0..1 Reference(Organization) Entity Managing the account
... description 0..1 string Explanation of purpose/use
... guarantor 0..* BackboneElement The parties ultimately responsible for balancing the Account
.... party 1..1 Reference(RelatedPerson) Responsible entity

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Account 0..* Account Account
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Account Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-profile
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... visitDate 0..1 (Complex) Visit Date
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-visitDate
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-visitDate"
..... value[x] 1..1 dateTime Value of extension
.... billStatus 0..1 (Complex) Bill status
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-billStatus
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-billStatus"
..... value[x] 1..1 string Value of extension
.... currentCarrier 0..1 (Complex) Current carrier
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-currentCarrier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-currentCarrier"
..... value[x] 1..1 integer Value of extension
.... patientVisitId 0..1 (Complex) Patient Visit Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-patientVisitId
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-patientVisitId"
..... value[x] 1..1 integer Value of extension
.... doctorId 0..1 (Complex) Doctor Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-doctorId
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-doctorId"
..... value[x] 1..1 Reference() Value of extension
.... facilityId 0..1 (Complex) Facility Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-facilityId
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-facilityId"
..... value[x] 1..1 Reference() Value of extension
.... companyId 0..1 (Complex) Company Id
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-companyId
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-companyId"
..... value[x] 1..1 Reference() Value of extension
.... extension:Total Balance 0..1 Extension Total Balance
.... extension:Insurance Balance 0..1 Extension Insurance Balance
.... extension:Patient Balance 0..1 Extension Patient Balance
.... extension:Deposit 0..1 Extension Deposit
.... financialClassMid 0..1 (Complex) Financial Class Mid
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-financialClassMid
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-account-extension-financialClassMid"
..... value[x] 1..1 integer Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External ids for this item
... status ?!SΣ 1..1 code account status
Binding: AccountStatus (required): Indicates whether the account is available to be used.

... type Σ 0..1 CodeableConcept E.g. patient, expense, depreciation
Binding: AccountTypes (example): The usage type of this account, permits categorization of accounts.

... name Σ 0..1 string Human-readable label
... subject Σ 0..* Reference(Patient) Who the sensitivity is for
... servicePeriod Σ 0..1 Period Transaction window
... coverage Σ 0..* BackboneElement The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... coverage Σ 1..1 Reference() The party(s), such as insurances, that may contribute to the payment of this account
.... priority Σ 0..1 positiveInt The priority of the coverage in the context of this account
... owner Σ 0..1 Reference(Organization) Entity Managing the account
... description Σ 0..1 string Explanation of purpose/use
... guarantor 0..* BackboneElement The parties ultimately responsible for balancing the Account
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... party 1..1 Reference(RelatedPerson) Responsible entity
.... onHold 0..1 boolean Credit or other hold applied
.... period 0..1 Period Guarantee account during
... partOf 0..1 Reference(Account) Reference to a parent Account

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Account.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Account.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Account.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Account.statusrequiredAccountStatus
http://hl7.org/fhir/ValueSet/account-status|4.0.1
from the FHIR Standard
Account.typeexampleAccountTypes
http://hl7.org/fhir/ValueSet/account-type
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

The Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Account resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/Account?{search-parameters}{&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token) The ID of the resource
patient (reference) Who the sensitivity is for
identifier (token) The ID of the Account resource
_lastUpdated (date)
_lastUpdated-fromnow (quantity) Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
_security (token)
_tag (token)
type (token) Search by type NOTE: All account resources have the code value fixed to account, which makes it of little value as a search parameter.
date (date) Date first version of the resource instance was recorded
date-fromnow (quantity) Like date except expressed as a positive or negative offset from the current time in units of time, e.g. date-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
companyId (token) Company Id of the facility associated with the visit
doctorId (token) The id of the physician associated with the visit for this account.
guarantor (token) The id of the guarantor associated with the visit for this account.
identifier (token) The business identifier of this account.
patientVisitId (token) The id of this visit associated with this account.
subject (reference) The patient associated with this account.
visitDate (date) The visit date for the visit associated with the account.
visitDate-fromnow (quantity) The visit date for the visit associated with the account represented as an offset from now.
owner (reference) The owner associated with the account.
period (date) The Transaction window period.
period-fromnow (quantity) The Transaction window period associated with the account represented as an offset from now.
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.