ChargeItemDefinition

ResourceFinancial · GeneralTrial useMaturity 0

The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

13 of 15 parameters tested

Structure

Show inherited elements (17)

Element	Card.	Type	Description
urlRequiredΣ	1..1	uri	Canonical identifier for this charge item definition, represented as a URI (globally unique)
identifierΣ	0..*	Identifier	Additional identifier for the charge item definition
versionΣ	0..1	string	Business version of the charge item definition
titleΣ	0..1	string	Name for this charge item definition (human friendly)
derivedFromUriΣ	0..*	uri	Underlying externally-defined charge item definition
partOfΣ	0..*	canonical(ChargeItemDefinition)	A larger definition of which this particular definition is a component or step
replacesΣ	0..*	canonical(ChargeItemDefinition)	Completed or terminated request(s) whose function is taken by this new request
statusRequired?!Σ	1..1	code	draft | active | retired | unknownBinding (required): publication-status
experimentalΣ	0..1	boolean	For testing purposes, not real usage
dateΣ	0..1	dateTime	Date last changed
publisherΣ	0..1	string	Name of the publisher (organization or individual)
contactΣ	0..*	ContactDetail	Contact details for the publisher
descriptionΣ	0..1	markdown	Natural language description of the charge item definition
useContextΣ	0..*	UsageContext	The context that the content is intended to support
jurisdictionΣ	0..*	CodeableConcept	Intended jurisdiction for charge item definition (if applicable)Binding (extensible): jurisdiction
copyright	0..1	markdown	Use and/or publishing restrictions
approvalDate	0..1	date	When the charge item definition was approved by publisher
lastReviewDate	0..1	date	When the charge item definition was last reviewed
effectivePeriodΣ	0..1	Period	When the charge item definition is expected to be used
codeΣ	0..1	CodeableConcept	Billing codes or product types this definition applies toBinding (example): chargeitem-billingcodes
instance	0..*	Reference(Medication | Substance | Device)	Instances this definition applies to
applicability	0..*	BackboneElement	Whether or not the billing code is applicable
description	0..1	string	Natural language description of the condition
language	0..1	string	Language of the expression
expression	0..1	string	Boolean-valued expression
propertyGroup	0..*	BackboneElement	Group of properties which are applicable under the same conditions
applicability	0..*	Same as ChargeItemDefinition.applicability	Conditions under which the priceComponent is applicable
priceComponent	0..*	BackboneElement	Components of total line item price
typeRequired	1..1	code	base | surcharge | deduction | discount | tax | informationalBinding (required): invoice-priceComponentType
code	0..1	CodeableConcept	Code identifying the specific component
factor	0..1	decimal	Factor used for calculating this component
amount	0..1	Money	Monetary amount associated with this component

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/ChargeItemDefinition?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
context	token	A use context assigned to the charge item definition (ChargeItemDefinition.useContext.value.ofType(CodeableConcept))
context-quantity	quantity	A quantity- or range-valued use context assigned to the charge item definition (ChargeItemDefinition.useContext.value.ofType(Quantity)) | (ChargeItemDefinition.useContext.value.ofType(Range))
context-type	token	A type of use context assigned to the charge item definition ChargeItemDefinition.useContext.code
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the charge item definition ChargeItemDefinition.useContext
context-type-value	composite	A use context type and value assigned to the charge item definition ChargeItemDefinition.useContext
date	date	The charge item definition publication date ChargeItemDefinition.date
description	string	The description of the charge item definition ChargeItemDefinition.description
effective	date	The time during which the charge item definition is intended to be in use ChargeItemDefinition.effectivePeriod
identifier	token	External identifier for the charge item definition ChargeItemDefinition.identifier
jurisdiction	token	Intended jurisdiction for the charge item definition ChargeItemDefinition.jurisdiction
publisher	string	Name of the publisher of the charge item definition ChargeItemDefinition.publisher
status	token	The current status of the charge item definition ChargeItemDefinition.status
title	string	The human-friendly name of the charge item definition ChargeItemDefinition.title
url	uri	The uri that identifies the charge item definition ChargeItemDefinition.url
version	token	The business version of the charge item definition ChargeItemDefinition.version

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition