Jump to

• Request
• Response

Update a communication

patch

/Communication/{ID}

Patch Operations

Path	Operation	Value Type
/extension	replace	Extension
Description: Replace the value of an extension. Example: { "path": "/extension", "op": "replace", "value": [ { "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/task-status", "code": "completed" } ] }, "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/email-status" } ] } Note: Email Status is a supported extension that can be replaced.

Request

Supported Media Types

• application/fhir+json

Path Parameters

• ID(required): string
  The logical resource ID associated with the resource.

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

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object items

{
    "type":"array",
    "minItems":"1",
    "items":{
        "type":"object",
        "required":[
            "op",
            "path"
        ],
        "properties":{
            "op":{
                "type":"string",
                "enum":[
                    "replace"
                ]
            },
            "path":{
                "type":"string"
            },
            "value":{
                "type":"string"
            }
        }
    },
    "example":"[\n  {\n    \"path\": \"/extension\",\n    \"op\": \"replace\",\n    \"value\": [\n      {\n        \"valueCodeableConcept\": {\n          \"coding\": [\n            {\n              \"system\": \"http://hl7.org/fhir/task-status\",\n              \"code\": \"completed\"\n            }\n          ]\n        },\n        \"url\": \"https://fhir-ehr.cerner.com/r4/StructureDefinition/email-status\"\n      }\n    ]\n  }\n]\n"
}

Example:

[
  {
    "path": "/extension",
    "op": "replace",
    "value": [
      {
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/task-status",
              "code": "completed"
            }
          ]
        },
        "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/email-status"
      }
    ]
  }
]

Nested Schema : items

Type: object

Show Source

• op(required): string
  Allowed Values: [ "replace" ]
• path(required): string
• value: string

{
    "type":"object",
    "required":[
        "op",
        "path"
    ],
    "properties":{
        "op":{
            "type":"string",
            "enum":[
                "replace"
            ]
        },
        "path":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json-patch+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.
• X-Request-Id: string
  Oracle troubleshooting identifier.
• opc-request-id: string
  Oracle troubleshooting identifier.

Default Response

This operation supports the following authorization types:

• Provider
• System

Example Request:

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

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.

Back to Top