Communication - FHIR Resource (stu3)


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

Validate an Communication FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
basedOntrueReference Request fulfilled by this communication
categorytrueCodeableConcept Message category
contextfalseReference Encounter or episode leading to message
definitiontrueReference Instantiates protocol or definition
identifiertrueIdentifier Unique identifier
mediumtrueCodeableConcept A channel of communication
notDonefalseboolean Communication did not occur
notDoneReasonfalseCodeableConcept C? Why communication did not occur
notetrueAnnotation Comments made about the communication
partOftrueReference Part of this action
payloadtrueData Type Message payload
reasonCodetrueCodeableConcept Indication for message
reasonReferencetrueReference Why was communication done?
receivedfalsedateTime When received
recipienttrueReference "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
senderfalseReference "sender" : { Reference(Device|Organization|Patient|Practitioner|
sentfalsedateTime When sent
statusfalsecode preparation | in-progress | suspended | aborted | completed | entered-in-error
subjectfalseReference Focus of message
topictrueReference Focal resources

Communication Example

{
  "status": "completed",
  "definition": [
    {
      "display": "Hyperkalemia"
    }
  ],
  "medium": [
    {
      "text": "written",
      "coding": [
        {
          "code": "WRITTEN",
          "system": "http://hl7.org/fhir/v3/ParticipationMode",
          "display": "written"
        }
      ]
    }
  ],
  "sender": {
    "reference": "Device/f001"
  },
  "category": [
    {
      "text": "Alert",
      "coding": [
        {
          "code": "Alert",
          "system": "http://acme.org/messagetypes"
        }
      ]
    }
  ],
  "received": "2014-12-12T18:01:11-08:00",
  "resourceType": "Communication",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Patient has very high serum potassium</div>"
  },
  "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"
      }
    }
  ],
  "sent": "2014-12-12T18:01:10-08:00",
  "context": {
    "reference": "Encounter/example"
  },
  "identifier": [
    {
      "type": {
        "text": "Paging System"
      },
      "system": "urn:oid:1.3.4.5.6.7",
      "value": "2345678901"
    }
  ],
  "recipient": [
    {
      "reference": "Practitioner/example"
    }
  ],
  "id": "example",
  "partOf": [
    {
      "display": "Serum Potassium Observation"
    }
  ],
  "subject": {
    "reference": "Patient/example"
  }
}

Communication Structure


  
{
  "resourceType" : "Communication",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique identifier
  "definition" : [{ Reference(PlanDefinition|ActivityDefinition) }], // Instantiates protocol or definition
  "basedOn" : [{ Reference(Any) }], // Request fulfilled by this communication
  "partOf" : [{ Reference(Any) }], // Part of this action
  "status" : "<code>", // R!  preparation | in-progress | suspended | aborted | completed | entered-in-error
  "notDone" : <boolean>, // Communication did not occur
  "notDoneReason" : { CodeableConcept }, // C? Why communication did not occur
  "category" : [{ CodeableConcept }], // Message category
  "medium" : [{ CodeableConcept }], // A channel of communication
  "subject" : { Reference(Patient|Group) }, // Focus of message
  "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson|Group) }], // Message recipient
  "topic" : [{ Reference(Any) }], // Focal resources
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter or episode leading to message
  "sent" : "<dateTime>", // When sent
  "received" : "<dateTime>", // When received
  "sender" : { Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson) }, // Message sender
  "reasonCode" : [{ CodeableConcept }], // Indication for message
  "reasonReference" : [{ Reference(Condition|Observation) }], // 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 the like so:

https://api.1up.health/fhir/stu3/Communication?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
based-onreferencebasedOn
categorytextcategory
contextreferencecontext
definitionreferencedefinition
encounterreferencecontext
identifiertextidentifier
mediumtextmedium
part-ofreferencepartOf
patientreferencesubject
receiveddatereceived
recipientreferencerecipient
senderreferencesender
sentdatesent
statustextstatus
subjectreferencesubject