ChargeItem - FHIR Resource (stu3)
This ChargeItem Resource uses the FHIR API standard for access and structure.
Validate an ChargeItem FHIR Resource (stu3)
ChargeItem Attributes
AttributeField is listTypeDescription
Description: A code that identifies the charge, like a billing code
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": {
"coding": [
{
"code": "01510",
"display": "Zusatzpauschale für Beobachtung nach diagnostischer Koronarangiografie"
}
]
}Learn more about the (ChargeItem) code FHIR attribute
Description: Price overriding the associated rules
FHIR Version: stu3
Attribute Type : Money
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"priceOverride": {
"code": "EUR",
"unit": "EUR",
"value": 40,
"system": "urn:iso:std:iso:4217"
}Learn more about the (ChargeItem) priceOverride FHIR attribute
Description: Individual service was done for/to
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/example"
}Learn more about the (ChargeItem) subject FHIR attribute
Description: Who performed charged service
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"participant": [
{
"role": {
"coding": [
{
"code": "17561000",
"system": "http://snomed.info/sct",
"display": "Cardiologist"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
},
{
"role": {
"coding": [
{
"code": "224542009",
"system": "http://snomed.info/sct",
"display": "Coronary Care Nurse"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
}
]Learn more about the (ChargeItem) participant FHIR attribute
Description: "service" : [{ Reference(DiagnosticReport|ImagingStudy|Immunization|
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"service": [
{
"reference": "Procedure/example"
}
]Learn more about the (ChargeItem) service FHIR attribute
Description: "enterer" : { Reference(Practitioner|Organization|Patient|Device|
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"enterer": {
"reference": "Practitioner/example"
}Learn more about the (ChargeItem) enterer FHIR attribute
Description: Comments made about the ChargeItem
FHIR Version: stu3
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": [
{
"text": "The code is only applicable for periods longer than 4h",
"time": "2017-01-25T23:55:04+01:00",
"authorReference": {
"reference": "Practitioner/example"
}
}
]Learn more about the (ChargeItem) note FHIR attribute
Description: "occurrencePeriod" : { Period },
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrencePeriod": {
"start": "2017-01-25T08:00:00+01:00",
"end": "2017-01-25T12:35:00+01:00"
}Learn more about the (ChargeItem) occurrencePeriod FHIR attribute
Description: Anatomical location, if relevant
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"bodysite": Learn more about the (ChargeItem) bodysite FHIR attribute
Description: Further information supporting the this charge
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"supportingInformation": Learn more about the (ChargeItem) supportingInformation FHIR attribute
Description: planned | billable | not-billable | aborted | billed | entered-in-error | unknown
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "billable"Learn more about the (ChargeItem) status FHIR attribute
Description: Organization providing the charged sevice
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performingOrganization": {
"identifier": {
"system": "http://myhospital/NamingSystem/departments",
"value": "CARD_INTERMEDIATE_CARE"
}
}Learn more about the (ChargeItem) performingOrganization FHIR attribute
Description: Why was the charged service rendered?
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reason": [
{
"coding": [
{
"code": "123456",
"system": "http://hl7.org/fhir/sid/icd-10",
"display": "DIAG-1"
}
]
}
]Learn more about the (ChargeItem) reason FHIR attribute
Description: "occurrenceDateTime" : "<dateTime>",
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrenceDateTime": Learn more about the (ChargeItem) occurrenceDateTime FHIR attribute
Description: Defining information about the code of this charge item
FHIR Version: stu3
Attribute Type : uri
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"definition": [
"http://www.kbv.de/tools/ebm/html/01520_2904360860826220813632.html"
]Learn more about the (ChargeItem) definition FHIR attribute
Description: Account to place this charge
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"account": [
{
"reference": "Account/example"
}
]Learn more about the (ChargeItem) account FHIR attribute
Description: Organization requesting the charged service
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requestingOrganization": {
"identifier": {
"system": "http://myhospital/NamingSystem/departments",
"value": "CARD_U1"
}
}Learn more about the (ChargeItem) requestingOrganization FHIR attribute
Description: Factor overriding the associated rules
FHIR Version: stu3
Attribute Type : decimal
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"factorOverride": 0.8Learn more about the (ChargeItem) factorOverride FHIR attribute
Description: Reason for overriding the list price/factor
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"overrideReason": "Patient is Cardiologist's golf buddy, so he gets a 20% discount!"Learn more about the (ChargeItem) overrideReason FHIR attribute
Description: "occurrenceTiming" : { Timing },
FHIR Version: stu3
Attribute Type : Timing
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrenceTiming": Learn more about the (ChargeItem) occurrenceTiming FHIR attribute
Description: Encounter / Episode associated with event
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"context": {
"reference": "Encounter/example"
}Learn more about the (ChargeItem) context FHIR attribute
Description: Date the charge item was entered
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"enteredDate": "2017-01-25T23:55:04+01:00"Learn more about the (ChargeItem) enteredDate FHIR attribute
Description: Business Identifier for item
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": {
"system": "http://myHospital.org/ChargeItems",
"value": "654321"
}Learn more about the (ChargeItem) identifier FHIR attribute
Description: Part of referenced ChargeItem
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"partOf": Learn more about the (ChargeItem) partOf FHIR attribute
Description: Quantity of which the charge item has been serviced
FHIR Version: stu3
Attribute Type : Quantity
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"quantity": {
"value": 1
}Learn more about the (ChargeItem) quantity FHIR attribute
ChargeItem Example
{
"code": {
"coding": [
{
"code": "01510",
"display": "Zusatzpauschale für Beobachtung nach diagnostischer Koronarangiografie"
}
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Example of ChargeItem Usage in Context of the German EBM Billing code system</div>"
},
"priceOverride": {
"code": "EUR",
"unit": "EUR",
"value": 40,
"system": "urn:iso:std:iso:4217"
},
"id": "example",
"subject": {
"reference": "Patient/example"
},
"participant": [
{
"role": {
"coding": [
{
"code": "17561000",
"system": "http://snomed.info/sct",
"display": "Cardiologist"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
},
{
"role": {
"coding": [
{
"code": "224542009",
"system": "http://snomed.info/sct",
"display": "Coronary Care Nurse"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
}
],
"requestingOrganization": {
"identifier": {
"system": "http://myhospital/NamingSystem/departments",
"value": "CARD_U1"
}
},
"enterer": {
"reference": "Practitioner/example"
},
"note": [
{
"text": "The code is only applicable for periods longer than 4h",
"time": "2017-01-25T23:55:04+01:00",
"authorReference": {
"reference": "Practitioner/example"
}
}
],
"occurrencePeriod": {
"start": "2017-01-25T08:00:00+01:00",
"end": "2017-01-25T12:35:00+01:00"
},
"status": "billable",
"performingOrganization": {
"identifier": {
"system": "http://myhospital/NamingSystem/departments",
"value": "CARD_INTERMEDIATE_CARE"
}
},
"reason": [
{
"coding": [
{
"code": "123456",
"system": "http://hl7.org/fhir/sid/icd-10",
"display": "DIAG-1"
}
]
}
],
"definition": [
"http://www.kbv.de/tools/ebm/html/01520_2904360860826220813632.html"
],
"account": [
{
"reference": "Account/example"
}
],
"service": [
{
"reference": "Procedure/example"
}
],
"factorOverride": 0.8,
"resourceType": "ChargeItem",
"overrideReason": "Patient is Cardiologist's golf buddy, so he gets a 20% discount!",
"context": {
"reference": "Encounter/example"
},
"enteredDate": "2017-01-25T23:55:04+01:00",
"identifier": {
"system": "http://myHospital.org/ChargeItems",
"value": "654321"
},
"quantity": {
"value": 1
}
}ChargeItem Structure
{
"resourceType" : "ChargeItem",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : { Identifier }, // Business Identifier for item
"definition" : ["<uri>"], // Defining information about the code of this charge item
"status" : "<code>", // R! planned | billable | not-billable | aborted | billed | entered-in-error | unknown
"partOf" : [{ Reference(ChargeItem) }], // Part of referenced ChargeItem
"code" : { CodeableConcept }, // R! A code that identifies the charge, like a billing code
"subject" : { Reference(Patient|Group) }, // R! Individual service was done for/to
"context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter / Episode associated with event
// occurrence[x]: When the charged service was applied. One of these 3:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"occurrenceTiming" : { Timing },
"participant" : [{ // Who performed charged service
"role" : { CodeableConcept }, // What type of performance was done
"actor" : { Reference(Practitioner|Organization|Patient|Device|
RelatedPerson) } // R! Individual who was performing
}],
"performingOrganization" : { Reference(Organization) }, // Organization providing the charged sevice
"requestingOrganization" : { Reference(Organization) }, // Organization requesting the charged service
"quantity" : { Quantity }, // Quantity of which the charge item has been serviced
"bodysite" : [{ CodeableConcept }], // Anatomical location, if relevant
"factorOverride" : <decimal>, // Factor overriding the associated rules
"priceOverride" : { Money }, // Price overriding the associated rules
"overrideReason" : "<string>", // Reason for overriding the list price/factor
"enterer" : { Reference(Practitioner|Organization|Patient|Device|
RelatedPerson) }, // Individual who was entering
"enteredDate" : "<dateTime>", // Date the charge item was entered
"reason" : [{ CodeableConcept }], // Why was the charged service rendered?
"service" : [{ Reference(DiagnosticReport|ImagingStudy|Immunization|
MedicationAdministration|MedicationDispense|Observation|Procedure|
SupplyDelivery) }], // Which rendered service is being charged?
"account" : [{ Reference(Account) }], // Account to place this charge
"note" : [{ Annotation }], // Comments made about the ChargeItem
"supportingInformation" : [{ Reference(Any) }] // Further information supporting the this charge
}
ChargeItem Search Parameters
The following search parameters can be used to query ChargeItem resources. Just submit them like so:
https://api.1up.health/fhir/stu3/ChargeItem?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
account | reference | account |
code | text | code |
context | reference | context |
entered-date | date | enteredDate |
enterer | reference | enterer |
factor-override | number | factorOverride |
identifier | text | identifier |
occurrence | date | occurrence |
participant-actor | reference | participant.actor |
participant-role | text | participant.role |
patient | reference | subject |
performing-organization | reference | performingOrganization |
price-override | quantity | priceOverride |
quantity | quantity | quantity |
requesting-organization | reference | requestingOrganization |
service | reference | service |
subject | reference | subject |
