CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• JSON

Resource Profile: ChargeItemSe(Version 2)

Introduction

​ChargeItemSe is a profile intended to be used to enable the billing process and internal cost allocation. This profile is based on the FHIR resource ChargeItem. The main difference of the version 2 of the profile is that ChargeItem.context refers to the version 2 of the profile EncounterSelfService

Intended Use

​In the context of an invoice this resource is currently used only for linking the Encounter resource with the invoice. For more details, see InvoiceSe. The ChargeItemSe is used as a contained resource within InvoiceSe

Specific Rules and Limitations

Versions

Supported Operations

Not applicable, this profile is just used as a contained resource and there is no API for ChargeItemSe.

Error Codes

Not applicable, this profile is just used as a contained resource and there is no API for ChargeItemSe.

Usages:

• Refer to this Profile: InvoiceSe(Version 2)

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ChargeItem		0..*	ChargeItemCore	Item containing charge code(s) associated with the provision of healthcare provider products
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	planned | billable | not-billable | aborted | billed | entered-in-error | unknown Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem.
code	Σ	1..1	CodeableConcept	A code that identifies the charge, like a billing code Binding: ChargeItemCode (example): Example set of codes that can be used for billing purposes.
coding	Σ	0..1	Coding	Code defined by a terminology system
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/chargeitem-billingcodes
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: 1320
display	Σ	0..1	string	Representation defined by the system Fixed Value: Grundpauschale
subject	ΣC	1..1	Reference(Patient)	Individual service was done for/to Constraints: ref-1
context	ΣC	1..1	Reference(EncounterSelfService(Version 2)) {c}	Encounter / Episode associated with event Constraints: ref-1
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Encounter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ChargeItem.status	required	ChargeItemStatus http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1 From the FHIR Standard
ChargeItem.code	example	ChargeItemCode http://hl7.org/fhir/ValueSet/chargeitem-billingcodes From the FHIR Standard
ChargeItem.context.type	extensible	Fixed Value: Encounter http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ChargeItem	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ChargeItem	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	ChargeItem	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	ChargeItem	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ChargeItem	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()
ref-1	error	ChargeItem.subject, ChargeItem.context, ChargeItem.performer.actor	SHALL have a contained resource if a local reference is provided :

This structure is derived from ChargeItemCore

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ChargeItem		0..*	ChargeItemCore	Item containing charge code(s) associated with the provision of healthcare provider products
identifier		0..0
definitionUri		0..0
definitionCanonical		0..0
status		1..1	code	planned | billable | not-billable | aborted | billed | entered-in-error | unknown
partOf		0..0
code
coding		0..1	Coding	Code defined by a terminology system
system		0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/chargeitem-billingcodes
code		0..1	code	Symbol in syntax defined by the system Fixed Value: 1320
display		0..1	string	Representation defined by the system Fixed Value: Grundpauschale
subject		1..1	Reference(Patient)	Individual service was done for/to
context		1..1	Reference(EncounterSelfService(Version 2)) {c}	Encounter / Episode associated with event
type		0..1	uri	Type the reference refers to (e.g. "Patient") Fixed Value: Encounter
occurrence[x]		0..0
performer		0..0
performingOrganization		0..0
requestingOrganization		0..0
costCenter		0..0
quantity		0..0
bodysite		0..0
factorOverride		0..0
priceOverride		0..0
overrideReason		0..0
enterer		0..0
enteredDate		0..0
reason		0..0
service		0..0
product[x]		0..0
account		0..0
note		0..0
supportingInformation		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ChargeItem		0..*	ChargeItemCore	Item containing charge code(s) associated with the provision of healthcare provider products
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	planned | billable | not-billable | aborted | billed | entered-in-error | unknown Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem.
code	Σ	1..1	CodeableConcept	A code that identifies the charge, like a billing code Binding: ChargeItemCode (example): Example set of codes that can be used for billing purposes.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/chargeitem-billingcodes
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: 1320
display	Σ	0..1	string	Representation defined by the system Fixed Value: Grundpauschale
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
subject	ΣC	1..1	Reference(Patient)	Individual service was done for/to Constraints: ref-1
context	ΣC	1..1	Reference(EncounterSelfService(Version 2)) {c}	Encounter / Episode associated with event Constraints: ref-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Encounter
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ChargeItem.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
ChargeItem.status	required	ChargeItemStatus http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1 From the FHIR Standard
ChargeItem.code	example	ChargeItemCode http://hl7.org/fhir/ValueSet/chargeitem-billingcodes From the FHIR Standard
ChargeItem.context.type	extensible	Fixed Value: Encounter http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
ChargeItem.performer.function	example	ProcedurePerformerRoleCodes http://hl7.org/fhir/ValueSet/performer-role From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ChargeItem	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ChargeItem	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	ChargeItem	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	ChargeItem	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ChargeItem	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()
ref-1	error	ChargeItem.subject, ChargeItem.context, ChargeItem.performer.actor	SHALL have a contained resource if a local reference is provided :

