Communication - FHIR Resource (r4)
This Communication Resource uses the FHIR API standard for access and structure.
Validate an Communication FHIR Resource (r4)
Communication Attributes
AttributeField is listTypeDescription
Description: Unique identifier
FHIR Version: r4
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: "instantiatesCanonical" : [{ canonical(PlanDefinition|ActivityDefinition|
FHIR Version: r4
Attribute Type : canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesCanonical": Learn more about the (Communication) instantiatesCanonical FHIR attribute
Description: Instantiates external protocol or definition
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instantiatesUri": [
"http://example.org/hyperkalemia"
]Learn more about the (Communication) instantiatesUri FHIR attribute
Description: Request fulfilled by this communication
FHIR Version: r4
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: Part of this action
FHIR Version: r4
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: Reply to
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"inResponseTo": Learn more about the (Communication) inResponseTo FHIR attribute
Description: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
FHIR Version: r4
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: Reason for current status
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"statusReason": Learn more about the (Communication) statusReason FHIR attribute
Description: Message category
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": [
{
"coding": [
{
"system": "http://acme.org/messagetypes",
"code": "Alert"
}
],
"text": "Alert"
}
]Learn more about the (Communication) category FHIR attribute
Description: routine | urgent | asap | stat
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"priority": Learn more about the (Communication) priority FHIR attribute
Description: A channel of communication
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"medium": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationMode",
"code": "WRITTEN",
"display": "written"
}
],
"text": "written"
}
]Learn more about the (Communication) medium FHIR attribute
Description: Focus of message
FHIR Version: r4
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
Description: Description of the purpose/content
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"topic": Learn more about the (Communication) topic FHIR attribute
Description: Resources that pertain to this communication
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"about": Learn more about the (Communication) about FHIR attribute
Description: Encounter created as part of
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": {
"reference": "Encounter/example"
}Learn more about the (Communication) encounter FHIR attribute
Description: When sent
FHIR Version: r4
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: When received
FHIR Version: r4
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: "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
FHIR Version: r4
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: "sender" : { Reference(Device|Organization|Patient|Practitioner|
FHIR Version: r4
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: Indication for message
FHIR Version: r4
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: "reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
FHIR Version: r4
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: Message payload
FHIR Version: r4
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: Comments made about the communication
FHIR Version: r4
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
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 Parameter | Field Type | Resource Fields Searched |
|---|---|---|
based-on | reference | basedOn |
category | text | category |
encounter | reference | encounter |
identifier | text | identifier |
instantiates-canonical | reference | instantiatesCanonical |
instantiates-uri | uri | instantiatesUri |
medium | text | medium |
part-of | reference | partOf |
patient | reference | subject.where |
received | date | received |
recipient | reference | recipient |
sender | reference | sender |
sent | date | sent |
status | text | status |
subject | reference | subject |
