FHIR R4 APIs for Oracle Health Millennium Platform

Create a credit charge item

post

/ChargeItem/{ID}/$credit

Creates an offsetting charge item for an existing debit charge item.

Note: Only the body fields mentioned below are supported. Unsupported fields are ignored.

Authorization Types

This operation supports the following authorization types:

Request

Supported Media Types

application/fhir+json

Path Parameters

ID(required): string

The logical resource ID associated with the resource.

Header Parameters

Authorization(required): string

Contains the credentials to authenticate a consumer to the service. The credentials should be the OAuth2 Bearer Token.
accept(required): string

The media type to be requested. See what the resource's operation produces for what is supported.

Root Schema : ChargeItemCreditBody

Type: object

Show Source

context(required): object context
The encounter associated with the charge item.
Note:
- The value must be in the form of valueReference.
- Only one value can be defined.
Example:
```
{
  "parameter": [
    {
      "name": "context",
      "valueReference": {
        "reference": "Encounter/98255557"
      }
    }
  ]
}
```
parameter(required):

The parameters defined by the operation.
resourceType(required): string

Allowed Values: [ "Parameters" ]

The type of the FHIR resource.
subject(required): object subject
The patient associated with the charge item.
Note:
- The value must be in the form of valueReference.
- Only one value can be defined.
Example:
```
{
  "parameter": [
    {
      "name": "subject",
      "valueReference": {
        "reference": "Patient/13388355"
      }
    }
  ]
}
```
transactionId(required): string
A UUID to uniquely identify the credit operation.
Note:
- The value must be in the form of valueUuid.
- Only one value can be defined.
Example:
```
{
  "parameter": [
    {
      "name": "transactionId",
      "valueUuid": "urn:uuid:aa7623a0-0c7b-11ec-82a8-0242ac130003"
    }
  ]
}
```
versionId(required): string
The version ID of the charge item that is the target of the credit operation.
Note:
- The value must be in the form of valueId.
- Only one value can be defined.
Example:
```
{
  "parameter": [
    {
      "name": "versionId",
      "valueId": "2"
    }
  ]
}
```

{
    "type":"object",
    "required":[
        "resourceType",
        "parameter",
        "versionId",
        "subject",
        "context",
        "transactionId"
    ],
    "properties":{
        "resourceType":{
            "description":"The type of the FHIR resource.\n",
            "type":"string",
            "enum":[
                "Parameters"
            ]
        },
        "parameter":{
            "description":"The parameters defined by the operation."
        },
        "versionId":{
            "description":"The version ID of the charge item that is the target of the credit operation.<br>\n\n<b>Note:</b>\n<ul>\n  <li>The value must be in the form of <code>valueId</code>.</li>\n  <li>Only one value can be defined.</li>\n</ul>\n<b>Example:</b>\n\n<pre><code>{\n  \"parameter\": [\n    {\n      \"name\": \"versionId\",\n      \"valueId\": \"2\"\n    }\n  ]\n}\n\n</pre></code>\n",
            "type":"string"
        },
        "subject":{
            "description":"The patient associated with the charge item.<br>\n\n<b>Note:</b>\n<ul>\n  <li>The value must be in the form of <code>valueReference</code>.</li>\n  <li>Only one value can be defined.</li>\n</ul>\n<b>Example:</b>\n\n<pre><code>{\n  \"parameter\": [\n    {\n      \"name\": \"subject\",\n      \"valueReference\": {\n        \"reference\": \"Patient/13388355\"\n      }\n    }\n  ]\n}\n\n</pre></code>\n",
            "type":"object",
            "properties":{
                "reference":{
                    "type":"string"
                }
            }
        },
        "context":{
            "description":"The encounter associated with the charge item.<br>\n\n<b>Note:</b>\n<ul>\n  <li>The value must be in the form of <code>valueReference</code>.</li>\n  <li>Only one value can be defined.</li>\n</ul>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"parameter\": [\n    {\n      \"name\": \"context\",\n      \"valueReference\": {\n        \"reference\": \"Encounter/98255557\"\n      }\n    }\n  ]\n}\n\n</pre></code>\n",
            "type":"object",
            "properties":{
                "reference":{
                    "type":"string"
                }
            }
        },
        "transactionId":{
            "description":"A UUID to uniquely identify the credit 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 value can be defined.</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"
        }
    },
    "example":"{\n  \"resourceType\": \"Parameters\",\n  \"parameter\": [\n    {\n      \"name\": \"versionId\",\n      \"valueId\": \"2\"\n    },\n    {\n      \"name\": \"transactionId\",\n      \"valueUuid\": \"urn:uuid:5bb8acae-0c7d-11ec-82a8-0242ac130003\"\n    },\n    {\n      \"name\": \"subject\",\n      \"valueReference\": {\n        \"reference\": \"Patient/12782842\"\n      }\n    },\n    {\n      \"name\": \"context\",\n      \"valueReference\": {\n        \"reference\": \"Encounter/98019577\"\n      }\n    }\n  ]\n}\n"
}

Example:

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

Nested Schema : context

Type: object

The encounter associated with the charge item.
Note:

The value must be in the form of valueReference.
Only one value can be defined.

Example:

{
  "parameter": [
    {
      "name": "context",
      "valueReference": {
        "reference": "Encounter/98255557"
      }
    }
  ]
}

Show Source

reference: string

{
    "description":"The encounter associated with the charge item.<br>\n\n<b>Note:</b>\n<ul>\n  <li>The value must be in the form of <code>valueReference</code>.</li>\n  <li>Only one value can be defined.</li>\n</ul>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"parameter\": [\n    {\n      \"name\": \"context\",\n      \"valueReference\": {\n        \"reference\": \"Encounter/98255557\"\n      }\n    }\n  ]\n}\n\n</pre></code>\n",
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        }
    }
}

Nested Schema : subject

Type: object

The patient associated with the charge item.
Note:

The value must be in the form of valueReference.
Only one value can be defined.

Example:

{
  "parameter": [
    {
      "name": "subject",
      "valueReference": {
        "reference": "Patient/13388355"
      }
    }
  ]
}

Show Source

reference: string

{
    "description":"The patient associated with the charge item.<br>\n\n<b>Note:</b>\n<ul>\n  <li>The value must be in the form of <code>valueReference</code>.</li>\n  <li>Only one value can be defined.</li>\n</ul>\n<b>Example:</b>\n\n<pre><code>{\n  \"parameter\": [\n    {\n      \"name\": \"subject\",\n      \"valueReference\": {\n        \"reference\": \"Patient/13388355\"\n      }\n    }\n  ]\n}\n\n</pre></code>\n",
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/fhir+json

201 Response

Created

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/292427912/$credit

Example Response:

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