Home
API reference
FHIR® API
FHIR® resources
ChargeItem
$charge-item-create

ChargeItem $charge-item-create

post/ChargeItem/$charge-item-create
Page View

This resource contains billing or financial information related to a patient record.

A charge item is a billing charge, procedure, or associated financial information that should be recorded in a healthcare organization’s EHR system. These are a crucial part of maintaining the administrative and financial details associated with patient records.

This is different from a Claim resource in that a ChargeItem is sent directly to a provider, while a Claim is for requesting reimbursement from a payer.

You can only create a new charge item.

$charge-item-create

Create a new charge item in a healthcare organization’s EHR system.

This operation is commonly used for posting charges for services rendered, medical procedures performed, or supplies used during patient care.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/ChargeItem/$charge-item-create' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
  "resourceType": "Bundle",
7
  "id": "RedoxChargeItemCreateBundleExample",
8
  "type": "message",
9
  "timestamp": "2021-06-17T20:33:22.422Z",
10
  "entry": [
11
    {
12
      "resource": {
13
        "resourceType": "MessageHeader",
14
        "id": "RedoxChargeItemCreateMessageHeaderExample",
15
        "source": {
16
          "name": "Good Health Clinics",
17
          "endpoint": "urn:uuid:05107c08-fe2f-4740-8c1d-c7107d18ebe5"
18
        },
19
        "eventUri": "https://fhir.redoxengine.com/EventDefinition/ChargeItemCreate",
20
        "focus": [
21
          {
22
            "reference": "ChargeItem/RedoxChargeItemCreateChargeItemExample"
23
          }
24
        ]
25
      }
26
    },
27
    {
28
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/ChargeItem/RedoxChargeItemCreateChargeItemExample",
29
      "resource": {
30
        "resourceType": "ChargeItem",
31
        "id": "RedoxChargeItemCreateChargeItemExample",
32
        "identifier": [
33
          {
34
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
35
            "value": "6547891230"
36
          }
37
        ],
38
        "status": "billable",
39
        "code": {
40
          "coding": [
41
            {
42
              "code": "99213",
43
              "display": "Office or other outpatient visit for the evaluation and management of an established patient",
44
              "system": "http://www.ama-assn.org/go/cpt"
45
            }
46
          ]
47
        },
48
        "subject": {
49
          "reference": "Patient/RedoxPatientExampleTimothy"
50
        },
51
        "context": {
52
          "reference": "Encounter/RedoxEncounterExample"
53
        },
54
        "occurrenceDateTime": "2022-08-04T14:51:23Z",
55
        "performer": [
56
          {
57
            "actor": {
58
              "reference": "Practitioner/RedoxPractitionerExampleJoan"
59
            },
60
            "function": {
61
              "coding": [
62
                {
63
                  "code": "7561000",
64
                  "display": "Cardiologist",
65
                  "system": "http://snomed.info/sct"
66
                }
67
              ]
68
            }
69
          }
70
        ]
71
      }
72
    },
73
    {
74
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient/RedoxPatientExampleTimothy",
75
      "resource": {
76
        "resourceType": "Patient",
77
        "id": "RedoxPatientExampleTimothy",
78
        "meta": {
79
          "extension": [
80
            {
81
              "url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
82
              "valueInteger": 1
83
            }
84
          ]
85
        },
86
        "extension": [
87
          {
88
            "extension": [
89
              {
90
                "url": "text",
91
                "valueString": "White"
92
              }
93
            ],
94
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
95
          },
96
          {
97
            "extension": [
98
              {
99
                "url": "ombCategory",
100
                "valueCoding": {
101
                  "code": "2135-2",
102
                  "system": "urn:oid:2.16.840.1.113883.6.238",
103
                  "display": "Hispanic or Latino"
104
                }
105
              },
106
              {
107
                "url": "text",
108
                "valueString": "Hispanic"
109
              }
110
            ],
111
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
112
          }
113
        ],
114
        "identifier": [
115
          {
116
            "value": "0000000001",
117
            "system": "urn:redox:health-one:MR"
118
          },
119
          {
120
            "value": "101-01-0001",
121
            "system": "http://hl7.org/fhir/sid/us-ssn"
122
          }
123
        ],
124
        "name": [
125
          {
126
            "given": [
127
              "Timothy",
128
              "Paul"
129
            ],
130
            "family": "Bixby",
131
            "use": "official"
132
          },
133
          {
134
            "text": "Billy",
135
            "use": "usual"
136
          }
137
        ],
138
        "gender": "male",
139
        "birthDate": "2008-01-06",
140
        "telecom": [
141
          {
142
            "value": "+18088675301",
143
            "system": "phone",
144
            "use": "home"
145
          },
146
          {
147
            "value": "+18008675309",
148
            "system": "phone",
149
            "use": "work"
150
          },
151
          {
152
            "value": "timothy.bixby@redoxengine.com",
153
            "system": "email"
154
          }
155
        ],
156
        "address": [
157
          {
158
            "line": [
159
              "4762 Hickory Street"
160
            ],
161
            "city": "Monroe",
162
            "district": "Greene",
163
            "state": "WI",
164
            "postalCode": "53566",
165
            "country": "US",
166
            "use": "home"
167
          }
168
        ],
169
        "maritalStatus": {
170
          "coding": [
171
            {
172
              "code": "M",
173
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
174
              "display": "Married"
175
            }
176
          ],
177
          "text": "Married"
178
        },
179
        "communication": [
180
          {
181
            "language": {
182
              "coding": [
183
                {
184
                  "code": "en",
185
                  "system": "urn:ietf:bcp:47"
186
                }
187
              ],
188
              "text": "English"
189
            }
190
          }
191
        ],
192
        "contact": [
193
          {
194
            "name": {
195
              "given": [
196
                "Barbara"
197
              ],
198
              "family": "Bixby"
199
            },
200
            "telecom": [
201
              {
202
                "value": "+18088675303",
203
                "system": "phone",
204
                "use": "home"
205
              },
206
              {
207
                "value": "barbara.bixby@redoxengine.com",
208
                "system": "email"
209
              }
210
            ],
211
            "address": {
212
              "line": [
213
                "4762 Hickory St."
214
              ],
215
              "city": "Monroe",
216
              "district": "Green",
217
              "state": "WI",
218
              "postalCode": "53566",
219
              "country": "USA"
220
            },
221
            "relationship": [
222
              {
223
                "coding": [
224
                  {
225
                    "code": "MTH",
226
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
227
                    "display": "mother"
228
                  }
229
                ],
230
                "text": "Mother"
231
              },
232
              {
233
                "coding": [
234
                  {
235
                    "code": "C",
236
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
237
                    "display": "Emergency Contact"
238
                  }
239
                ],
240
                "text": "Emergency Contact"
241
              }
242
            ]
243
          }
244
        ],
245
        "generalPractitioner": [
246
          {
247
            "reference": "Practitioner/RedoxPractitionerExamplePat"
248
          }
249
        ],
250
        "managingOrganization": {
251
          "reference": "Organization/RedoxOrganizationManagingExample"
252
        }
253
      }
254
    },
255
    {
256
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter/RedoxEncounterExample",
257
      "resource": {
258
        "resourceType": "Encounter",
259
        "id": "RedoxEncounterExample",
260
        "identifier": [
261
          {
262
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
263
            "value": "9601346482"
264
          }
265
        ],
266
        "status": "finished",
267
        "class": {
268
          "code": "IMP",
269
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
270
          "display": "inpatient encounter"
271
        },
272
        "type": [
273
          {
274
            "coding": [
275
              {
276
                "code": "99222",
277
                "system": "http://www.ama-assn.org/go/cpt",
278
                "display": "InPatient Admission"
279
              }
280
            ]
281
          }
282
        ],
283
        "diagnosis": [
284
          {
285
            "condition": {
286
              "reference": "Condition/RedoxConditionExampleEncounterDx"
287
            }
288
          }
289
        ],
290
        "participant": [
291
          {
292
            "individual": {
293
              "reference": "Practitioner/RedoxPractitionerExampleEncounter"
294
            }
295
          }
296
        ],
297
        "location": [
298
          {
299
            "location": {
300
              "reference": "Location/RedoxLocationExampleEncounter"
301
            }
302
          }
303
        ],
304
        "subject": {
305
          "reference": "Patient/RedoxPatientExampleTimothy"
306
        },
307
        "period": {
308
          "start": "2022-02-06T04:00:00.000Z",
309
          "end": "2022-02-06T04:15:00.000Z"
310
        },
311
        "length": {
312
          "value": 16,
313
          "code": "m",
314
          "system": "http://unitsofmeasure.org"
315
        },
316
        "reasonCode": [
317
          {
318
            "coding": [
319
              {
320
                "code": "23360407",
321
                "system": "http://snomed.info/sct"
322
              }
323
            ],
324
            "text": "Pneumonia"
325
          }
326
        ]
327
      }
328
    },
329
    {
330
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationManagingExample",
331
      "resource": {
332
        "resourceType": "Organization",
333
        "id": "RedoxOrganizationManagingExample",
334
        "identifier": [
335
          {
336
            "value": "1234",
337
            "system": "urn:oid:1.2.3.4"
338
          }
339
        ],
340
        "active": true,
341
        "name": "Custodial Org",
342
        "address": [
343
          {
344
            "line": [
345
              "123 Main St"
346
            ],
347
            "city": "Madison",
348
            "state": "WI"
349
          }
350
        ],
351
        "telecom": [
352
          {
353
            "value": "1-800-123-4567",
354
            "system": "phone"
355
          }
356
        ],
357
        "type": [
358
          {
359
            "text": "Test Type"
360
          }
361
        ]
362
      }
363
    }
364
  ],
