Magentus Practice Management FHIR Implementation Guide
1.2.60 - ci-build Australia flag

Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.60) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: EBookings ChargeItem

Official URL: http://fhir.geniesolutions.io/StructureDefinition/ebookings-chargeitem Version: 1.2.60
Active as of 2026-04-05 Computable Name: EBookingsChargeItem

Genie EBookings ChargeItem profile. This supports both MBS codes as well as ADA codes for dental billing items (see ADA ValueSet).

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItem 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
... id SΣ 0..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code planned for EBookings
Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem.
Required Pattern: planned
... code SΣ 1..1 CodeableConcept Billing item of the planned booking
Binding: ChargeItemCode (example): Example set of codes that can be used for billing purposes.
.... Slices for coding Σ 0..1 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:All Slices Content/Rules for all slices
...... system Σ 1..1 uri Identity of the terminology system
..... coding:mbs SΣ 0..1 Coding MBS item number
...... system Σ 1..1 uri MBS item code system
Fixed Value: urn:oid:1.2.36.1.2001.1005.21
...... code Σ 1..1 code MBS item code
...... display Σ 0..1 string MBS item description
..... coding:ada SΣ 0..1 Coding ADA item number
...... system Σ 1..1 uri ADA item code system
Fixed Value: https://ada.org.au/CodeSystem/ada-dental-terms-valueset
...... code Σ 1..1 code ADA item code
...... display Σ 0..1 string ADA item description
.... text Σ 0..1 string Billing item description
... subject SΣ 1..1 Reference(EBookings Patient) Patient for item
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... context SΣ 0..1 Reference(EBookings Encounter) Encounter / Episode associated with event
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for occurrence[x] Σ 0..1 When the charged service was applied
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime When the charged service was done
... performer 0..1 BackboneElement Who performed charged service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor S 1..1 Reference(Genie Practitioner) Provider who performed the service
..... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
...... 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.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: EI
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 1..1 uri Pattern: http://fhir.geniesolutions.io/user-name/{tenant-id}
Example General: http://www.acme.com/identifiers/patient
...... value Σ 1..1 string username
Example General: 123456
... quantity SΣ 0..1 Quantity Number of charge item to been serviced
.... value Σ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItem.status Base required ChargeItemStatus 📍4.0.1 FHIR Std.
ChargeItem.code Base example ChargeItemCode 📍4.0.1 FHIR Std.
ChargeItem.performer.​actor.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
ChargeItem.performer.​actor.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ChargeItem.quantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from ChargeItem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItem 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
... id S 0..1 id Logical id of this artifact
... status S 1..1 code planned for EBookings
Required Pattern: planned
... code S 1..1 CodeableConcept Billing item of the planned booking
.... Slices for coding 0..1 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:All Slices Content/Rules for all slices
...... system 1..1 uri Identity of the terminology system
..... coding:mbs S 0..1 Coding MBS item number
...... system 1..1 uri MBS item code system
Fixed Value: urn:oid:1.2.36.1.2001.1005.21
...... code 1..1 code MBS item code
...... display 0..1 string MBS item description
..... coding:ada S 0..1 Coding ADA item number
...... system 1..1 uri ADA item code system
Fixed Value: https://ada.org.au/CodeSystem/ada-dental-terms-valueset
...... code 1..1 code ADA item code
...... display 0..1 string ADA item description
.... text 0..1 string Billing item description
... subject S 1..1 Reference(EBookings Patient) Patient for item
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... context S 0..1 Reference(EBookings Encounter) Encounter / Episode associated with event
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for occurrence[x] 0..1 dateTime, Period, Timing When the charged service was applied
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 0..1 dateTime When the charged service was done
... performer 0..1 BackboneElement Who performed charged service
.... actor S 1..1 Reference(Genie Practitioner) Provider who performed the service
..... reference 0..0 Literal reference, Relative, internal or absolute URL
..... identifier 1..1 Identifier Logical reference, when literal reference is not known
...... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: EI
...... system 1..1 uri Pattern: http://fhir.geniesolutions.io/user-name/{tenant-id}
...... value 1..1 string username
... quantity S 0..1 Quantity Number of charge item to been serviced
.... value 1..1 decimal Numerical value (with implicit precision)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItem 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
... id SΣ 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 BindingsPurpose
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
... identifier Σ 0..* Identifier Business Identifier for item
... definitionUri 0..* uri Defining information about the code of this charge item
... definitionCanonical 0..* canonical(ChargeItemDefinition) Resource defining the code of this ChargeItem
... status ?!SΣ 1..1 code planned for EBookings
Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem.
Required Pattern: planned
... partOf 0..* Reference(ChargeItem) Part of referenced ChargeItem
... code SΣ 1..1 CodeableConcept Billing item of the planned booking
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
.... Slices for coding Σ 0..1 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding: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
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:mbs SΣ 0..1 Coding MBS item 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
...... system Σ 1..1 uri MBS item code system
Fixed Value: urn:oid:1.2.36.1.2001.1005.21
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code MBS item code
...... display Σ 0..1 string MBS item description
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:ada SΣ 0..1 Coding ADA item 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
...... system Σ 1..1 uri ADA item code system
Fixed Value: https://ada.org.au/CodeSystem/ada-dental-terms-valueset
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code ADA item code
...... display Σ 0..1 string ADA item description
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Billing item description
... subject SΣ 1..1 Reference(EBookings Patient) Patient for item
.... 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 1..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).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... context SΣ 0..1 Reference(EBookings Encounter) Encounter / Episode associated with event
.... 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 1..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).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for occurrence[x] Σ 0..1 When the charged service was applied
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime When the charged service was done
... performer 0..1 BackboneElement Who performed charged service
.... 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
.... function 0..1 CodeableConcept What type of performance was done
Binding: ProcedurePerformerRoleCodes (example): Codes describing the types of functional roles performers can take on when performing events.
.... actor S 1..1 Reference(Genie Practitioner) Provider who performed the service
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value: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).
..... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
...... 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.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: EI
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 1..1 uri Pattern: http://fhir.geniesolutions.io/user-name/{tenant-id}
Example General: http://www.acme.com/identifiers/patient
...... value Σ 1..1 string username
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)
..... display Σ 0..1 string Text alternative for the resource
... performingOrganization 0..1 Reference(Organization) Organization providing the charged service
... requestingOrganization 0..1 Reference(Organization) Organization requesting the charged service
... costCenter 0..1 Reference(Organization) Organization that has ownership of the (potential, future) revenue
... quantity SΣ 0..1 Quantity Number of charge item to been serviced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit Σ 0..1 string Unit representation
.... system ΣC 0..1 uri System that defines coded unit form
.... code Σ 0..1 code Coded form of the unit
... bodysite Σ 0..* CodeableConcept Anatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... factorOverride 0..1 decimal Factor overriding the associated rules
... priceOverride 0..1 Money Price overriding the associated rules
... overrideReason 0..1 string Reason for overriding the list price/factor
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was entering
... enteredDate Σ 0..1 dateTime Date the charge item was entered
... reason 0..* CodeableConcept Why was the charged service rendered?
Binding: ICD-10Codes (example): Example binding for reason.
... service 0..* Reference(DiagnosticReport | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | Observation | Procedure | SupplyDelivery) Which rendered service is being charged?
... product[x] 0..1 Product charged
Binding: FHIRDeviceTypes (example): Example binding for product type.
.... productReference Reference(Device | Medication | Substance)
.... productCodeableConcept CodeableConcept
... account Σ 0..* Reference(Account) Account to place this charge
... note 0..* Annotation Comments made about the ChargeItem
... supportingInformation 0..* Reference(Resource) Further information supporting this charge

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ChargeItem.status Base required ChargeItemStatus 📍4.0.1 FHIR Std.
ChargeItem.code Base example ChargeItemCode 📍4.0.1 FHIR Std.
ChargeItem.subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
ChargeItem.context.type Base extensible ResourceType 📍4.0.1 FHIR Std.
ChargeItem.performer.​function Base example Procedure Performer Role Codes 📍4.0.1 FHIR Std.
ChargeItem.performer.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
ChargeItem.performer.​actor.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
ChargeItem.performer.​actor.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ChargeItem.quantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
ChargeItem.bodysite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
ChargeItem.reason Base example ICD-10 Codes 📍4.0.1 FHIR Std.
ChargeItem.product[x] Base example FHIR Device Types 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from ChargeItem

