ChargeItemDefinition - FHIR Resource (r4)
This ChargeItemDefinition Resource uses the FHIR API standard for access and structure.
Validate an ChargeItemDefinition FHIR Resource (r4)
ChargeItemDefinition Attributes
AttributeField is listTypeDescription
Description: Canonical identifier for this charge item definition, represented as a URI (globally unique)
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": "http://fhir.de/ChargeItemDefinition/kbv/ebm-30110"Learn more about the (ChargeItemDefinition) url FHIR attribute
Description: Additional identifier for the charge item definition
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (ChargeItemDefinition) identifier FHIR attribute
Description: Business version of the charge item definition
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": "2-2018"Learn more about the (ChargeItemDefinition) version FHIR attribute
Description: Name for this charge item definition (human friendly)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": Learn more about the (ChargeItemDefinition) title FHIR attribute
Description: Underlying externally-defined charge item definition
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"derivedFromUri": Learn more about the (ChargeItemDefinition) derivedFromUri FHIR attribute
Description: A larger definition of which this particular definition is a component or step
FHIR Version: r4
Attribute Type : canonical(ChargeItemDefinition)
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"partOf": Learn more about the (ChargeItemDefinition) partOf FHIR attribute
Description: Completed or terminated request(s) whose function is taken by this new request
FHIR Version: r4
Attribute Type : canonical(ChargeItemDefinition)
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"replaces": Learn more about the (ChargeItemDefinition) replaces FHIR attribute
Description: draft | active | retired | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (ChargeItemDefinition) status FHIR attribute
Description: For testing purposes, not real usage
FHIR Version: r4
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": Learn more about the (ChargeItemDefinition) experimental FHIR attribute
Description: Date last changed
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": Learn more about the (ChargeItemDefinition) date FHIR attribute
Description: Name of the publisher (organization or individual)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": Learn more about the (ChargeItemDefinition) publisher FHIR attribute
Description: Contact details for the publisher
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (ChargeItemDefinition) contact FHIR attribute
Description: Natural language description of the charge item definition
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "Allergologisch-diagnostischer Komplex zur Diagnostik und/oder zum Ausschluss einer (Kontakt-)Allergie vom Spättyp (Typ IV), einschl. Kosten"Learn more about the (ChargeItemDefinition) description FHIR attribute
Description: The context that the content is intended to support
FHIR Version: r4
Attribute Type : UsageContext
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": Learn more about the (ChargeItemDefinition) useContext FHIR attribute
Description: Intended jurisdiction for charge item definition (if applicable)
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"jurisdiction": Learn more about the (ChargeItemDefinition) jurisdiction FHIR attribute
Description: Use and/or publishing restrictions
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"copyright": Learn more about the (ChargeItemDefinition) copyright FHIR attribute
Description: When the charge item definition was approved by publisher
FHIR Version: r4
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"approvalDate": Learn more about the (ChargeItemDefinition) approvalDate FHIR attribute
Description: When the charge item definition was last reviewed
FHIR Version: r4
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"lastReviewDate": Learn more about the (ChargeItemDefinition) lastReviewDate FHIR attribute
Description: When the charge item definition is expected to be used
FHIR Version: r4
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"effectivePeriod": {
"start": "2018-04-01",
"end": "2018-06-30"
}Learn more about the (ChargeItemDefinition) effectivePeriod FHIR attribute
Description: Billing codes or product types this definition applies to
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": {
"coding": [
{
"system": "http://fhir.de/CodingSystem/kbv/ebm",
"code": "30110",
"display": "Allergologiediagnostik I"
}
]
}Learn more about the (ChargeItemDefinition) code FHIR attribute
Description: Instances this definition applies to
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instance": Learn more about the (ChargeItemDefinition) instance FHIR attribute
Description: Whether or not the billing code is applicable
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"applicability": [
{
"description": "Excludes billing code 13250 for same Encounter",
"language": "text/cql",
"expression": "[some CQL expression]"
},
{
"description": "Applies only once per Encounter",
"language": "text/CQL",
"expression": "[some CQL expression]"
}
]Learn more about the (ChargeItemDefinition) applicability FHIR attribute
Description: Group of properties which are applicable under the same conditions
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"propertyGroup": [
{
"priceComponent": [
{
"type": "base",
"code": {
"coding": [
{
"system": "http://fhir.de/CodeSystem/kbv/ebm-attribute",
"code": "gesamt-euro",
"display": "Gesamt (Euro)"
}
]
},
"amount": {
"value": 67.44,
"currency": "EUR"
}
},
{
"type": "informational",
"code": {
"coding": [
{
"system": "http://fhir.de/CodeSystem/kbv/ebm-attribute",
"code": "gesamt-punkte",
"display": "Gesamt (Punkte)"
}
]
},
"factor": 633
}
]
}
]Learn more about the (ChargeItemDefinition) propertyGroup FHIR attribute
ChargeItemDefinition Example
{
"resourceType": "ChargeItemDefinition",
"id": "ebm",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: ebm</p><p><b>url</b>: <b>http://fhir.de/ChargeItemDefinition/kbv/ebm-30110</b></p><p><b>version</b>: 2-2018</p><p><b>status</b>: active</p><p><b>description</b>: Allergologisch-diagnostischer Komplex zur Diagnostik und/oder zum Ausschluss einer (Kontakt-)Allergie vom Spättyp (Typ IV), einschl. Kosten</p><p><b>effectivePeriod</b>: 01/04/2018 --> 30/06/2018</p><p><b>code</b>: Allergologiediagnostik I <span>(Details : {http://fhir.de/CodingSystem/kbv/ebm code '30110' = '30110', given as 'Allergologiediagnostik I'})</span></p><blockquote><p><b>applicability</b></p><p><b>description</b>: Excludes billing code 13250 for same Encounter</p><p><b>language</b>: text/cql</p><p><b>expression</b>: [some CQL expression]</p></blockquote><blockquote><p><b>applicability</b></p><p><b>description</b>: Applies only once per Encounter</p><p><b>language</b>: text/CQL</p><p><b>expression</b>: [some CQL expression]</p></blockquote><blockquote><p><b>propertyGroup</b></p><blockquote><p><b>priceComponent</b></p><p><b>type</b>: base</p><p><b>code</b>: Gesamt (Euro) <span>(Details : {http://fhir.de/CodeSystem/kbv/ebm-attribute code 'gesamt-euro' = 'gesamt-euro', given as 'Gesamt (Euro)'})</span></p><p><b>amount</b>: </p></blockquote><blockquote><p><b>priceComponent</b></p><p><b>type</b>: informational</p><p><b>code</b>: Gesamt (Punkte) <span>(Details : {http://fhir.de/CodeSystem/kbv/ebm-attribute code 'gesamt-punkte' = 'gesamt-punkte', given as 'Gesamt (Punkte)'})</span></p><p><b>factor</b>: 633</p></blockquote></blockquote></div>"
},
"url": "http://fhir.de/ChargeItemDefinition/kbv/ebm-30110",
"version": "2-2018",
"status": "active",
"description": "Allergologisch-diagnostischer Komplex zur Diagnostik und/oder zum Ausschluss einer (Kontakt-)Allergie vom Spättyp (Typ IV), einschl. Kosten",
"effectivePeriod": {
"start": "2018-04-01",
"end": "2018-06-30"
},
"code": {
"coding": [
{
"system": "http://fhir.de/CodingSystem/kbv/ebm",
"code": "30110",
"display": "Allergologiediagnostik I"
}
]
},
"applicability": [
{
"description": "Excludes billing code 13250 for same Encounter",
"language": "text/cql",
"expression": "[some CQL expression]"
},
{
"description": "Applies only once per Encounter",
"language": "text/CQL",
"expression": "[some CQL expression]"
}
],
"propertyGroup": [
{
"priceComponent": [
{
"type": "base",
"code": {
"coding": [
{
"system": "http://fhir.de/CodeSystem/kbv/ebm-attribute",
"code": "gesamt-euro",
"display": "Gesamt (Euro)"
}
]
},
"amount": {
"value": 67.44,
"currency": "EUR"
}
},
{
"type": "informational",
"code": {
"coding": [
{
"system": "http://fhir.de/CodeSystem/kbv/ebm-attribute",
"code": "gesamt-punkte",
"display": "Gesamt (Punkte)"
}
]
},
"factor": 633
}
]
}
]
}ChargeItemDefinition Structure
{
"resourceType" : "ChargeItemDefinition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // R! Canonical identifier for this charge item definition, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // Additional identifier for the charge item definition
"version" : "<string>", // Business version of the charge item definition
"title" : "<string>", // Name for this charge item definition (human friendly)
"derivedFromUri" : ["<uri>"], // Underlying externally-defined charge item definition
"partOf" : [{ canonical(ChargeItemDefinition) }], // A larger definition of which this particular definition is a component or step
"replaces" : [{ canonical(ChargeItemDefinition) }], // Completed or terminated request(s) whose function is taken by this new request
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the charge item definition
"useContext" : [{ UsageContext }], // The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for charge item definition (if applicable)
"copyright" : "<markdown>", // Use and/or publishing restrictions
"approvalDate" : "<date>", // When the charge item definition was approved by publisher
"lastReviewDate" : "<date>", // When the charge item definition was last reviewed
"effectivePeriod" : { Period }, // When the charge item definition is expected to be used
"code" : { CodeableConcept }, // Billing codes or product types this definition applies to
"instance" : [{ Reference(Medication|Substance|Device) }], // Instances this definition applies to
"applicability" : [{ // Whether or not the billing code is applicable
"description" : "<string>", // Natural language description of the condition
"language" : "<string>", // Language of the expression
"expression" : "<string>" // Boolean-valued expression
}],
"propertyGroup" : [{ // Group of properties which are applicable under the same conditions
"applicability" : [{ Content as for ChargeItemDefinition.applicability }], // Conditions under which the priceComponent is applicable
"priceComponent" : [{ // Components of total line item price
"type" : "<code>", // R! base | surcharge | deduction | discount | tax | informational
"code" : { CodeableConcept }, // Code identifying the specific component
"factor" : <decimal>, // Factor used for calculating this component
"amount" : { Money } // Monetary amount associated with this component
}]
}]
}
ChargeItemDefinition Search Parameters
The following search parameters can be used to query ChargeItemDefinition resources. Just submit them like so:
https://api.1up.health/fhir/r4/ChargeItemDefinition?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
context | text | useContext.value |
context-quantity | quantity | useContext.value |
context-type | text | useContext.code |
context-type-quantity | composite | useContext |
context-type-value | composite | useContext |
date | date | date |
description | text | description |
effective | date | effectivePeriod |
identifier | text | identifier |
jurisdiction | text | jurisdiction |
publisher | text | publisher |
status | text | status |
title | text | title |
url | uri | url |
version | text | version |
