Jump to

• Request
• Response

Create a charge item

post

/ChargeItem/$create

Creates a charge event, which can result in the creation of one or more charge items.

Note: Only the body fields mentioned below are supported.

Authorization Types

This operation supports the following authorization types:

• Provider
• System

Request

Supported Media Types

• application/fhir+json

Header Parameters

• accept(required): string
  The media type to be requested. See what the resource's operation produces for what is supported.
• authorization(required): string
  Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

Body ()

Root Schema : ChargeItemCreateBody

Type: object

Show Source

• code(required): object code
  The primary billing code that identifies the charge.
  Note:

  • The coding field must contain only one coding from the CDM_SCHED, CPT, HCPCS, or PROCCODE proprietary Bill Codes Types systems.
  • The Bill Code Type provided in code must be the highest tier of all of the Bill Code Types associated with the charge item.
  • Tiering logic from highest to lowest: CDM_SCHED, CPT, HCPCS, or PROCCODE.

  Example:

  {
    "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"
        }
      ]
    }
  }
  
  

• context(required): object context
  The encounter associated with the charge.
  Note: Must be an Encounter reference.
  Example:

  {
    "context": {
      "reference": "Encounter/97953601"
    }
  }
  
  

• custom-attribute:
  A client-defined custom attribute for the charge.
  Note:

  • custom-attribute-name and custom-attribute-value are both required.
  • id and valueString for custom-attribute-name are required.
  • custom-attribute-value can be of type integer, string, decimal, or dateTime.

  Example:

  {
    "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"
  }
  
  

• modifier-code:
  A code providing additional details about a product or service.
  Note:

  • The coding field must contain only one coding from the MODIFIER proprietary Bill Codes Types system.
  • Both code and priority subextensions are required.

  Example:

  {
    "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"
  }
  
  

• occurrenceDateTime(required): string
  The date and time when the charged service was applied.
  Example:

  {
    "occurrenceDateTime": "2021-08-02T21:53:34Z"
  }
  
  

• parameter(required):
  The parameters defined by the operation.
• performer:
  Who performed or participated in the charge.
  Note:

  • The value must be in the form of CodeableConcept.
  • Must contain both the actor and function subfields.
  • The value of actor must be in the form of valueReference.
  • Only the following system and code combinations may be used in the performer function coding
  • http://terminology.hl7.org/CodeSystem/v2-0912 - OP
  • http://terminology.hl7.org/CodeSystem/v3 - PRF
  • http://terminology.hl7.org/CodeSystem/v3 - VRF

  Example:

  {
    "performer": [
      {
        "function": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v2-0912",
              "code": "OP",
              "display": "Ordering Provider"
            }
          ],
          "text": "Ordering Provider"
        },
        "actor": {
          "reference": "Practitioner/11817978"
        }
      }
    ]
  }
  
  

• performing-location:
  A location where the charge was performed.
  Note: Must be a Location reference.
  Example:

  {
    "valueReference": {
      "reference": "Location/683731",
      "display": "SA"
    },
    "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/performing-location"
  }
  
  

• procedure-code:
  A code providing information about the procedure performed on the patient associated with the resource.
  Note:

  • The coding field must contain only one coding from the CPT, HCPCS, or PROCCODE proprietary Bill Codes Types systems.
  • Must be of a lower bill code tier than the ChargeItem.code field if provided.
  • Both code and priority subextensions are required.

  Example:

  {
    "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": "99204"
            }
          ]
        },
        "url": "code"
      },
      {
        "valueUnsignedInt": 1,
        "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/priority"
      }
    ],
    "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/procedure-code"
  }
  
  

• quantity(required): object quantity
  The quantity of which the charge item has been serviced.
  Example:

  {
    "quantity": {
      "value": 1
    }
  }
  
  

• reason: object reason
  The dagnosis codes for why the charge was rendered.
  Note: The coding field must contain only one coding from the ICD proprietary Bill Codes Types systems.
  Example:

  {
    "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"
          }
        ]
      }
    ]
  }
  
  