Summary

Mandatory: 1 element(8 nested mandatory elements)
Must-Support: 10 elements
Fixed: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ChargeItem.code.coding
  • The element 1 is sliced based on the value of ChargeItem.occurrence[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItem 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
... id SΣ 0..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code planned for EBookings
Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem.
Required Pattern: planned
... code SΣ 1..1 CodeableConcept Billing item of the planned booking
Binding: ChargeItemCode (example): Example set of codes that can be used for billing purposes.
.... Slices for coding Σ 0..1 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:All Slices Content/Rules for all slices
...... system Σ 1..1 uri Identity of the terminology system
..... coding:mbs SΣ 0..1 Coding MBS item number
...... system Σ 1..1 uri MBS item code system
Fixed Value: urn:oid:1.2.36.1.2001.1005.21
...... code Σ 1..1 code MBS item code
...... display Σ 0..1 string MBS item description
..... coding:ada SΣ 0..1 Coding ADA item number
...... system Σ 1..1 uri ADA item code system
Fixed Value: https://ada.org.au/CodeSystem/ada-dental-terms-valueset
...... code Σ 1..1 code ADA item code
...... display Σ 0..1 string ADA item description
.... text Σ 0..1 string Billing item description
... subject SΣ 1..1 Reference(EBookings Patient) Patient for item
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... context SΣ 0..1 Reference(EBookings Encounter) Encounter / Episode associated with event
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for occurrence[x] Σ 0..1 When the charged service was applied
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime When the charged service was done
... performer 0..1 BackboneElement Who performed charged service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor S 1..1 Reference(Genie Practitioner) Provider who performed the service
..... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
...... 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.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: EI
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 1..1 uri Pattern: http://fhir.geniesolutions.io/user-name/{tenant-id}
Example General: http://www.acme.com/identifiers/patient
...... value Σ 1..1 string username
Example General: 123456
... quantity SΣ 0..1 Quantity Number of charge item to been serviced
.... value Σ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItem.status Base required ChargeItemStatus 📍4.0.1 FHIR Std.
ChargeItem.code Base example ChargeItemCode 📍4.0.1 FHIR Std.
ChargeItem.performer.​actor.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
ChargeItem.performer.​actor.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ChargeItem.quantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

Differential View

This structure is derived from ChargeItem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItem 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
... id S 0..1 id Logical id of this artifact
... status S 1..1 code planned for EBookings
Required Pattern: planned
... code S 1..1 CodeableConcept Billing item of the planned booking
.... Slices for coding 0..1 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:All Slices Content/Rules for all slices
...... system 1..1 uri Identity of the terminology system
..... coding:mbs S 0..1 Coding MBS item number
...... system 1..1 uri MBS item code system
Fixed Value: urn:oid:1.2.36.1.2001.1005.21
...... code 1..1 code MBS item code
...... display 0..1 string MBS item description
..... coding:ada S 0..1 Coding ADA item number
...... system 1..1 uri ADA item code system
Fixed Value: https://ada.org.au/CodeSystem/ada-dental-terms-valueset
...... code 1..1 code ADA item code
...... display 0..1 string ADA item description
.... text 0..1 string Billing item description
... subject S 1..1 Reference(EBookings Patient) Patient for item
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... context S 0..1 Reference(EBookings Encounter) Encounter / Episode associated with event
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for occurrence[x] 0..1 dateTime, Period, Timing When the charged service was applied
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 0..1 dateTime When the charged service was done
... performer 0..1 BackboneElement Who performed charged service
.... actor S 1..1 Reference(Genie Practitioner) Provider who performed the service
..... reference 0..0 Literal reference, Relative, internal or absolute URL
..... identifier 1..1 Identifier Logical reference, when literal reference is not known
...... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: EI
...... system 1..1 uri Pattern: http://fhir.geniesolutions.io/user-name/{tenant-id}
...... value 1..1 string username
... quantity S 0..1 Quantity Number of charge item to been serviced
.... value 1..1 decimal Numerical value (with implicit precision)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItem 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
... id SΣ 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 BindingsPurpose
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
... identifier Σ 0..* Identifier Business Identifier for item
... definitionUri 0..* uri Defining information about the code of this charge item
... definitionCanonical 0..* canonical(ChargeItemDefinition) Resource defining the code of this ChargeItem
... status ?!SΣ 1..1 code planned for EBookings
Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem.
Required Pattern: planned
... partOf 0..* Reference(ChargeItem) Part of referenced ChargeItem
... code SΣ 1..1 CodeableConcept Billing item of the planned booking
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
.... Slices for coding Σ 0..1 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding: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
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:mbs SΣ 0..1 Coding MBS item 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
...... system Σ 1..1 uri MBS item code system
Fixed Value: urn:oid:1.2.36.1.2001.1005.21
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code MBS item code
...... display Σ 0..1 string MBS item description
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:ada SΣ 0..1 Coding ADA item 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
...... system Σ 1..1 uri ADA item code system
Fixed Value: https://ada.org.au/CodeSystem/ada-dental-terms-valueset
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code ADA item code
...... display Σ 0..1 string ADA item description
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Billing item description
... subject SΣ 1..1 Reference(EBookings Patient) Patient for item
.... 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 1..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).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... context SΣ 0..1 Reference(EBookings Encounter) Encounter / Episode associated with event
.... 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 1..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).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for occurrence[x] Σ 0..1 When the charged service was applied
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime When the charged service was done
... performer 0..1 BackboneElement Who performed charged service
.... 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
.... function 0..1 CodeableConcept What type of performance was done
Binding: ProcedurePerformerRoleCodes (example): Codes describing the types of functional roles performers can take on when performing events.
.... actor S 1..1 Reference(Genie Practitioner) Provider who performed the service
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value: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).
..... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
...... 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.
Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: EI
........ display 0..1 string Representation defined by the system
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text 0..1 string Plain text representation of the concept
...... system Σ 1..1 uri Pattern: http://fhir.geniesolutions.io/user-name/{tenant-id}
Example General: http://www.acme.com/identifiers/patient
...... value Σ 1..1 string username
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)
..... display Σ 0..1 string Text alternative for the resource
... performingOrganization 0..1 Reference(Organization) Organization providing the charged service
... requestingOrganization 0..1 Reference(Organization) Organization requesting the charged service
... costCenter 0..1 Reference(Organization) Organization that has ownership of the (potential, future) revenue
... quantity SΣ 0..1 Quantity Number of charge item to been serviced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit Σ 0..1 string Unit representation
.... system ΣC 0..1 uri System that defines coded unit form
.... code Σ 0..1 code Coded form of the unit
... bodysite Σ 0..* CodeableConcept Anatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... factorOverride 0..1 decimal Factor overriding the associated rules
... priceOverride 0..1 Money Price overriding the associated rules
... overrideReason 0..1 string Reason for overriding the list price/factor
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was entering
... enteredDate Σ 0..1 dateTime Date the charge item was entered
... reason 0..* CodeableConcept Why was the charged service rendered?
Binding: ICD-10Codes (example): Example binding for reason.
... service 0..* Reference(DiagnosticReport | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | Observation | Procedure | SupplyDelivery) Which rendered service is being charged?
... product[x] 0..1 Product charged
Binding: FHIRDeviceTypes (example): Example binding for product type.
.... productReference Reference(Device | Medication | Substance)
.... productCodeableConcept CodeableConcept
... account Σ 0..* Reference(Account) Account to place this charge
... note 0..* Annotation Comments made about the ChargeItem
... supportingInformation 0..* Reference(Resource) Further information supporting this charge

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ChargeItem.status Base required ChargeItemStatus 📍4.0.1 FHIR Std.
ChargeItem.code Base example ChargeItemCode 📍4.0.1 FHIR Std.
ChargeItem.subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
ChargeItem.context.type Base extensible ResourceType 📍4.0.1 FHIR Std.
ChargeItem.performer.​function Base example Procedure Performer Role Codes 📍4.0.1 FHIR Std.
ChargeItem.performer.​actor.type Base extensible ResourceType 📍4.0.1 FHIR Std.
ChargeItem.performer.​actor.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
ChargeItem.performer.​actor.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ChargeItem.quantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
ChargeItem.bodysite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
ChargeItem.reason Base example ICD-10 Codes 📍4.0.1 FHIR Std.
ChargeItem.product[x] Base example FHIR Device Types 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

This structure is derived from ChargeItem

Summary

Mandatory: 1 element(8 nested mandatory elements)
Must-Support: 10 elements
Fixed: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ChargeItem.code.coding
  • The element 1 is sliced based on the value of ChargeItem.occurrence[x]

 

Other representations of profile: CSV, Excel, Schematron