FHIR R4 APIs for Oracle Health Millennium Platform

Create a communication

post

/Communication

Creates a new communication.

Request

Supported Media Types

application/fhir+json

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 : CommunicationCreateBody

Type: object

Show Source

category(required): object category
A codeable definition of the communication type.
Note: Only CommunicationCategory values of notification and reminder and SNOMED CT 312853008 are supported.
Example:
```
{
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/communication-category",
          "code": "notification"
        }
      ]
    }
  ]
}
```
encounter: object encounter
The encounter associated with the communication.
Note: Subject is required when writing an encounter.
Example:
```
{
  "encounter" : {
    "reference" : "Encounter/89363836"
  }
}
```
payload(required):
The text of the communication.
Note:
- Content must be supplied as a contentAttachment with contentType and data defined.
- contentType can be set to:
  - application/xhtml+xml
  - text/plain
- contentType can contain a charset set to:
  - utf-8
  - us-ascii
- data should be base64 encoded.
- If the contentType is application/xhtml+xml, then the data (when decoded) should at least contain the following:
Example:
```
{
  "payload" : [
    {
      "contentAttachment" : {
        "contentType" : "application/xhtml+xml",
        "data" : "PCFET0NUWVBFIGh0bWwgUFVCTElDICItLy9XM0MvL0RURCBYSFRNTCAxLjAgVHJhbnNpdGlvbmFsLy9FTiIKImh0dHA6Ly93d3cudzMub3JnL1RSL3hodG1sMS9EVEQveGh0bWwxLXRyYW5zaXRpb25hbC5kdGQiPjxodG1sPjxib2R5PjwvYm9keT48L2h0bWw+"
      }
    }
  ]
}
```
priority: string
The priority of the communication.
Note: Only routine and urgent priorities are supported.
Example:
```
{
  "priority": "routine"
}
```

recipient(required):

The entity receiving the communication.
Note: Each recipient must be a practitioner or group.
Example:

{
  "recipient": [
    {
      "reference" : "Practitioner/6373634"
    },
    {
      "reference" : "Group/44466678"
    }
  ]
}

reply-to: object reply-to

The entity that replies are directed to.
Note: The reply-to must be a group.
Example:

{
  "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/reply-to",
  "valueReference": {
    "reference": "Group/123"
  }
}

resourceType(required): string

Allowed Values: [ "Communication" ]

The type of the FHIR resource.
sender(required): object sender
The entity sending the communication.
Note: The sender must be a practitioner.
Example:
```
{
  "sender": {
    "reference": "Practitioner/631923"
  }
}
```
status(required): string
The status of the communication.
Note: All communications must be in completed status.
Example:
```
{
  "status": "completed"
}
```
subject: object subject
The patient that is the focus of the communication.
Note: Only Patient is supported as the subject.
Example:
```
{
  "subject": {
    "reference": "Patient/9836548"
  }
}
```
topic: string
The topic of the communication, similar to the subject field of an email.
Note: Currently, only free-text topics are supported.
Example:
```
{
  "topic" : {
     "text": "Patient Consult Request"
  }
}
```