• resourceType(required): string
  The type of the FHIR resource.
  Note:

  • resourceType must be Parameters for the parent object.
  • Must be chargeItem for the resource object.

  Example:

  {
    "resourceType": "Parameters",
    "parameter": [
      {
        "name": "chargeItem",
        "resource": {
          "resourceType": "ChargeItem"
        }
      }
    ]
  }
  

• revenue-code:
  The type of revenue or cost center providing the product, service, or both.
  Note: The coding field must contain only one coding from the REVENUE proprietary Bill Codes Types system.
  Example:

  {
    "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"
  }
  
  

• status(required): string
  The current state of the charge.
  Note: The status must be set to unknown.
  Example:

  {
    "status": "unknown"
  }
  
  

• subject(required): object subject
  The patient associated with the charge.
  Note: Must be a Patient reference.
  Example:

  {
    "subject": {
      "reference": "Patient/12742419"
    }
  }
  
  

• transactionId(required): string
  A UUID to uniquely identify the create operation.
  Note:

  • The value must be in the form of valueUuid.
  • Only one transactionId parameter may be provided.

  Example:

  {
    "parameter": [
      {
        "name": "transactionId",
        "valueUuid": "urn:uuid:aa7623a0-0c7b-11ec-82a8-0242ac130003"
      }
    ]
  }
  
  

