CommunicationRequest - FHIR Resource (r4)
This CommunicationRequest Resource uses the FHIR API standard for access and structure.
Validate an CommunicationRequest FHIR Resource (r4)
CommunicationRequest 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": Learn more about the (CommunicationRequest) identifier FHIR attribute
Description: Fulfills plan or proposal
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 (CommunicationRequest) basedOn FHIR attribute
Description: Request(s) replaced by this request
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:
"replaces": Learn more about the (CommunicationRequest) replaces FHIR attribute
Description: Composite request this is part of
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"groupIdentifier": Learn more about the (CommunicationRequest) groupIdentifier FHIR attribute
Description: draft | active | on-hold | revoked | 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": "active"Learn more about the (CommunicationRequest) 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 (CommunicationRequest) 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": Learn more about the (CommunicationRequest) 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 (CommunicationRequest) priority FHIR attribute
Description: True if request is prohibiting action
FHIR Version: r4
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"doNotPerform": Learn more about the (CommunicationRequest) doNotPerform 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": Learn more about the (CommunicationRequest) 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 (CommunicationRequest) subject FHIR attribute
Description: Resources that pertain to this communication request
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 (CommunicationRequest) 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 (CommunicationRequest) encounter 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": Learn more about the (CommunicationRequest) payload FHIR attribute
Description:
FHIR Version: r4
Attribute Type : dateTime|Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"occurrence[x]": Learn more about the (CommunicationRequest) occurrence[x] FHIR attribute
Description: When request transitioned to being actionable
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:
"authoredOn": Learn more about the (CommunicationRequest) authoredOn FHIR attribute
Description: "requester" : { Reference(Practitioner|PractitionerRole|Organization|
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:
"requester": Learn more about the (CommunicationRequest) requester 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": Learn more about the (CommunicationRequest) 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": Learn more about the (CommunicationRequest) sender FHIR attribute
Description: Why is communication needed?
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 (CommunicationRequest) 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 (CommunicationRequest) reasonReference FHIR attribute
Description: Comments made about communication request
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 (CommunicationRequest) note FHIR attribute
CommunicationRequest Example
{
"resourceType": "CommunicationRequest",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">To be filled out at a later time</div>"
},
"status": "active",
"subject": {
"reference": "Patient/example"
},
"encounter": {
"reference": "Encounter/example"
}
}CommunicationRequest Structure
{
"resourceType" : "CommunicationRequest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Unique identifier
"basedOn" : [{ Reference(Any) }], // Fulfills plan or proposal
"replaces" : [{ Reference(CommunicationRequest) }], // Request(s) replaced by this request
"groupIdentifier" : { Identifier }, // Composite request this is part of
"status" : "<code>", // R! draft | active | on-hold | revoked | completed | entered-in-error | unknown
"statusReason" : { CodeableConcept }, // Reason for current status
"category" : [{ CodeableConcept }], // Message category
"priority" : "<code>", // routine | urgent | asap | stat
"doNotPerform" : <boolean>, // True if request is prohibiting action
"medium" : [{ CodeableConcept }], // A channel of communication
"subject" : { Reference(Patient|Group) }, // Focus of message
"about" : [{ Reference(Any) }], // Resources that pertain to this communication request
"encounter" : { Reference(Encounter) }, // Encounter created as part of
"payload" : [{ // Message payload
// content[x]: Message part content. One of these 3:
"contentString" : "<string>"
"contentAttachment" : { Attachment }
"contentReference" : { Reference(Any) }
}],
// occurrence[x]: When scheduled. One of these 2:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"authoredOn" : "<dateTime>", // When request transitioned to being actionable
"requester" : { Reference(Practitioner|PractitionerRole|Organization|
Patient|RelatedPerson|Device) }, // Who/what is requesting service
"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 }], // Why is communication needed?
"reasonReference" : [{ Reference(Condition|Observation|DiagnosticReport|
DocumentReference) }], // Why is communication needed?
"note" : [{ Annotation }] // Comments made about communication request
}
CommunicationRequest Search Parameters
The following search parameters can be used to query CommunicationRequest resources. Just submit them like so:
https://api.1up.health/fhir/r4/CommunicationRequest?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
authored | date | authoredOn |
based-on | reference | basedOn |
category | text | category |
encounter | reference | encounter |
group-identifier | text | groupIdentifier |
identifier | text | identifier |
medium | text | medium |
occurrence | date | occurrence |
patient | reference | subject.where |
priority | text | priority |
recipient | reference | recipient |
replaces | reference | replaces |
requester | reference | requester |
sender | reference | sender |
status | text | status |
subject | reference | subject |