{
    "type":"object",
    "required":[
        "resourceType",
        "status",
        "category",
        "recipient",
        "sender",
        "payload"
    ],
    "properties":{
        "resourceType":{
            "description":"The type of the FHIR resource.\n",
            "type":"string",
            "enum":[
                "Communication"
            ]
        },
        "status":{
            "description":"The status of the communication.<br>\n\n<b>Note:</b> All communications must be in <code>completed</code> status.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"status\": \"completed\"\n}</code><pre>\n",
            "type":"string"
        },
        "category":{
            "description":"A codeable definition of the communication type.<br>\n\n<b>Note:</b> Only CommunicationCategory values of <code>notification</code> and <code>reminder</code> and SNOMED CT <code>312853008</code> are supported.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"category\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"http://terminology.hl7.org/CodeSystem/communication-category\",\n          \"code\": \"notification\"\n        }\n      ]\n    }\n  ]\n}\n</code><pre>\n",
            "type":"object",
            "properties":{
                "text":{
                    "type":"string"
                },
                "coding":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "system":{
                                "type":"string"
                            },
                            "code":{
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "priority":{
            "description":"The priority of the communication.<br>\n\n<b>Note:</b> Only <code>routine</code> and <code>urgent</code> priorities are supported.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"priority\": \"routine\"\n}</code></pre>\n",
            "type":"string"
        },
        "subject":{
            "description":"The patient that is the focus of the communication.<br>\n\n<b>Note:</b> Only Patient is supported as the subject.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"subject\": {\n    \"reference\": \"Patient/9836548\"\n  }\n}\n</code></pre>\n",
            "type":"object",
            "properties":{
                "reference":{
                    "type":"string"
                }
            }
        },
        "topic":{
            "description":"The topic of the communication, similar to the subject field of an email.<br>\n\n<b>Note:</b> Currently, only free-text topics are supported.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"topic\" : {\n     \"text\": \"Patient Consult Request\"\n  }\n}\n</code></pre>\n",
            "type":"string"
        },
        "encounter":{
            "description":"The encounter associated with the communication.<br>\n\n<b>Note:</b> Subject is required when writing an encounter.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"encounter\" : {\n    \"reference\" : \"Encounter/89363836\"\n  }\n}\n</code></pre>\n",
            "type":"object",
            "properties":{
                "reference":{
                    "type":"string"
                }
            }
        },
        "recipient":{
            "description":"The entity receiving the communication.<br>\n\n<b>Note:</b> Each recipient must be a practitioner or group.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"recipient\": [\n    {\n      \"reference\" : \"Practitioner/6373634\"\n    },\n    {\n      \"reference\" : \"Group/44466678\"\n    }\n  ]\n}\n</code></pre>\n"
        },
        "sender":{
            "description":"The entity sending the communication.<br>\n\n<b>Note:</b> The sender must be a practitioner.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"sender\": {\n    \"reference\": \"Practitioner/631923\"\n  }\n}\n</code></pre>\n",
            "type":"object",
            "properties":{
                "reference":{
                    "type":"string"
                }
            }
        },
        "payload":{
            "description":"The text of the communication.<br>\n\n<b>Note:</b>\n<ul>\n  <li>Content must be supplied as a <code>contentAttachment</code> with <code>contentType</code> and <code>data</code> defined.</li>\n  <li><code>contentType</code> can be set to:\n    <ul>\n      <li><code>application/xhtml+xml</code></li>\n      <li><code>text/plain</code></li>\n    </ul>\n  </li>\n  <li><code>contentType</code> can contain a charset set to:\n    <ul>\n      <li><code>utf-8</code></li>\n      <li><code>us-ascii</code></li>\n    </ul>\n  </li>\n  <li><code>data</code> should be base64 encoded.</li>\n  <li>If the <code>contentType</code> is <code>application/xhtml+xml</code>, then the data (when decoded) should at least contain the following:<br>\n  \n      <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n      \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\"><html><body></body></html>\n  </li>\n</ul>\n\n\n<b>Example:</b>\n\n<pre><code>{\n  \"payload\" : [\n    {\n      \"contentAttachment\" : {\n        \"contentType\" : \"application/xhtml+xml\",\n        \"data\" : \"PCFET0NUWVBFIGh0bWwgUFVCTElDICItLy9XM0MvL0RURCBYSFRNTCAxLjAgVHJhbnNpdGlvbmFsLy9FTiIKImh0dHA6Ly93d3cudzMub3JnL1RSL3hodG1sMS9EVEQveGh0bWwxLXRyYW5zaXRpb25hbC5kdGQiPjxodG1sPjxib2R5PjwvYm9keT48L2h0bWw+\"\n      }\n    }\n  ]\n}\n</code></pre>\n"
        },
        "reply-to":{
            "description":"The entity that replies are directed to.<br>\n\n<b>Note:</b> The reply-to must be a group.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/reply-to\",\n  \"valueReference\": {\n    \"reference\": \"Group/123\"\n  }\n}\n</code></pre>\n",
            "type":"object",
            "properties":{
                "reference":{
                    "type":"string"
                }
            }
        }
    },
    "example":"{\n  \"resourceType\": \"Communication\",\n  \"extension\": [\n    {\n      \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/reply-to\",\n      \"valueReference\": {\n        \"reference\": \"Group/6345478364\"\n      }\n    }\n  ],\n  \"status\": \"completed\",\n  \"category\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"http://terminology.hl7.org/CodeSystem/communication-category\",\n          \"code\": \"reminder\"\n        }\n      ]\n    }\n  ],\n  \"priority\": \"urgent\",\n  \"subject\": {\n    \"reference\": \"Patient/12457978\"\n  },\n  \"topic\": {\n    \"text\": \"CDI Query\"\n  },\n  \"encounter\": {\n    \"reference\": \"Encounter/97697401\"\n  },\n  \"recipient\": [\n    {\n      \"reference\": \"Practitioner/744113\"\n    },\n    {\n      \"reference\": \"Group/6345478364\"\n    }\n  ],\n  \"sender\": {\n    \"reference\": \"Practitioner/593923\"\n  },\n  \"payload\": [\n    {\n      \"contentAttachment\": {\n        \"contentType\": \"text/plain\",\n        \"data\": \"Q29tbXVuaWNhdGlvbg==\"\n      }\n    }\n  ]\n}\n"
}

Example:

{
  "resourceType": "Communication",
  "extension": [
    {
      "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/reply-to",
      "valueReference": {
        "reference": "Group/6345478364"
      }
    }
  ],
  "status": "completed",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/communication-category",
          "code": "reminder"
        }
      ]
    }
  ],
  "priority": "urgent",
  "subject": {
    "reference": "Patient/12457978"
  },
  "topic": {
    "text": "CDI Query"
  },
  "encounter": {
    "reference": "Encounter/97697401"
  },
  "recipient": [
    {
      "reference": "Practitioner/744113"
    },
    {
      "reference": "Group/6345478364"
    }
  ],
  "sender": {
    "reference": "Practitioner/593923"
  },
  "payload": [
    {
      "contentAttachment": {
        "contentType": "text/plain",
        "data": "Q29tbXVuaWNhdGlvbg=="
      }
    }
  ]
}