{
    "type":"object",
    "required":[
        "resourceType",
        "parameter",
        "transactionId",
        "chargeItem",
        "status",
        "subject",
        "context",
        "occurrenceDateTime",
        "quantity",
        "code"
    ],
    "properties":{
        "resourceType":{
            "description":"The type of the FHIR resource.<br>\n\n<b>Note:</b>\n<ul>\n<li><code>resourceType</code> must be <code>Parameters</code> for the parent object.</li>\n<li>Must be <code>chargeItem</code> for the resource object.</li>\n</ul>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"resourceType\": \"Parameters\",\n  \"parameter\": [\n    {\n      \"name\": \"chargeItem\",\n      \"resource\": {\n        \"resourceType\": \"ChargeItem\"\n      }\n    }\n  ]\n}\n</pre></code>\n",
            "type":"string"
        },
        "parameter":{
            "description":"The parameters defined by the operation."
        },
        "transactionId":{
            "description":"A UUID to uniquely identify the create operation.<br>\n\n<b>Note:</b>\n<ul>\n  <li>The value must be in the form of <code>valueUuid</code>.</li>\n  <li>Only one <code>transactionId</code> parameter may be provided.</li>\n</ul>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"parameter\": [\n    {\n      \"name\": \"transactionId\",\n      \"valueUuid\": \"urn:uuid:aa7623a0-0c7b-11ec-82a8-0242ac130003\"\n    }\n  ]\n}\n\n</pre></code>\n",
            "type":"string"
        },
        "status":{
            "description":"The current state of the charge.<br>\n\n<b>Note:</b> The status must be set to <code>unknown</code>.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"status\": \"unknown\"\n}\n\n</pre></code>\n",
            "type":"string"
        },
        "subject":{
            "description":"The patient associated with the charge.<br>\n\n<b>Note:</b> Must be a Patient reference.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"subject\": {\n    \"reference\": \"Patient/12742419\"\n  }\n}\n\n</pre></code>\n",
            "type":"object"
        },
        "context":{
            "description":"The encounter associated with the charge.<br>\n\n<b>Note:</b> Must be an Encounter reference.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"context\": {\n    \"reference\": \"Encounter/97953601\"\n  }\n}\n\n</pre></code>\n",
            "type":"object",
            "properties":{
                "reference":{
                    "type":"string"
                }
            }
        },
        "occurrenceDateTime":{
            "description":"The date and time when the charged service was applied.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"occurrenceDateTime\": \"2021-08-02T21:53:34Z\"\n}\n\n</pre></code>\n",
            "type":"string"
        },
        "quantity":{
            "description":"The quantity of which the charge item has been serviced.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"quantity\": {\n    \"value\": 1\n  }\n}\n\n</pre></code>\n",
            "type":"object",
            "properties":{
                "value":{
                    "type":"number"
                },
                "unit":{
                    "type":"string"
                },
                "system":{
                    "type":"string"
                },
                "code":{
                    "type":"string"
                },
                "comparator":{
                    "type":"string"
                }
            }
        },
        "code":{
            "description":"The primary billing code that identifies the charge.<br>\n\n<b>Note:</b>\n<ul>\n  <li>The coding field must contain only one coding from the CDM_SCHED, CPT, HCPCS, or PROCCODE proprietary Bill Codes Types systems.</li>\n  <li>The Bill Code Type provided in <a target=\"_blank\" href=\"https://hl7.org/fhir/R4/datatypes.html#code\"><code>code</code></a> must be the highest tier of all of the Bill Code Types associated with the charge item.</li>\n  <li>Tiering logic from highest to lowest: CDM_SCHED, CPT, HCPCS, or PROCCODE.</li>\n</ul>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"code\": {\n    \"coding\": [\n      {\n        \"extension\": [\n          {\n            \"valueCoding\": {\n              \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002\",\n              \"code\": \"667687\"\n            },\n            \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule\"\n          }\n        ],\n        \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-CDM_SCHED\",\n        \"code\": \"01012021\"\n      }\n    ]\n  }\n}\n\n</pre></code>\n",
            "type":"object",
            "properties":{
                "text":{
                    "type":"string"
                },
                "coding":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "system":{
                                "type":"string"
                            },
                            "code":{
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "performer":{
            "description":"Who performed or participated in the charge.<br>\n\n<b>Note:</b>\n<ul>\n  <li>The value must be in the form of <a target=\"_blank\" href=\"https://hl7.org/fhir/R4/datatypes.html#CodeableConcept\"><code>CodeableConcept</code></a>.</li>\n  <li>Must contain both the actor and function subfields.</li>\n  <li>The value of actor must be in the form of <code>valueReference</code>.</li>\n  <li>Only the following system and code combinations may be used in the performer function <code>coding</code></li>\n  <ul>\n    <li>http://terminology.hl7.org/CodeSystem/v2-0912 - OP</li>\n    <li>http://terminology.hl7.org/CodeSystem/v3 - PRF</li>\n    <li>http://terminology.hl7.org/CodeSystem/v3 - VRF</li>\n  </ul>\n</ul>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"performer\": [\n    {\n      \"function\": {\n        \"coding\": [\n          {\n            \"system\": \"http://terminology.hl7.org/CodeSystem/v2-0912\",\n            \"code\": \"OP\",\n            \"display\": \"Ordering Provider\"\n          }\n        ],\n        \"text\": \"Ordering Provider\"\n      },\n      \"actor\": {\n        \"reference\": \"Practitioner/11817978\"\n      }\n    }\n  ]\n}\n\n</pre></code>\n"
        },
        "reason":{
            "description":"The dagnosis codes for why the charge was rendered.<br>\n\n<b>Note:</b> The coding field must contain only one coding from the ICD proprietary Bill Codes Types systems.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"reason\": [\n    {\n      \"extension\": [\n        {\n          \"valueUnsignedInt\": 1,\n          \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/priority\"\n        }\n      ],\n      \"coding\": [\n        {\n          \"extension\": [\n            {\n              \"valueCoding\": {\n                \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002\",\n                \"code\": \"3693\"\n              },\n              \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule\"\n            }\n          ],\n          \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-ICD\",\n          \"code\": \"Z00\"\n        }\n      ]\n    }\n  ]\n}\n\n</pre></code>\n",
            "type":"object",
            "properties":{
                "text":{
                    "type":"string"
                },
                "coding":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "system":{
                                "type":"string"
                            },
                            "code":{
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "performing-location":{
            "description":"A location where the charge was performed.<br>\n\n<b>Note:</b> Must be a Location reference.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"valueReference\": {\n    \"reference\": \"Location/683731\",\n    \"display\": \"SA\"\n  },\n  \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/performing-location\"\n}\n\n</pre></code>\n"
        },
        "custom-attribute":{
            "description":"A client-defined custom attribute for the charge.<br>\n\n<b>Note:</b>\n<ul>\n  <li><code>custom-attribute-name</code> and <code>custom-attribute-value</code> are both required.</li>\n  <li><code>id</code> and <code>valueString</code> for <code>custom-attribute-name</code> are required.</li>\n  <li><code>custom-attribute-value</code> can be of type integer, string, decimal, or dateTime.</li>\n</ul>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"extension\": [\n    {\n      \"id\": \"68985657\",\n      \"valueString\": \"Family Planning Indicator\",\n      \"url\": \"custom-attribute-name\"\n    },\n    {\n      \"valueInteger\": 68,\n      \"url\": \"custom-attribute-value\"\n    }\n  ],\n  \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute\"\n}\n\n</pre></code>\n"
        },
        "modifier-code":{
            "description":"A code providing additional details about a product or service.<br>\n\n<b>Note:</b>\n<ul>\n  <li>The coding field must contain only one coding from the MODIFIER proprietary Bill Codes Types system.</li>\n  <li>Both code and priority subextensions are required.</li>\n</ul>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"extension\": [\n    {\n      \"valueCodeableConcept\": {\n        \"coding\": [\n          {\n            \"extension\": [\n              {\n                \"valueCoding\": {\n                  \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002\",\n                  \"code\": \"3692\"\n                },\n                \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule\"\n              }\n            ],\n            \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-MODIFIER\",\n            \"code\": \"26\"\n          }\n        ]\n      },\n      \"url\": \"code\"\n    },\n    {\n      \"valueUnsignedInt\": 1,\n      \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/priority\"\n    }\n  ],\n  \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/modifier-code\"\n}\n\n</pre></code>\n"
        },
        "procedure-code":{
            "description":"A code providing information about the procedure performed on the patient associated with the resource.<br>\n\n<b>Note:</b>\n<ul>\n  <li>The coding field must contain only one coding from the CPT, HCPCS, or PROCCODE proprietary Bill Codes Types systems.</li>\n  <li>Must be of a lower bill code tier than the <code></code>ChargeItem.code</code> field if provided.</li>\n  <li>Both code and priority subextensions are required.</li>\n</ul>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"extension\": [\n    {\n      \"valueCodeableConcept\": {\n        \"coding\": [\n          {\n            \"extension\": [\n              {\n                \"valueCoding\": {\n                  \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002\",\n                  \"code\": \"615214\"\n                },\n                \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule\"\n              }\n            ],\n            \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-CPT\",\n            \"code\": \"99204\"\n          }\n        ]\n      },\n      \"url\": \"code\"\n    },\n    {\n      \"valueUnsignedInt\": 1,\n      \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/priority\"\n    }\n  ],\n  \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/procedure-code\"\n}\n\n</pre></code>\n"
        },
        "revenue-code":{
            "description":"The type of revenue or cost center providing the product, service, or both.<br>\n\n<b>Note:</b> The coding field must contain only one coding from the REVENUE proprietary Bill Codes Types system.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"valueCodeableConcept\": {\n    \"coding\": [\n      {\n        \"extension\": [\n          {\n            \"valueCoding\": {\n              \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002\",\n              \"code\": \"615217\"\n            },\n            \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule\"\n          }\n        ],\n        \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-REVENUE\",\n        \"code\": \"0900\"\n      }\n    ]\n  },\n  \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/revenue-code\"\n}\n\n</pre></code>\n"
        }
    },
    "example":"{\n  \"resourceType\": \"Parameters\",\n  \"parameter\": [\n    {\n      \"name\": \"chargeItem\",\n      \"resource\": {\n        \"resourceType\": \"ChargeItem\",\n        \"status\": \"unknown\",\n        \"subject\": {\n          \"reference\": \"Patient/12742419\"\n        },\n        \"context\": {\n          \"reference\": \"Encounter/97953601\"\n        },\n        \"occurrenceDateTime\": \"2021-08-02T21:53:34Z\",\n        \"quantity\": {\n          \"value\": 1\n        },\n        \"code\": {\n          \"coding\": [\n            {\n              \"extension\": [\n                {\n                  \"valueCoding\": {\n                    \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002\",\n                    \"code\": \"667687\"\n                  },\n                  \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule\"\n                }\n              ],\n              \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-CDM_SCHED\",\n              \"code\": \"01012021\"\n            }\n          ]\n        },\n        \"performer\": [\n          {\n            \"function\": {\n              \"coding\": [\n                {\n                  \"system\": \"http://terminology.hl7.org/CodeSystem/v2-0912\",\n                  \"code\": \"OP\",\n                  \"display\": \"Ordering Provider\"\n                }\n              ],\n              \"text\": \"Ordering Provider\"\n            },\n            \"actor\": {\n              \"reference\": \"Practitioner/11817978\"\n            }\n          }\n        ],\n        \"reason\": [\n          {\n            \"extension\": [\n              {\n                \"valueUnsignedInt\": 1,\n                \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/priority\"\n              }\n            ],\n            \"coding\": [\n              {\n                \"extension\": [\n                  {\n                    \"valueCoding\": {\n                      \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002\",\n                      \"code\": \"3693\"\n                    },\n                    \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule\"\n                  }\n                ],\n                \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-ICD\",\n                \"code\": \"Z00\"\n              }\n            ]\n          }\n        ],\n        \"extension\": [\n          {\n            \"valueReference\": {\n              \"reference\": \"Location/31103071\",\n              \"display\": \"1 West SA2\"\n            },\n            \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/performing-location\"\n          },\n          {\n            \"extension\": [\n              {\n                \"id\": \"68985657\",\n                \"valueString\": \"Family Planning Indicator\",\n                \"url\": \"custom-attribute-name\"\n              },\n              {\n                \"valueInteger\": 68,\n                \"url\": \"custom-attribute-value\"\n              }\n            ],\n            \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/custom-attribute\"\n          },\n          {\n            \"extension\": [\n              {\n                \"valueCodeableConcept\": {\n                  \"coding\": [\n                    {\n                      \"extension\": [\n                        {\n                          \"valueCoding\": {\n                            \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002\",\n                            \"code\": \"3692\"\n                          },\n                          \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule\"\n                        }\n                      ],\n                      \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-MODIFIER\",\n                      \"code\": \"26\"\n                    }\n                  ]\n                },\n                \"url\": \"code\"\n              },\n              {\n                \"valueUnsignedInt\": 1,\n                \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/priority\"\n              }\n            ],\n            \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/modifier-code\"\n          },\n          {\n            \"extension\": [\n              {\n                \"valueCodeableConcept\": {\n                  \"coding\": [\n                    {\n                      \"extension\": [\n                        {\n                          \"valueCoding\": {\n                            \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002\",\n                            \"code\": \"615216\"\n                          },\n                          \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule\"\n                        }\n                      ],\n                      \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-CPT\",\n                      \"code\": \"GZ1\"\n                    }\n                  ]\n                },\n                \"url\": \"code\"\n              },\n              {\n                \"valueUnsignedInt\": 1,\n                \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/priority\"\n              }\n            ],\n            \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/procedure-code\"\n          },\n          {\n            \"valueCodeableConcept\": {\n              \"coding\": [\n                {\n                  \"extension\": [\n                    {\n                      \"valueCoding\": {\n                        \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002\",\n                        \"code\": \"615217\"\n                      },\n                      \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule\"\n                    }\n                  ],\n                  \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-REVENUE\",\n                  \"code\": \"0900\"\n                }\n              ]\n            },\n            \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/revenue-code\"\n          }\n        ]\n      }\n    },\n    {\n      \"name\": \"transactionId\",\n      \"valueUuid\": \"urn:uuid:9befb168-g01f-4336-9547-5d26f0100058\"\n    }\n  ]\n}\n"
}

Example:

{
  "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"
    }
  ]
}

Nested Schema : code

Type: object

The primary billing code that identifies the charge.
Note:

• The coding field must contain only one coding from the CDM_SCHED, CPT, HCPCS, or PROCCODE proprietary Bill Codes Types systems.
• The Bill Code Type provided in code must be the highest tier of all of the Bill Code Types associated with the charge item.
• Tiering logic from highest to lowest: CDM_SCHED, CPT, HCPCS, or PROCCODE.

Example:

{
  "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"
      }
    ]
  }
}

Show Source

• coding: array coding
• text: string

{
    "description":"The primary billing code that identifies the charge.<br>\n\n<b>Note:</b>\n<ul>\n  <li>The coding field must contain only one coding from the CDM_SCHED, CPT, HCPCS, or PROCCODE proprietary Bill Codes Types systems.</li>\n  <li>The Bill Code Type provided in <a target=\"_blank\" href=\"https://hl7.org/fhir/R4/datatypes.html#code\"><code>code</code></a> must be the highest tier of all of the Bill Code Types associated with the charge item.</li>\n  <li>Tiering logic from highest to lowest: CDM_SCHED, CPT, HCPCS, or PROCCODE.</li>\n</ul>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"code\": {\n    \"coding\": [\n      {\n        \"extension\": [\n          {\n            \"valueCoding\": {\n              \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002\",\n              \"code\": \"667687\"\n            },\n            \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule\"\n          }\n        ],\n        \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-CDM_SCHED\",\n        \"code\": \"01012021\"\n      }\n    ]\n  }\n}\n\n</pre></code>\n",
    "type":"object",
    "properties":{
        "text":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "system":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : context

Type: object

The encounter associated with the charge.
Note: Must be an Encounter reference.
Example:

{
  "context": {
    "reference": "Encounter/97953601"
  }
}

Show Source

• reference: string

{
    "description":"The encounter associated with the charge.<br>\n\n<b>Note:</b> Must be an Encounter reference.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"context\": {\n    \"reference\": \"Encounter/97953601\"\n  }\n}\n\n</pre></code>\n",
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        }
    }
}

Nested Schema : quantity

Type: object

The quantity of which the charge item has been serviced.
Example:

{
  "quantity": {
    "value": 1
  }
}

Show Source

• code: string
• comparator: string
• system: string
• unit: string
• value: number

{
    "description":"The quantity of which the charge item has been serviced.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"quantity\": {\n    \"value\": 1\n  }\n}\n\n</pre></code>\n",
    "type":"object",
    "properties":{
        "value":{
            "type":"number"
        },
        "unit":{
            "type":"string"
        },
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "comparator":{
            "type":"string"
        }
    }
}

Nested Schema : reason

Type: object

The dagnosis codes for why the charge was rendered.
Note: The coding field must contain only one coding from the ICD proprietary Bill Codes Types systems.
Example:

{
  "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"
        }
      ]
    }
  ]
}