365
  "Meta": {
366
    "Logs": [
367
      {
368
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
369
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
370
      }
371
    ],
372
    "Test": true,
373
    "EventDateTime": "2025-11-07T23:14:53.135Z",
374
    "Source": {
375
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
376
      "Name": "Redox Dev Tools"
377
    },
378
    "Destinations": [
379
      {
380
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
381
        "Name": "Redox EMR"
382
      }
383
    ],
384
    "DataModel": "FHIR.ChargeItem",
385
    "EventType": "$charge-item-create"
386
  }
387
}'

Request Body Schema

    Bundle sent as part of a ChargeItem-create message

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a message

    Value: message
  • entry
    required, Array of messageHeader, patient, chargeItem, insurance

    Charge items are typically associated with encounters, patients, and various clinical resources.

    An array of FHIR resources. At a minimum, a ChargeItem should include the following entries:

    • Patient - the patient
    • ChargeItem - the charge item

      An entry in the bundle containing a FHIR resource

    • resource
      required, object

      Additional metadata about the message including the event

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MessageHeader
      • source
        required, object

        Information about the sender of the message and the Bundle content.

        • endpoint
          required, string

          Identifies the routing target to send acknowledgements to.

        • name
          string

          Human-readable name for the source system.

      • focus
        required, Array of object

        This describes the focal target resource of the message from which the remainder of the content is referenced from

        Must be a resource of type ChargeItem.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • eventUri
        required, string

        This describes the message being communicated

  • timestamp
    string

    The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Response fields and example

Example
json
1
"Operation Response"