Communication - FHIR Resource (dstu2)
This Communication Resource uses the
FHIR API standard for access and structure.
Validate an Communication FHIR Resource (dstu2)
Communication Attributes
AttributeField is listTypeDescription
Description: Message category
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: in-progress | completed | suspended | rejected | failed
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: A channel of communication
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: "sender" : { Reference(Device|Organization|Patient|Practitioner|
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: When received
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: Message payload
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: Indication for message
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: Encounter leading to message
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: Unique identifier
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: CommunicationRequest producing this message
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: When sent
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: Focus of message
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
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 them like so:
https://api.1up.health/fhir/dstu2/Communication?query-param=queryvalue
Search Parameter | Field Type | Resource Fields Searched |
---|
category | text | category |
encounter | reference | encounter |
identifier | text | identifier |
medium | text | medium |
patient | reference | subject |
received | date | received |
recipient | reference | recipient |
request | reference | requestDetail |
sender | reference | sender |
sent | date | sent |
status | text | status |
subject | reference | subject |