Show Source

• coding: array coding
• text: string

{
    "description":"The dagnosis codes for why the charge was rendered.<br>\n\n<b>Note:</b> The coding field must contain only one coding from the ICD proprietary Bill Codes Types systems.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"reason\": [\n    {\n      \"extension\": [\n        {\n          \"valueUnsignedInt\": 1,\n          \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/priority\"\n        }\n      ],\n      \"coding\": [\n        {\n          \"extension\": [\n            {\n              \"valueCoding\": {\n                \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14002\",\n                \"code\": \"3693\"\n              },\n              \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/bill-code-schedule\"\n            }\n          ],\n          \"system\": \"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/CodeSystem/BillCodes-ICD\",\n          \"code\": \"Z00\"\n        }\n      ]\n    }\n  ]\n}\n\n</pre></code>\n",
    "type":"object",
    "properties":{
        "text":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "system":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : subject

Type: object

The patient associated with the charge.
Note: Must be a Patient reference.
Example:

{
  "subject": {
    "reference": "Patient/12742419"
  }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "system":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code: string
• system: string

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "system":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code: string
• system: string

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/fhir+json

200 Response

**OK**

Headers

• ETag: string
  The identifier for a specific version of a resource. This identifier is formatted as W/"" and used to specify the If-Match header value on subsequent updates.
• Location: string
  The URL location of the created entity.
  Example:

  https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Parameters/642774

• X-Request-Id: string
  The Oracle troubleshooting identifier.
• opc-request-id: string
  The Oracle troubleshooting identifier.

Default Response

Example Request:

POST https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ChargeItem/$create

Example Response:

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 a subsequent update.

Back to Top