Communication - FHIR Resource (dstu2)


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

Validate an Communication FHIR Resource (dstu2)



Resource Attributes

AttributeField is listTypeDescription
categoryfalseCodeableConcept Message category
encounterfalseReference Encounter leading to message
identifiertrueIdentifier Unique identifier
mediumtrueCodeableConcept A channel of communication
payloadtrueData Type Message payload
reasontrueCodeableConcept Indication for message
receivedfalsedateTime When received
recipienttrueReference "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
requestDetailfalseReference CommunicationRequest producing this message
senderfalseReference "sender" : { Reference(Device|Organization|Patient|Practitioner|
sentfalsedateTime When sent
statusfalsecode in-progress | completed | suspended | rejected | failed
subjectfalseReference Focus of message

Communication Structure


  
{
  "resourceType" : "Communication",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique identifier
  "category" : { CodeableConcept }, // Message category
  "sender" : { Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson) }, // Message sender
  "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson|Group) }], // Message recipient
  "payload" : [{ // Message payload
    // content[x]: Message part content. One of these 3:
    "contentString" : "<string>"
    "contentAttachment" : { Attachment }
    "contentReference" : { Reference(Any) }
  }],
  "medium" : [{ CodeableConcept }], // A channel of communication
  "status" : "<code>", // in-progress | completed | suspended | rejected | failed
  "encounter" : { Reference(Encounter) }, // Encounter leading to message
  "sent" : "<dateTime>", // When sent
  "received" : "<dateTime>", // When received
  "reason" : [{ CodeableConcept }], // Indication for message
  "subject" : { Reference(Patient) }, // Focus of message
  "requestDetail" : { Reference(CommunicationRequest) } // CommunicationRequest producing this message
}


 

Communication Search Parameters

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

https://api.1up.health/fhir/dstu2/Communication?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
categorytextcategory
encounterreferenceencounter
identifiertextidentifier
mediumtextmedium
patientreferencesubject
receiveddatereceived
recipientreferencerecipient
requestreferencerequestDetail
senderreferencesender
sentdatesent
statustextstatus
subjectreferencesubject