Nested Schema : category

Type: object

A codeable definition of the communication type.
Note: Only CommunicationCategory values of notification and reminder and SNOMED CT 312853008 are supported.
Example:

{
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/communication-category",
          "code": "notification"
        }
      ]
    }
  ]
}

Show Source

coding: array coding
text: string

{
    "description":"A codeable definition of the communication type.<br>\n\n<b>Note:</b> Only CommunicationCategory values of <code>notification</code> and <code>reminder</code> and SNOMED CT <code>312853008</code> are supported.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"category\": [\n    {\n      \"coding\": [\n        {\n          \"system\": \"http://terminology.hl7.org/CodeSystem/communication-category\",\n          \"code\": \"notification\"\n        }\n      ]\n    }\n  ]\n}\n</code><pre>\n",
    "type":"object",
    "properties":{
        "text":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "system":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : encounter

Type: object

The encounter associated with the communication.
Note: Subject is required when writing an encounter.
Example:

{
  "encounter" : {
    "reference" : "Encounter/89363836"
  }
}

Show Source

reference: string

{
    "description":"The encounter associated with the communication.<br>\n\n<b>Note:</b> Subject is required when writing an encounter.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"encounter\" : {\n    \"reference\" : \"Encounter/89363836\"\n  }\n}\n</code></pre>\n",
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        }
    }
}

Nested Schema : reply-to

Type: object

The entity that replies are directed to.
Note: The reply-to must be a group.
Example:

{
  "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/reply-to",
  "valueReference": {
    "reference": "Group/123"
  }
}

Show Source

reference: string

{
    "description":"The entity that replies are directed to.<br>\n\n<b>Note:</b> The reply-to must be a group.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/reply-to\",\n  \"valueReference\": {\n    \"reference\": \"Group/123\"\n  }\n}\n</code></pre>\n",
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        }
    }
}

Nested Schema : sender

Type: object

The entity sending the communication.
Note: The sender must be a practitioner.
Example:

{
  "sender": {
    "reference": "Practitioner/631923"
  }
}

Show Source

reference: string

{
    "description":"The entity sending the communication.<br>\n\n<b>Note:</b> The sender must be a practitioner.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"sender\": {\n    \"reference\": \"Practitioner/631923\"\n  }\n}\n</code></pre>\n",
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        }
    }
}

Nested Schema : subject

Type: object

The patient that is the focus of the communication.
Note: Only Patient is supported as the subject.
Example:

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

Show Source

reference: string

{
    "description":"The patient that is the focus of the communication.<br>\n\n<b>Note:</b> Only Patient is supported as the subject.<br>\n\n<b>Example:</b>\n\n<pre><code>{\n  \"subject\": {\n    \"reference\": \"Patient/9836548\"\n  }\n}\n</code></pre>\n",
    "type":"object",
    "properties":{
        "reference":{
            "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"
        }
    }
}

Response

Supported Media Types

application/fhir+json

201 Response

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/Communication/642774

X-Request-Id: string

Oracle troubleshooting identifier.
opc-request-id: string

Oracle troubleshooting identifier.

Default Response

This operation supports the following authorization types:

Example Request:

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

Example Response:

  Cache-Control: no-cache
  Content-Length: 0
  Content-Type: text/html
  Date: Mon, 06 Apr 2020 19:00:43 GMT
  Etag: W/"1"
  Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Communication/17228728
  Last-Modified: Mon, 06 Apr 2020 19:00:43 GMT
  Vary: Origin
  X-Request-Id: 11111111111111111111111111111111

The ETag response header indicates the current If-Match version to use on a subsequent update.