ChargeItem
- Overview
- Terminology Bindings
- Extensions
- Search
- Retrieve by id
- Operation: charge-item-credit
- Operation: charge-item-modify
- Operation: charge-item-create
Overview
The ChargeItem resource describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. The main usage of the ChargeItem is to enable the billing process and internal cost allocation.
The following fields are returned if valued:
- ChargeItem id
- Status
- Code
- Subject
- Context
- Occurrence
- Performer
- Requesting Organization
- Quantity
- Enterer
- Entered Date
- Reason
- Account
- Supporting Information
- Extensions including bill code schedule, custom attribute, description, modifier code, national drug product, net price, offset by, performing location, procedure code, quantity conversion factor, replacing, revenue code, and unit price
Terminology Bindings
Chargeitem.code |
|
Chargeitem.reason |
|
Chargeitem.extension[x].extension[x].valueCodeableConcept |
|
Chargeitem.extension[x].extension[x].valueCodeableConcept |
|
Chargeitem.extension[x].valueCodeableConcept |
|
Chargeitem.code.coding.extension[x].valueCoding |
|
Chargeitem.reason.coding.extension[x].valueCoding |
|
Chargeitem.extension[x].extension[x].valueCodeableConcept.coding.extension[x].valueCoding |
|
Chargeitem.extension[x].valueMoney.currency |
|
Chargeitem.extension[x].extension[x].valueCodeableConcept |
|
Chargeitem.extension[x].extension[x].valueQuantity |
|
Chargeitem.performer.function |
|
Extensions
- Bill Code Schedule
- Custom Attribute
- Description
- Modifier Code
- National Drug Product
- Net Price
- Offset By
- Performing Location
- Priority
- Procedure Code
- Quantity Conversion Factor
- Replacing
- Revenue Code
- Unit Price
Custom Extensions
All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/r4/StructureDefinition/{id}
ID | Value[x] Type | Description |
---|---|---|
bill-code-schedule |
coding |
A defined group of bill codes that drives billing behavior. |
custom-attribute |
None (contains nested extensions) | A client defined custom attribute for the resource. Attribute values can be of type integer , string , decimal , or dateTime . |
description |
string |
A description providing additional details of the resource. |
modifier-code |
None (contains nested extensions) | A code providing additional detail about a product or service. |
national-drug-product |
None (contains nested extensions) | The national drug product used in care. |
net-price |
Money |
The quantity times the unit price for a resource (total price). |
offset-by |
Reference |
Indicates a resource that this resource is offset by. This resource is no longer active when offset. |
performing-location |
Reference |
A location where the resource was performed. |
priority |
unsignedInt |
The priority of the element within a list. |
procedure-code |
None (contains nested extensions) | A code providing information about the procedure performed on the patient associated to the resource. |
quantity-conversion-factor |
decimal |
The conversion factor used to calculate the quantity for billing. |
replacing |
Reference |
A reference to a resource that this resource is replacing. |
revenue-code |
None (contains nested extensions) | The type of revenue or cost center providing the product and/or service. |
unit-price |
Money |
The price of a single unit for the resource. |
Search
Search for ChargeItems that meet supplied query parameters:
GET /ChargeItem?:parameters
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
This or context or account | token |
The logical resource id associated with the ChargeItem. |
context |
This or _id or account | reference |
Encounter associated with the ChargeItem. |
account |
This or _id or context | reference |
Account associated with the ChargeItem. |
-status |
See notes | token |
The status of the ChargeItem. Example: billable
|
_count |
No | number |
The maximum number of results to return. |
Notes:
- When searching by
_id
, only a single ChargeItem id can be provided. -
-status
must be provided withcontext
oraccount
. -
-status
must be set tobillable
. -
context
must reference an Encounter. - Only charge-group
account
types are supported.
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ChargeItem?context=97953601&-status=billable
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "0f2ae629-4e99-4843-a200-406dffce7091",
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ChargeItem?context=97953601&-status=billable"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ChargeItem/292870306",
"resource": {
"resourceType": "ChargeItem",
"id": "292870306",
"meta": {
"versionId": "1",
"lastUpdated": "2020-03-09T17:23:00Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Charge Item</b></p><p><b>Status</b>: Billable</p><p><b>Patient</b>: 12742419</p><p><b>Encounter</b>: 97953601</p><p><b>Code</b>: 64897</p><p><b>Occurrence</b>: Mar 6, 2020 6:22 P.M. UTC</p></div>"
},
"extension": [
{
"valueMoney": {
"value": 100,
"currency": "USD"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/unit-price"
},
{
"valueMoney": {
"value": 800,
"currency": "USD"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/net-price"
},
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/ndc",
"code": "1111-1111-111"
}
]
},
"url": "national-drug-product-code"
},
{
"valueQuantity": {
"value": 2.0,
"unit": "milligram (mass)",
"system": "http://unitsofmeasure.org",
"code": "mg"
},
"url": "national-drug-product-quantity"
},
{
"valueDecimal": 2,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/quantity-conversion-factor"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/national-drug-product"
},
{
"valueString": "Acetaminophen Level",
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/description"
},
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "615214"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-CPT",
"code": "10081"
}
]
},
"url": "code"
},
{
"valueUnsignedInt": 1,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/procedure-code"
},
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "615215"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-HCPCS",
"code": "A0130"
}
]
},
"url": "code"
},
{
"valueUnsignedInt": 1,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/procedure-code"
},
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "3692"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-MODIFIER",
"code": "66"
}
]
},
"url": "code"
},
{
"valueUnsignedInt": 1,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/modifier-code"
},
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "615217"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-REVENUE",
"code": "0024"
}
]
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/revenue-code"
}
],
"status": "billable",
"code": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "667687"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-CDM_SCHED",
"code": "64897"
}
]
},
"subject": {
"reference": "Patient/12742419"
},
"context": {
"reference": "Encounter/97953601"
},
"occurrenceDateTime": "2020-03-06T18:22:16Z",
"performer": [
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0912",
"code": "OP",
"display": "Ordering Provider"
}
],
"text": "Ordering Provider"
},
"actor": {
"reference": "Practitioner/11817978"
}
}
],
"requestingOrganization": {
"reference": "Organization/1054423"
},
"quantity": {
"value": 8
},
"enterer": {
"reference": "Practitioner/12742359"
},
"enteredDate": "2020-03-09T17:22:57Z",
"account": [
{
"reference": "Account/F61853062"
},
{
"reference": "Account/C98900463"
}
]
}
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Retrieve by id
List an individual ChargeItem by its id:
GET /ChargeItem/:id
Authorization Types
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ChargeItem/321088041
Response
Status: 200 OK
{
"resourceType": "ChargeItem",
"id": "321088041",
"meta": {
"versionId": "1",
"lastUpdated": "2022-01-21T14:15:11Z"
},
"text": {
"status": "generated",
"div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Charge Item</b></p><p><b>Status</b>: Billable</p><p><b>Patient</b>: 12768550</p><p><b>Encounter</b>: 97965088</p><p><b>Code</b>: 1010222</p><p><b>Occurrence</b>: Jan 21, 2022 1:54 P.M. UTC</p></div>"
},
"extension": [
{
"valueMoney": {
"value": 1,
"currency": "USD"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/unit-price"
},
{
"valueMoney": {
"value": 1,
"currency": "USD"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/net-price"
},
{
"valueReference": {
"reference": "ChargeItem/321088013"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/replacing"
},
{
"valueReference": {
"reference": "Location/2572643903",
"display": "CITY-NU02"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/performing-location"
},
{
"valueString": "Blood Culture",
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/description"
},
{
"extension": [
{
"id": "2572130057",
"valueString": "Service Connected",
"url": "custom-attribute-name"
},
{
"valueInteger": 1,
"url": "custom-attribute-value"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
},
{
"extension": [
{
"id": "2572130093",
"valueString": "Special Authority",
"url": "custom-attribute-name"
},
{
"valueInteger": 0,
"url": "custom-attribute-value"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
},
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "615214"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-CPT",
"code": "87075"
}
]
},
"url": "code"
},
{
"valueUnsignedInt": 1,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/procedure-code"
},
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "3692"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-MODIFIER",
"code": "32"
}
]
},
"url": "code"
},
{
"valueUnsignedInt": 1,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/modifier-code"
},
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "615216"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-PROCCODE",
"code": "0N2"
}
]
},
"url": "code"
},
{
"valueUnsignedInt": 1,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/procedure-code"
},
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "615217"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-REVENUE",
"code": "0302"
}
]
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/revenue-code"
}
],
"status": "billable",
"code": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "667687"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-CDM_SCHED",
"code": "1010222"
}
]
},
"subject": {
"reference": "Patient/12768550"
},
"context": {
"reference": "Encounter/97965088"
},
"occurrenceDateTime": "2022-01-21T13:54:00Z",
"performer": [
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0912",
"code": "OP",
"display": "Ordering Provider"
}
],
"text": "Ordering Provider"
},
"actor": {
"reference": "Practitioner/639925"
}
},
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "VRF",
"display": "verifier"
}
],
"text": "verifier"
},
"actor": {
"reference": "Practitioner/1293126"
}
}
],
"requestingOrganization": {
"reference": "Organization/675844"
},
"quantity": {
"value": 1
},
"enterer": {
"reference": "Practitioner/12754008"
},
"enteredDate": "2022-01-21T14:02:16Z",
"reason": [
{
"extension": [
{
"valueUnsignedInt": 1,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "3693"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-ICD",
"code": "R51"
}
]
},
{
"extension": [
{
"valueUnsignedInt": 2,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "3693"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-ICD",
"code": "Y92.321"
}
]
}
],
"account": [
{
"reference": "Account/F61865237"
},
{
"reference": "Account/C101453424"
},
{
"reference": "Account/C101453425"
}
],
"supportingInformation": [
{
"reference": "ServiceRequest/345980373"
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Operation: charge-item-credit
Creates an offsetting ChargeItem for an existing debit ChargeItem.
POST /ChargeItem/:id/$credit
Implementation Notes
- Only the body fields mentioned below are supported. Unsupported fields will be ignored.
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Accept: application/fhir+json
Content-Type: application/fhir+json
Body Fields
Name | Required | Type | |
---|---|---|---|
resourceType
|
Yes |
string |
|
|
|||
parameter
|
Yes |
List of BackboneElement |
|
|
|||
versionId
|
Yes |
id |
|
|
|||
subject
|
Yes |
Reference (Patient ) |
|
|
|||
context
|
Yes |
Reference (Encounter ) |
|
|
|||
transactionId
|
Yes |
uuid |
|
|
Example
Request
POST https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ChargeItem/292427912/$credit
Body
{
"resourceType": "Parameters",
"parameter": [
{
"name": "versionId",
"valueId": "2"
},
{
"name": "transactionId",
"valueUuid": "urn:uuid:5bb8acae-0c7d-11ec-82a8-0242ac130003"
},
{
"name": "subject",
"valueReference": {
"reference": "Patient/12782842"
}
},
{
"name": "context",
"valueReference": {
"reference": "Encounter/98019577"
}
}
]
}
Response
Status: 201 Created
Cache-Control: no-cache Content-Length: 0 Content-Type: text/html Date: Tue, 07 Sep 2021 17:23:14 GMT Etag: W/"0" Location: https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ChargeItem/2180632343 Last-Modified: Tue, 07 Sep 2021 17:25:14 GMT Vary: Origin X-Request-Id: 11111111111111111111111111111111
The ETag
response header indicates the current If-Match
version to use on subsequent updates.
Errors
The common errors and OperationOutcomes may be returned.
Operation: charge-item-modify
Modifies an existing ChargeItem resulting in a newly created ChargeItem.
POST /ChargeItem/$modify
Implementation Notes
- Only the body fields mentioned below are supported.
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Content-Type: application/fhir+json
Body Fields
Name | Required | Type | |
---|---|---|---|
resourceType
|
Yes |
string |
|
|
|||
parameter
|
Yes |
List of BackboneElement |
|
|
|||
transactionId
|
Yes |
uuid |
|
|
|||
chargeItem
|
Yes |
resource |
|
|
|||
status
|
Yes |
code |
|
|
|||
subject
|
Yes |
Reference |
|
|
|||
context
|
Yes |
Reference |
|
|
|||
occurrenceDateTime
|
No |
dateTime |
|
|
|||
quantity
|
No |
Quantity |
|
|
|||
code
|
Yes |
CodeableConcept |
|
|
|||
performer
|
No |
List of BackboneElement |
|
|
|||
reason
|
No |
CodeableConcept |
|
|
|||
replacing
|
Yes |
Extension |
|
|
|||
performing-location
|
No |
Extension |
|
|
|||
description
|
No |
Extension |
|
|
|||
custom-attribute
|
No |
Extension |
|
|
|||
modifier-code
|
No |
Extension |
|
|
|||
procedure-code
|
No |
Extension |
|
|
|||
revenue-code
|
No |
Extension |
|
|
Example
Request
POST https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ChargeItem/$modify
Body
{
"resourceType": "Parameters",
"parameter": [
{
"name": "chargeItem",
"resource": {
"resourceType": "ChargeItem",
"status": "unknown",
"subject": {
"reference": "Patient/12768550"
},
"context": {
"reference": "Encounter/97965088"
},
"occurrenceDateTime": "2021-01-08T10:38:00Z",
"quantity": {
"value": 31
},
"code": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "667687"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-CDM_SCHED",
"code": "64897"
}
]
},
"performer": [
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0912",
"code": "OP",
"display": "Ordering Provider"
}
],
"text": "Ordering Provider"
},
"actor": {
"reference": "Practitioner/11817978"
}
}
],
"reason": [
{
"extension": [
{
"valueUnsignedInt": 1,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "3693"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-ICD",
"code": "0023"
}
]
}
],
"extension": [
{
"extension": [
{
"valueId": "1",
"url": "item-version"
}
],
"valueReference": {
"reference": "ChargeItem/317370800"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/replacing"
},
{
"valueReference": {
"reference": "Location/2170691494",
"display": "RCR Analytics"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/performing-location"
},
{
"valueString": "Acetaminophen Level",
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/description"
},
{
"extension": [
{
"id": "17433932",
"valueString": "Line Note Text",
"url": "custom-attribute-name"
},
{
"valueString": "Raghu, P",
"url": "custom-attribute-value"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
},
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "3692"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-MODIFIER",
"code": "66"
}
]
},
"url": "code"
},
{
"valueUnsignedInt": 1,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/modifier-code"
},
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "615214"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-CPT",
"code": "10081"
}
]
},
"url": "code"
},
{
"valueUnsignedInt": 1,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/procedure-code"
},
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "615217"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-REVENUE",
"code": "0024"
}
]
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/revenue-code"
}
]
}
},
{
"name": "transactionId",
"valueUuid": "urn:uuid:5825e8ea-3b47-11ec-8d3d-0242ac130003"
}
]
}
Response
Status: 201 Created
Cache-Control: no-cache Content-Length: 0 Content-Type: text/html Date: Fri, 16 Jul 2021 17:23:14 GMT Etag: W/"0" Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ChargeItem/2180632343 Last-Modified: Fri, 16 Jul 2021 17:23:13 GMT Vary: Origin X-Request-Id: 11111111111111111111111111111111
The ETag
response header indicates the current If-Match
version to use on subsequent updates.
Errors
The common errors and OperationOutcomes may be returned.
Operation: charge-item-create
Creates a charge event which can result in the creation of one or more ChargeItems.
POST /ChargeItem/:id/$create
Implementation Notes
- Only the body fields mentioned below are supported.
Authorization Types
Headers
Authorization: <OAuth2 Bearer Token>
Accept: application/fhir+json
Content-Type: application/fhir+json
Body Fields
Name | Required | Type | |
---|---|---|---|
resourceType
|
Yes |
string |
|
|
|||
parameter
|
Yes |
List of BackboneElement |
|
|
|||
transactionId
|
Yes |
uuid |
|
|
|||
chargeItem
|
Yes |
resource |
|
|
|||
status
|
Yes |
code |
|
|
|||
subject
|
Yes |
Reference |
|
|
|||
context
|
Yes |
Reference |
|
|
|||
occurrenceDateTime
|
Yes |
dateTime |
|
|
|||
quantity
|
Yes |
Quantity |
|
|
|||
code
|
Yes |
CodeableConcept |
|
|
|||
performer
|
No |
List of BackboneElement |
|
|
|||
reason
|
No |
CodeableConcept |
|
|
|||
performing-location
|
No |
Extension |
|
|
|||
custom-attribute
|
No |
Extension |
|
|
|||
modifier-code
|
No |
Extension |
|
|
|||
procedure-code
|
No |
Extension |
|
|
|||
revenue-code
|
No |
Extension |
|
|
Example
Request
POST https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ChargeItem/$create
Body
{
"resourceType": "Parameters",
"parameter": [
{
"name": "chargeItem",
"resource": {
"resourceType": "ChargeItem",
"status": "unknown",
"subject": {
"reference": "Patient/12742419"
},
"context": {
"reference": "Encounter/97953601"
},
"occurrenceDateTime": "2021-08-02T21:53:34Z",
"quantity": {
"value": 1
},
"code": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "667687"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-CDM_SCHED",
"code": "01012021"
}
]
},
"performer": [
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0912",
"code": "OP",
"display": "Ordering Provider"
}
],
"text": "Ordering Provider"
},
"actor": {
"reference": "Practitioner/11817978"
}
}
],
"reason": [
{
"extension": [
{
"valueUnsignedInt": 1,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "3693"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-ICD",
"code": "Z00"
}
]
}
],
"extension": [
{
"valueReference": {
"reference": "Location/31103071",
"display": "1 West SA2"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/performing-location"
},
{
"extension": [
{
"id": "68985657",
"valueString": "Family Planning Indicator",
"url": "custom-attribute-name"
},
{
"valueInteger": 68,
"url": "custom-attribute-value"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute"
},
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "3692"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-MODIFIER",
"code": "26"
}
]
},
"url": "code"
},
{
"valueUnsignedInt": 1,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/modifier-code"
},
{
"extension": [
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "615216"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-CPT",
"code": "GZ1"
}
]
},
"url": "code"
},
{
"valueUnsignedInt": 1,
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
}
],
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/procedure-code"
},
{
"valueCodeableConcept": {
"coding": [
{
"extension": [
{
"valueCoding": {
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002",
"code": "615217"
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule"
}
],
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-REVENUE",
"code": "0900"
}
]
},
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/revenue-code"
}
]
}
},
{
"name": "transactionId",
"valueUuid": "urn:uuid:9befb168-g01f-4336-9547-5d26f0100058"
}
]
}
Response
Status: 200 OK
Cache-Control: no-cache Content-Length: 0 Content-Type: text/html Date: Thu, 11 Nov 2021 17:23:14 GMT Etag: W/"0" Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ChargeItem/$create Last-Modified: Thu, 11 Nov 2021 17:25:14 GMT Vary: Origin X-Request-Id: 11111111111111111111111111111111
The ETag
response header indicates the current If-Match
version to use on subsequent updates.
Errors
The common errors and OperationOutcomes may be returned.