CommunicationRequest - FHIR Resource (dstu2)
This CommunicationRequest Resource uses the FHIR API standard for access and structure.
Validate an CommunicationRequest FHIR Resource (dstu2)
CommunicationRequest Attributes
AttributeField is listTypeDescription
Description: Message category
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": Learn more about the (CommunicationRequest) category FHIR attribute
Description: proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (CommunicationRequest) status FHIR attribute
Description: A channel of communication
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"medium": Learn more about the (CommunicationRequest) medium FHIR attribute
Description: "sender" : { Reference(Device|Organization|Patient|Practitioner|
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"sender": Learn more about the (CommunicationRequest) sender FHIR attribute
Description: Unique identifier
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (CommunicationRequest) identifier FHIR attribute
Description: "scheduledPeriod" : { Period },
FHIR Version: dstu2
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"scheduledPeriod": Learn more about the (CommunicationRequest) scheduledPeriod FHIR attribute
Description: When ordered or proposed
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requestedOn": Learn more about the (CommunicationRequest) requestedOn FHIR attribute
Description: Message urgency
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"priority": Learn more about the (CommunicationRequest) priority FHIR attribute
Description: Indication for message
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reason": Learn more about the (CommunicationRequest) reason FHIR attribute
Description: An individual who requested a communication
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requester": Learn more about the (CommunicationRequest) requester FHIR attribute
Description: "scheduledDateTime" : "<dateTime>",
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"scheduledDateTime": Learn more about the (CommunicationRequest) scheduledDateTime FHIR attribute
Description: "recipient" : [{ Reference(Device|Organization|Patient|Practitioner|
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"recipient": Learn more about the (CommunicationRequest) recipient FHIR attribute
Description: Message payload
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"payload": Learn more about the (CommunicationRequest) payload FHIR attribute
Description: Encounter leading to message
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": Learn more about the (CommunicationRequest) encounter FHIR attribute
Description: Focus of message
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": Learn more about the (CommunicationRequest) subject FHIR attribute
CommunicationRequest Structure
{
"resourceType" : "CommunicationRequest",
// 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) }], // 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
"requester" : { Reference(Practitioner|Patient|RelatedPerson) }, // An individual who requested a communication
"status" : "<code>", // proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed
"encounter" : { Reference(Encounter) }, // Encounter leading to message
// scheduled[x]: When scheduled. One of these 2:
"scheduledDateTime" : "<dateTime>",
"scheduledPeriod" : { Period },
"reason" : [{ CodeableConcept }], // Indication for message
"requestedOn" : "<dateTime>", // When ordered or proposed
"subject" : { Reference(Patient) }, // Focus of message
"priority" : { CodeableConcept } // Message urgency
}
CommunicationRequest Search Parameters
The following search parameters can be used to query CommunicationRequest resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/CommunicationRequest?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 |
priority | text | priority |
recipient | reference | recipient |
requested | date | requestedOn |
requester | reference | requester |
sender | reference | sender |
status | text | status |
subject | reference | subject |
time | date | scheduledDateTime |