This structure is derived from ChargeItemCore

Summary

Mandatory: 1 element
Fixed: 4 elements
Prohibited: 22 elements

Structures

This structure refers to these other structures:

• EncounterSelfService(Version 2) (https://fhir.cambio.se/StructureDefinition/EncounterSelfService/v2)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ChargeItem		0..*	ChargeItemCore	Item containing charge code(s) associated with the provision of healthcare provider products
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	planned | billable | not-billable | aborted | billed | entered-in-error | unknown Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem.
code	Σ	1..1	CodeableConcept	A code that identifies the charge, like a billing code Binding: ChargeItemCode (example): Example set of codes that can be used for billing purposes.
coding	Σ	0..1	Coding	Code defined by a terminology system
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/chargeitem-billingcodes
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: 1320
display	Σ	0..1	string	Representation defined by the system Fixed Value: Grundpauschale
subject	ΣC	1..1	Reference(Patient)	Individual service was done for/to Constraints: ref-1
context	ΣC	1..1	Reference(EncounterSelfService(Version 2)) {c}	Encounter / Episode associated with event Constraints: ref-1
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Encounter
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ChargeItem.status	required	ChargeItemStatus http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1 From the FHIR Standard
ChargeItem.code	example	ChargeItemCode http://hl7.org/fhir/ValueSet/chargeitem-billingcodes From the FHIR Standard
ChargeItem.context.type	extensible	Fixed Value: Encounter http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ChargeItem	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ChargeItem	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	ChargeItem	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	ChargeItem	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ChargeItem	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()
ref-1	error	ChargeItem.subject, ChargeItem.context, ChargeItem.performer.actor	SHALL have a contained resource if a local reference is provided :

Differential View

This structure is derived from ChargeItemCore

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ChargeItem		0..*	ChargeItemCore	Item containing charge code(s) associated with the provision of healthcare provider products
identifier		0..0
definitionUri		0..0
definitionCanonical		0..0
status		1..1	code	planned | billable | not-billable | aborted | billed | entered-in-error | unknown
partOf		0..0
code
coding		0..1	Coding	Code defined by a terminology system
system		0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/chargeitem-billingcodes
code		0..1	code	Symbol in syntax defined by the system Fixed Value: 1320
display		0..1	string	Representation defined by the system Fixed Value: Grundpauschale
subject		1..1	Reference(Patient)	Individual service was done for/to
context		1..1	Reference(EncounterSelfService(Version 2)) {c}	Encounter / Episode associated with event
type		0..1	uri	Type the reference refers to (e.g. "Patient") Fixed Value: Encounter
occurrence[x]		0..0
performer		0..0
performingOrganization		0..0
requestingOrganization		0..0
costCenter		0..0
quantity		0..0
bodysite		0..0
factorOverride		0..0
priceOverride		0..0
overrideReason		0..0
enterer		0..0
enteredDate		0..0
reason		0..0
service		0..0
product[x]		0..0
account		0..0
note		0..0
supportingInformation		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ChargeItem		0..*	ChargeItemCore	Item containing charge code(s) associated with the provision of healthcare provider products
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	planned | billable | not-billable | aborted | billed | entered-in-error | unknown Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem.
code	Σ	1..1	CodeableConcept	A code that identifies the charge, like a billing code Binding: ChargeItemCode (example): Example set of codes that can be used for billing purposes.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/chargeitem-billingcodes
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Fixed Value: 1320
display	Σ	0..1	string	Representation defined by the system Fixed Value: Grundpauschale
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
subject	ΣC	1..1	Reference(Patient)	Individual service was done for/to Constraints: ref-1
context	ΣC	1..1	Reference(EncounterSelfService(Version 2)) {c}	Encounter / Episode associated with event Constraints: ref-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Encounter
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ChargeItem.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
ChargeItem.status	required	ChargeItemStatus http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1 From the FHIR Standard
ChargeItem.code	example	ChargeItemCode http://hl7.org/fhir/ValueSet/chargeitem-billingcodes From the FHIR Standard
ChargeItem.context.type	extensible	Fixed Value: Encounter http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
ChargeItem.performer.function	example	ProcedurePerformerRoleCodes http://hl7.org/fhir/ValueSet/performer-role From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ChargeItem	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ChargeItem	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	ChargeItem	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	ChargeItem	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ChargeItem	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()
ref-1	error	ChargeItem.subject, ChargeItem.context, ChargeItem.performer.actor	SHALL have a contained resource if a local reference is provided :

This structure is derived from ChargeItemCore

Summary

Mandatory: 1 element
Fixed: 4 elements
Prohibited: 22 elements

Structures

This structure refers to these other structures:

• EncounterSelfService(Version 2) (https://fhir.cambio.se/StructureDefinition/EncounterSelfService/v2)

Other representations of profile: CSV, Excel, Schematron