Jump to

• Request
• Response

Get a list of communications

get

/Communication

Retrieves a list of communications that meet supplied query parameters.

Note:

• The content of a communication is returned through the Binary resource. A reference to the payload is provided in the Payload section.
• Only 1000 elements maximum are returned based on the date range.

Request

Query Parameters

• -email-status: string
  The status of the email. This parameter is required with category, recipient, and received if _id is not used.
  Example:

  http://hl7.org/fhir/task-status|in-progress

• _id: string
  The logical resource ID associated with the resource. This parameter is required if category, -email-status, recipient, and received are not used.
  Example: 489580643.0.-4.prsnl
• category: string
  A token for a CodeableConcept that points to the CodeableConcept used for Communication.category. This parameter is required with recipient, received, and -email-status if _id is not used.
  Example:

  http://terminology.hl7.org/CodeSystem/communication-category|notification

• received: string
  The date range that the communication falls within. This parameter is required with category, recipient, and -email-status if _id is not used.

  • May be provided once with the ge prefix.
  • May be provided twice with the lower value prefixed by ge and the higher value prefixed by le.
  • Must be provided with a time component.

  Example: ge2017-02-01T10:30:00Z
• recipient: string
  The recipient of the communication. Must represent a practitioner or a group. This parameter is required with category, received, and -email-status if _id is not used.
  Example: recipient:Practitioner=3456783

Header Parameters

• accept(required): string
  The media type to be requested. See what the resource's operation produces for what is supported.

Back to Top

Response

Supported Media Types

• application/json+fhir

Default Response

This operation supports the following authorization types:

• Provider
• System

Example Request:

GET https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Communication?_id=489580643.0.-4.prsnl

Example Response:

{
  "resourceType": "Bundle",
  "id": "e989e20d-5cfc-4b11-ab43-95ba1a684063",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Communication?_id=489580643.0.-4.prsnl"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Communication/489580643.0.-4.prsnl",
      "resource": {
        "resourceType": "Communication",
        "id": "489580643.0.-4.prsnl",
        "meta": {
          "versionId": "0",
          "lastUpdated": "2020-07-16T21:31:35.457Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p><b>Communication</b></p></div>"
        },
        "extension": [
          {
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/task-status",
                  "code": "completed",
                  "display": "Completed"
                }
              ],
              "text": "Completed"
            },
            "url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/email-status"
          }
        ],
        "inResponseTo": [
          {
            "reference": "Communication/512657279.0.-4.prsnl"
          }
        ],
        "status": "completed",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/communication-category",
                "code": "notification",
                "display": "Notification"
              }
            ],
            "text": "Notification"
          }
        ],
        "priority": "urgent",
        "subject": {
          "reference": "Patient/12505984",
          "display": "JOHNSON, MARIE"
        },
        "topic": {
          "text": "CDI Query"
        },
        "encounter": {
          "reference": "Encounter/97739401"
        },
        "sent": "2020-07-16T21:31:35.457Z",
        "received": "2020-07-16T21:31:35.457Z",
        "recipient": [
          {
            "reference": "Practitioner/12093978",
            "display": "Stone, RN, Sally Cerner"
          },
          {
            "reference": "Group/1568",
            "display": "HEALTHE Receiver Group"
          }
        ],
        "sender": {
          "reference": "Practitioner/11875977",
          "display": "Stratford, Angela Cerner"
        },
        "payload": [
          {
            "contentReference": {
              "reference": "Binary/489580643.0.-4.prsnl"
            }
          }
        ]
      }
    }
  ]
}

Headers

• X-Request-Id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

Back to Top