This page is part of the KLFFBMessaging (v1.0.0: Release) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Account

Account Information for FFB messaging

Usage:

• Refer to this Resource Profile: OrderMessageHeader

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Account

Name	Flags	Card.	Type	Description & Constraints
Account		0..*	Account	Tracks balance, charges, for patient or cost center
Slices for identifier	S	1..*	Identifier	Account number Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
identifier:accountno	S	1..1	Identifier	Account number
system		0..1	uri	The namespace for the identifier value Required Pattern: urn:accountno
status	S	1..1	code	active | inactive | entered-in-error | on-hold | unknown Required Pattern: active
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Account		0..*	Account	Tracks balance, charges, for patient or cost center
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	Account number Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:accountno	SΣ	1..1	Identifier	Account number
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: urn:accountno
status	?!SΣ	1..1	code	active | inactive | entered-in-error | on-hold | unknown Binding: AccountStatus (required): Indicates whether the account is available to be used. Required Pattern: active
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Account.identifier.use	required	IdentifierUse
Account.identifier:accountno.use	required	IdentifierUse
Account.status	required	Pattern: active

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Name	Flags	Card.	Type	Description & Constraints
Account		0..*	Account	Tracks balance, charges, for patient or cost center
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	Account number Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:accountno	SΣ	1..1	Identifier	Account number
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: urn:accountno
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	active | inactive | entered-in-error | on-hold | unknown Binding: AccountStatus (required): Indicates whether the account is available to be used. Required Pattern: active
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 | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization)	The entity that caused the expenses
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(Coverage)	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(Patient | RelatedPerson | Organization)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Account.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Account.identifier.use	required	IdentifierUse
Account.identifier.type	extensible	Identifier Type Codes
Account.identifier:accountno.use	required	IdentifierUse
Account.identifier:accountno.type	extensible	Identifier Type Codes
Account.status	required	Pattern: active
Account.type	example	AccountTypes

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Summary

Mandatory: 4 elements
Must-Support: 5 elements

Slices

This structure defines the following Slices:

• The element Account.identifier is sliced based on the value of value:system

Differential View

This structure is derived from Account

Name	Flags	Card.	Type	Description & Constraints
Account		0..*	Account	Tracks balance, charges, for patient or cost center
Slices for identifier	S	1..*	Identifier	Account number Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
identifier:accountno	S	1..1	Identifier	Account number
system		0..1	uri	The namespace for the identifier value Required Pattern: urn:accountno
status	S	1..1	code	active | inactive | entered-in-error | on-hold | unknown Required Pattern: active
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Account		0..*	Account	Tracks balance, charges, for patient or cost center
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	Account number Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:accountno	SΣ	1..1	Identifier	Account number
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: urn:accountno
status	?!SΣ	1..1	code	active | inactive | entered-in-error | on-hold | unknown Binding: AccountStatus (required): Indicates whether the account is available to be used. Required Pattern: active
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Account.identifier.use	required	IdentifierUse
Account.identifier:accountno.use	required	IdentifierUse
Account.status	required	Pattern: active

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Account		0..*	Account	Tracks balance, charges, for patient or cost center
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	Account number Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:accountno	SΣ	1..1	Identifier	Account number
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: urn:accountno
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	active | inactive | entered-in-error | on-hold | unknown Binding: AccountStatus (required): Indicates whether the account is available to be used. Required Pattern: active
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 | Device | Practitioner | PractitionerRole | Location | HealthcareService | Organization)	The entity that caused the expenses
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(Coverage)	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(Patient | RelatedPerson | Organization)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Account.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Account.identifier.use	required	IdentifierUse
Account.identifier.type	extensible	Identifier Type Codes
Account.identifier:accountno.use	required	IdentifierUse
Account.identifier:accountno.type	extensible	Identifier Type Codes
Account.status	required	Pattern: active
Account.type	example	AccountTypes

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Summary

Mandatory: 4 elements
Must-Support: 5 elements

Slices

This structure defines the following Slices:

• The element Account.identifier is sliced based on the value of value:system

Other representations of profile: CSV, Excel, Schematron