BioMaxis Implementation Guide
0.0.0-semantic-release - ci-build
BioMaxis Implementation Guide - Local Development build (v0.0.0-semantic-release) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://biomaxis.com/fhir/StructureDefinition/biomaxis-account | Version: 0.0.0-semantic-release | |||
| Draft as of 2025-12-18 | Computable Name: BioMaxisAccount | |||
A profile for the Account resource used in BioMaxis. This profile includes extensions for balance and calculated instant to adhere to the changes made in the FHIR R5 specification
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Account | Tracks balance, charges, for patient or cost center | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | (Complex) | Account Balance URL: http://biomaxis.com/fhir/StructureDefinition/account-balance | |
![]() ![]() ![]() |
0..1 | instant | Account Calculated At URL: http://biomaxis.com/fhir/StructureDefinition/account-calculatedAt | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | active | inactive | entered-in-error | on-hold | unknown Binding: AccountStatus (required): Indicates whether the account is available to be used. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Account.status | Base | required | AccountStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Account | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Account | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Account | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Account | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Account | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Account
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Account | Tracks balance, charges, for patient or cost center | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | (Complex) | Account Balance URL: http://biomaxis.com/fhir/StructureDefinition/account-balance | |
![]() ![]() ![]() |
0..1 | instant | Account Calculated At URL: http://biomaxis.com/fhir/StructureDefinition/account-calculatedAt | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Account | Tracks balance, charges, for patient or cost center | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | (Complex) | Account Balance URL: http://biomaxis.com/fhir/StructureDefinition/account-balance | |||||
![]() ![]() ![]() |
0..1 | instant | Account Calculated At URL: http://biomaxis.com/fhir/StructureDefinition/account-calculatedAt | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Account number | ||||
![]() ![]() |
?!Σ | 1..1 | code | active | inactive | entered-in-error | on-hold | unknown Binding: AccountStatus (required): Indicates whether the account is available to be used. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | E.g. patient, expense, depreciation Binding: AccountTypes (example): The usage type of this account, permits categorization of accounts. | ||||
![]() ![]() |
Σ | 0..1 | string | Human-readable label | ||||
![]() ![]() |
Σ | 0..* | Reference(Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization) | The entity that caused the expenses | ||||
![]() ![]() |
Σ | 0..1 | Period | Transaction window | ||||
![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Coverage) | The party(s), such as insurances, that may contribute to the payment of this account | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | The priority of the coverage in the context of this account | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Entity managing the Account | ||||
![]() ![]() |
Σ | 0..1 | string | Explanation of purpose/use | ||||
![]() ![]() |
0..* | BackboneElement | The parties ultimately responsible for balancing the Account | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Reference(Patient | RelatedPerson | Organization) | Responsible entity | |||||
![]() ![]() ![]() |
0..1 | boolean | Credit or other hold applied | |||||
![]() ![]() ![]() |
0..1 | Period | Guarantee account during | |||||
![]() ![]() |
0..1 | Reference(Account) | Reference to a parent Account | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Account.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Account.status | Base | required | AccountStatus | 📍4.0.1 | FHIR Std. |
| Account.type | Base | example | Account Types | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Account | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Account | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Account | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Account | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Account | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Account
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Account | Tracks balance, charges, for patient or cost center | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | (Complex) | Account Balance URL: http://biomaxis.com/fhir/StructureDefinition/account-balance | |
![]() ![]() ![]() |
0..1 | instant | Account Calculated At URL: http://biomaxis.com/fhir/StructureDefinition/account-calculatedAt | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | active | inactive | entered-in-error | on-hold | unknown Binding: AccountStatus (required): Indicates whether the account is available to be used. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Account.status | Base | required | AccountStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Account | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Account | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Account | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Account | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Account | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Account
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Account | Tracks balance, charges, for patient or cost center | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..* | (Complex) | Account Balance URL: http://biomaxis.com/fhir/StructureDefinition/account-balance | |
![]() ![]() ![]() |
0..1 | instant | Account Calculated At URL: http://biomaxis.com/fhir/StructureDefinition/account-calculatedAt | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Account | Tracks balance, charges, for patient or cost center | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | (Complex) | Account Balance URL: http://biomaxis.com/fhir/StructureDefinition/account-balance | |||||
![]() ![]() ![]() |
0..1 | instant | Account Calculated At URL: http://biomaxis.com/fhir/StructureDefinition/account-calculatedAt | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Account number | ||||
![]() ![]() |
?!Σ | 1..1 | code | active | inactive | entered-in-error | on-hold | unknown Binding: AccountStatus (required): Indicates whether the account is available to be used. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | E.g. patient, expense, depreciation Binding: AccountTypes (example): The usage type of this account, permits categorization of accounts. | ||||
![]() ![]() |
Σ | 0..1 | string | Human-readable label | ||||
![]() ![]() |
Σ | 0..* | Reference(Patient | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization) | The entity that caused the expenses | ||||
![]() ![]() |
Σ | 0..1 | Period | Transaction window | ||||
![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Coverage) | The party(s), such as insurances, that may contribute to the payment of this account | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | The priority of the coverage in the context of this account | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Entity managing the Account | ||||
![]() ![]() |
Σ | 0..1 | string | Explanation of purpose/use | ||||
![]() ![]() |
0..* | BackboneElement | The parties ultimately responsible for balancing the Account | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | Reference(Patient | RelatedPerson | Organization) | Responsible entity | |||||
![]() ![]() ![]() |
0..1 | boolean | Credit or other hold applied | |||||
![]() ![]() ![]() |
0..1 | Period | Guarantee account during | |||||
![]() ![]() |
0..1 | Reference(Account) | Reference to a parent Account | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Account.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Account.status | Base | required | AccountStatus | 📍4.0.1 | FHIR Std. |
| Account.type | Base | example | Account Types | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Account | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Account | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Account | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Account | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Account | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Account
Other representations of profile: CSV, Excel, Schematron