Communication - FHIR Resource (r4)


This Communication Resource uses the FHIR API standard for access and structure.

Validate an Communication FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
abouttrueReference# Resources that pertain to this communication
basedOntrueReference# Request fulfilled by this communication
categorytrueCodeableConcept# Message category
encounterfalseReference# Encounter created as part of
identifiertrueIdentifier# Unique identifier
inResponseTotrueReference# Reply to
instantiatesCanonicaltruecanonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)# "instantiatesCanonical" : [{ canonical(PlanDefinition|ActivityDefinition|
instantiatesUritrueuri# Instantiates external protocol or definition
mediumtrueCodeableConcept# A channel of communication
notetrueAnnotation# Comments made about the communication
partOftrueReference# Part of this action
payloadtrueData Type# Message payload
priorityfalsecode# routine | urgent | asap | stat
reasonCodetrueCodeableConcept# Indication for message
reasonReferencetrueReference# "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
receivedfalsedateTime# When received
recipienttrueReference# "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
senderfalseReference# "sender" : { Reference(Device|Organization|Patient|Practitioner|
sentfalsedateTime# When sent
statusfalsecode# preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
statusReasonfalseCodeableConcept# Reason for current status
subjectfalseReference# Focus of message
topicfalseCodeableConcept# Description of the purpose/content

Communication Example

{
  "resourceType": "Communication",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Patient has very high serum potassium</div>"
  },
  "identifier": [
    {
      "type": {
        "text": "Paging System"
      },
      "system": "urn:oid:1.3.4.5.6.7",
      "value": "2345678901"
    }
  ],
  "instantiatesUri": [
    "http://example.org/hyperkalemia"
  ],
  "partOf": [
    {
      "display": "Serum Potassium Observation"
    }
  ],
  "status": "completed",
  "category": [
    {
      "coding": [
        {
          "system": "http://acme.org/messagetypes",
          "code": "Alert"
        }
      ],
      "text": "Alert"
    }
  ],
  "medium": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode",
          "code": "WRITTEN",
          "display": "written"
        }
      ],
      "text": "written"
    }
  ],
  "subject": {
    "reference": "Patient/example"
  },
  "encounter": {
    "reference": "Encounter/example"
  },
  "sent": "2014-12-12T18:01:10-08:00",
  "received": "2014-12-12T18:01:11-08:00",
  "recipient": [
    {
      "reference": "Practitioner/example"
    }
  ],
  "sender": {
    "reference": "Device/f001"
  },
  "payload": [
    {
      "contentString": "Patient 1 has a very high serum potassium value (7.2 mmol/L on 2014-Dec-12 at 5:55 pm)"
    },
    {
      "contentReference": {
        "display": "Serum Potassium Observation"
      }
    }
  ]
}

Communication Structure

{
  "resourceType" : "Communication",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique identifier
  "instantiatesCanonical" : [{ canonical(PlanDefinition|ActivityDefinition|
   Measure|OperationDefinition|Questionnaire) }], // Instantiates FHIR protocol or definition
  "instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
  "basedOn" : [{ Reference(Any) }], // Request fulfilled by this communication
  "partOf" : [{ Reference(Any) }], // Part of this action
  "inResponseTo" : [{ Reference(Communication) }], // Reply to
  "status" : "<code>", // R!  preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
  "statusReason" : { CodeableConcept }, // Reason for current status
  "category" : [{ CodeableConcept }], // Message category
  "priority" : "<code>", // routine | urgent | asap | stat
  "medium" : [{ CodeableConcept }], // A channel of communication
  "subject" : { Reference(Patient|Group) }, // Focus of message
  "topic" : { CodeableConcept }, // Description of the purpose/content
  "about" : [{ Reference(Any) }], // Resources that pertain to this communication
  "encounter" : { Reference(Encounter) }, // Encounter created as part of
  "sent" : "<dateTime>", // When sent
  "received" : "<dateTime>", // When received
  "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson|Group|CareTeam|HealthcareService) }], // Message recipient
  "sender" : { Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson|HealthcareService) }, // Message sender
  "reasonCode" : [{ CodeableConcept }], // Indication for message
  "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
   DocumentReference) }], // Why was communication done?
  "payload" : [{ // Message payload
    // content[x]: Message part content. One of these 3:
    "contentString" : "<string>"
    "contentAttachment" : { Attachment }
    "contentReference" : { Reference(Any) }
  }],
  "note" : [{ Annotation }] // Comments made about the communication
}

Communication Search Parameters

The following search parameters can be used to query Communication resources. Just submit them like so:

https://api.1up.health/fhir/r4/Communication?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
based-onreferencebasedOn
categorytextcategory
encounterreferenceencounter
identifiertextidentifier
instantiates-canonicalreferenceinstantiatesCanonical
instantiates-uriuriinstantiatesUri
mediumtextmedium
part-ofreferencepartOf
patientreferencesubject.where
receiveddatereceived
recipientreferencerecipient
senderreferencesender
sentdatesent
statustextstatus
subjectreferencesubject