Communication - FHIR Resource (stu3)
This Communication Resource uses the FHIR API standard for access and structure.
Validate an Communication FHIR Resource (stu3)
Communication Attributes
AttributeField is listTypeDescription
Description: preparation | in-progress | suspended | aborted | completed | entered-in-error
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "completed"Learn more about the (Communication) status FHIR attribute
Description: Instantiates protocol or definition
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"definition": [
{
"display": "Hyperkalemia"
}
]Learn more about the (Communication) definition FHIR attribute
Description: A channel of communication
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"medium": [
{
"text": "written",
"coding": [
{
"code": "WRITTEN",
"system": "http://hl7.org/fhir/v3/ParticipationMode",
"display": "written"
}
]
}
]Learn more about the (Communication) medium FHIR attribute
Description: Why was communication done?
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonReference": Learn more about the (Communication) reasonReference FHIR attribute
Description: "sender" : { Reference(Device|Organization|Patient|Practitioner|
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"sender": {
"reference": "Device/f001"
}Learn more about the (Communication) sender FHIR attribute
Description: Unique identifier
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"type": {
"text": "Paging System"
},
"system": "urn:oid:1.3.4.5.6.7",
"value": "2345678901"
}
]Learn more about the (Communication) identifier FHIR attribute
Description: When received
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"received": "2014-12-12T18:01:11-08:00"Learn more about the (Communication) received FHIR attribute
Description: Request fulfilled by this communication
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"basedOn": Learn more about the (Communication) basedOn FHIR attribute
Description: Message payload
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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"
}
}
]Learn more about the (Communication) payload FHIR attribute
Description: Focal resources
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"topic": Learn more about the (Communication) topic FHIR attribute
Description: Comments made about the communication
FHIR Version: stu3
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (Communication) note FHIR attribute
Description: Part of this action
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"partOf": [
{
"display": "Serum Potassium Observation"
}
]Learn more about the (Communication) partOf FHIR attribute
Description: Encounter or episode leading to message
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"context": {
"reference": "Encounter/example"
}Learn more about the (Communication) context FHIR attribute
Description: Communication did not occur
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"notDone": Learn more about the (Communication) notDone FHIR attribute
Description: Indication for message
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reasonCode": Learn more about the (Communication) reasonCode FHIR attribute
Description: Message category
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": [
{
"text": "Alert",
"coding": [
{
"code": "Alert",
"system": "http://acme.org/messagetypes"
}
]
}
]Learn more about the (Communication) category FHIR attribute
Description: "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"recipient": [
{
"reference": "Practitioner/example"
}
]Learn more about the (Communication) recipient FHIR attribute
Description: C? Why communication did not occur
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"notDoneReason": Learn more about the (Communication) notDoneReason FHIR attribute
Description: When sent
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"sent": "2014-12-12T18:01:10-08:00"Learn more about the (Communication) sent FHIR attribute
Description: Focus of message
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": {
"reference": "Patient/example"
}Learn more about the (Communication) subject FHIR attribute
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 them like so:
https://api.1up.health/fhir/stu3/Communication?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
based-on | reference | basedOn |
category | text | category |
context | reference | context |
definition | reference | definition |
encounter | reference | context |
identifier | text | identifier |
medium | text | medium |
part-of | reference | partOf |
patient | reference | subject |
received | date | received |
recipient | reference | recipient |
sender | reference | sender |
sent | date | sent |
status | text | status |
subject | reference | subject |
