Patient
Care
![]() | Maturity Level : 2 | Trial Use | Security Category : Patient | Compartments : Device , Encounter , Patient , Practitioner , RelatedPerson |
A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
CommunicationRequest is one of the request resources in the FHIR workflow specification.
This resource is a record of a request for a communication to be performed. A communication is a conveyance of information from one entity, a sender, to another entity, a receiver. The requester requests the sender to send the payload to the recipient. The sender and receivers may be patients, practitioners, related persons, organizations, and devices. Uses of communication request include:
This resource is a record of a request. It does not represent the actual flow of communication.
The use of CommunicationRequest excludes requests for referrals and requests for therapy or counseling which would be handled by the ServiceRequest resource. The performance of a CommunicationRequest may result in a Communication resource.
This
resource
is
referenced
by
CarePlan
,
ClaimResponse
and
itself
itself.
This resource implements the Request pattern.
Structure
Name | Flags | Card. | Type |
Description
&
Constraints
![]() |
---|---|---|---|---|
![]() ![]() | TU | DomainResource |
A
request
for
information
to
be
sent
to
a
receiver
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension | |
![]() ![]() ![]() | Σ | 0..* | Identifier |
Unique
identifier
|
![]() ![]() ![]() | Σ | 0..* | Reference ( Any ) |
Fulfills
plan
or
proposal
|
![]() ![]() ![]() | Σ | 0..* | Reference ( CommunicationRequest ) |
Request(s)
replaced
by
this
request
|
![]() ![]() ![]() | Σ | 0..1 | Identifier | Composite request this is part of |
![]() ![]() ![]() | ?! Σ | 1..1 | code |
draft
|
active
|
on-hold
|
revoked
|
completed
|
entered-in-error
|
unknown
RequestStatus ( Required ) |
![]() ![]() ![]() | 0..1 | CodeableConcept |
Reason
for
current
status
CommunicationRequest Status Reason ( Example ) | |
![]() ![]() ![]() | 0..* | CodeableConcept |
Message
category
CommunicationCategory ( Example ) | |
![]() ![]() ![]() | Σ | 0..1 | code |
routine
|
urgent
|
asap
|
stat
|
![]() ![]() ![]() | ?! Σ | 0..1 | boolean | True if request is prohibiting action |
![]() ![]() ![]() | 0..* | CodeableConcept |
A
channel
of
communication
![]() | |
![]() ![]() ![]() | 0..1 | Reference ( Patient | Group ) | Focus of message | |
![]() ![]() ![]() | 0..* | Reference ( Any ) |
Resources
that
pertain
to
this
communication
request
| |
![]() ![]() ![]() | Σ | 0..1 | Reference ( Encounter ) |
The
Encounter
during
which
this
CommunicationRequest
was
created
|
![]() ![]() ![]() | 0..* | BackboneElement |
Message
payload
| |
![]() ![]() ![]() ![]() | 1..1 | Message part content | ||
![]() ![]() ![]() ![]() ![]() |
| |||
![]() ![]() ![]() ![]() ![]() |
| |||
![]() ![]() ![]() ![]() ![]() |
| |||
![]() ![]() ![]() | Σ | 0..1 | When scheduled | |
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() | Period | |||
![]() ![]() ![]() | Σ | 0..1 | dateTime | When request transitioned to being actionable |
![]() ![]() ![]() | Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device ) |
|
![]() ![]() ![]() | 0..* | Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | Endpoint ) |
| |
![]() ![]() ![]() | Σ |
| Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint ) |
|
![]() ![]() ![]() | Σ | 0..* |
|
Why
is
communication
needed?
![]() |
![]() ![]() ![]() | 0..* | Annotation |
Comments
made
about
communication
request
| |
![]() |
UML Diagram ( Legend )
XML Template
<CommunicationRequest xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Unique identifier --></identifier> <basedOn><!-- 0..* Reference(Any) Fulfills plan or proposal --></basedOn> <replaces><!-- 0..* Reference(CommunicationRequest) Request(s) replaced by this request --></replaces> <groupIdentifier><!-- 0..1 Identifier Composite request this is part of --></groupIdentifier> <status value="[code]"/><!-- 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown -->
<</statusReason><statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason> <category><!-- 0..* CodeableConcept Message category --></category> <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat --> <doNotPerform value="[boolean]"/><!-- 0..1 True if request is prohibiting action --><</medium> <</subject><medium><!-- 0..* CodeableConcept A channel of communication--></medium> <subject><!-- 0..1 Reference(Group|Patient) Focus of message --></subject> <about><!-- 0..* Reference(Any) Resources that pertain to this communication request --></about>
<</encounter><encounter><!-- 0..1 Reference(Encounter) The Encounter during which this CommunicationRequest was created --></encounter> <payload> <!-- 0..* Message payload --><</content[x]><content[x]><!-- 1..1 Attachment|Reference(Any)|CodeableConcept Message part content --></content[x]> </payload> <occurrence[x]><!-- 0..1 dateTime|Period When scheduled --></occurrence[x]> <authoredOn value="[dateTime]"/><!-- 0..1 When request transitioned to being actionable --><| </requester> <| </recipient> <| </sender> <</reasonCode> <| </reasonReference><requester><!-- 0..1 Reference(Device|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Who asks for the information to be shared --></requester> <recipient><!-- 0..* Reference(CareTeam|Device|Endpoint|Group|HealthcareService| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Who to share the information with --></recipient> <informationProvider><!-- 0..* Reference(Device|Endpoint|HealthcareService| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Who should share the information --></informationProvider> <reason><!-- 0..* CodeableReference(Any) Why is communication needed?--></reason> <note><!-- 0..* Annotation Comments made about communication request --></note> </CommunicationRequest>
JSON Template
{"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(Group|Patient) }, // Focus of message "about" : [{ Reference(Any) }], // Resources that pertain to this communication request
""encounter" : { Reference(Encounter) }, // The Encounter during which this CommunicationRequest was created "payload" : [{ // Message payload // content[x]: Message part content. One of these 3:">""contentAttachment" : { Attachment } "contentReference" : { Reference(Any) } "contentCodeableConcept" : { CodeableConcept } }], // occurrence[x]: When scheduled. One of these 2: "occurrenceDateTime" : "<dateTime>", "occurrencePeriod" : { Period }, "authoredOn" : "<dateTime>", // When request transitioned to being actionable"| "| "| " "|"requester" : { Reference(Device|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) }, // Who asks for the information to be shared "recipient" : [{ Reference(CareTeam|Device|Endpoint|Group|HealthcareService| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }], // Who to share the information with "informationProvider" : [{ Reference(Device|Endpoint|HealthcareService| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }], // Who should share the information "reason" : [{ CodeableReference(Any) }], // Why is communication needed?"note" : [{ Annotation }] // Comments made about communication request }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:CommunicationRequest; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:CommunicationRequest.identifier [ Identifier ], ... ; # 0..* Unique identifier fhir:CommunicationRequest.basedOn [ Reference(Any) ], ... ; # 0..* Fulfills plan or proposal fhir:CommunicationRequest.replaces [ Reference(CommunicationRequest) ], ... ; # 0..* Request(s) replaced by this request fhir:CommunicationRequest.groupIdentifier [ Identifier ]; # 0..1 Composite request this is part of fhir:CommunicationRequest.status [ code ]; # 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown fhir:CommunicationRequest.statusReason [ CodeableConcept ]; # 0..1 Reason for current status fhir:CommunicationRequest.category [ CodeableConcept ], ... ; # 0..* Message category fhir:CommunicationRequest.priority [ code ]; # 0..1 routine | urgent | asap | stat fhir:CommunicationRequest.doNotPerform [ boolean ]; # 0..1 True if request is prohibiting action fhir:CommunicationRequest.medium [ CodeableConcept ], ... ; # 0..* A channel of communication
fhir:fhir:CommunicationRequest.subject [ Reference(Group|Patient) ]; # 0..1 Focus of message fhir:CommunicationRequest.about [ Reference(Any) ], ... ; # 0..* Resources that pertain to this communication requestfhir:fhir:CommunicationRequest.encounter [ Reference(Encounter) ]; # 0..1 The Encounter during which this CommunicationRequest was created fhir:CommunicationRequest.payload [ # 0..* Message payload # CommunicationRequest.payload.content[x] : 1..1 Message part content. One of these 3fhir: ]fhir:CommunicationRequest.payload.contentAttachment [ Attachment ] fhir:CommunicationRequest.payload.contentReference [ Reference(Any) ] fhir:CommunicationRequest.payload.contentCodeableConcept [ CodeableConcept ] ], ...; # CommunicationRequest.occurrence[x] : 0..1 When scheduled. One of these 2 fhir:CommunicationRequest.occurrenceDateTime [ dateTime ] fhir:CommunicationRequest.occurrencePeriod [ Period ] fhir:CommunicationRequest.authoredOn [ dateTime ]; # 0..1 When request transitioned to being actionablefhir: fhir:| fhir:| fhir: fhir:fhir:CommunicationRequest.requester [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who asks for the information to be shared fhir:CommunicationRequest.recipient [ Reference(CareTeam|Device|Endpoint|Group|HealthcareService|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 0..* Who to share the information with fhir:CommunicationRequest.informationProvider [ Reference(Device|Endpoint|HealthcareService|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) ], ... ; # 0..* Who should share the information fhir:CommunicationRequest.reason [ CodeableReference(Any) ], ... ; # 0..* Why is communication needed? fhir:CommunicationRequest.note [ Annotation ], ... ; # 0..* Comments made about communication request ]
Changes since R3
CommunicationRequest | |
CommunicationRequest.status |
|
CommunicationRequest.priority |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). )
Structure
Name | Flags | Card. | Type |
Description
&
Constraints
![]() |
---|---|---|---|---|
![]() ![]() | TU | DomainResource |
A
request
for
information
to
be
sent
to
a
receiver
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension | |
![]() ![]() ![]() | Σ | 0..* | Identifier |
Unique
identifier
|
![]() ![]() ![]() | Σ | 0..* | Reference ( Any ) |
Fulfills
plan
or
proposal
|
![]() ![]() ![]() | Σ | 0..* | Reference ( CommunicationRequest ) |
Request(s)
replaced
by
this
request
|
![]() ![]() ![]() | Σ | 0..1 | Identifier | Composite request this is part of |
![]() ![]() ![]() | ?! Σ | 1..1 | code |
draft
|
active
|
on-hold
|
revoked
|
completed
|
entered-in-error
|
unknown
RequestStatus ( Required ) |
![]() ![]() ![]() | 0..1 | CodeableConcept |
Reason
for
current
status
CommunicationRequest Status Reason ( Example ) | |
![]() ![]() ![]() | 0..* | CodeableConcept |
Message
category
CommunicationCategory ( Example ) | |
![]() ![]() ![]() | Σ | 0..1 | code |
routine
|
urgent
|
asap
|
stat
|
![]() ![]() ![]() | ?! Σ | 0..1 | boolean | True if request is prohibiting action |
![]() ![]() ![]() | 0..* | CodeableConcept |
A
channel
of
communication
![]() | |
![]() ![]() ![]() | 0..1 | Reference ( Patient | Group ) | Focus of message | |
![]() ![]() ![]() | 0..* | Reference ( Any ) |
Resources
that
pertain
to
this
communication
request
| |
![]() ![]() ![]() | Σ | 0..1 | Reference ( Encounter ) |
The
Encounter
during
which
this
CommunicationRequest
was
created
|
![]() ![]() ![]() | 0..* | BackboneElement |
Message
payload
| |
![]() ![]() ![]() ![]() | 1..1 | Message part content | ||
![]() ![]() ![]() ![]() ![]() |
| |||
![]() ![]() ![]() ![]() ![]() |
| |||
![]() ![]() ![]() ![]() ![]() |
| |||
![]() ![]() ![]() | Σ | 0..1 | When scheduled | |
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() | Period | |||
![]() ![]() ![]() | Σ | 0..1 | dateTime | When request transitioned to being actionable |
![]() ![]() ![]() | Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device ) |
|
![]() ![]() ![]() | 0..* | Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService | Endpoint ) |
| |
![]() ![]() ![]() | Σ |
| Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint ) |
|
![]() ![]() ![]() | Σ | 0..* |
|
Why
is
communication
needed?
![]() |
![]() ![]() ![]() | 0..* | Annotation |
Comments
made
about
communication
request
| |
![]() |
XML Template
<CommunicationRequest xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Unique identifier --></identifier> <basedOn><!-- 0..* Reference(Any) Fulfills plan or proposal --></basedOn> <replaces><!-- 0..* Reference(CommunicationRequest) Request(s) replaced by this request --></replaces> <groupIdentifier><!-- 0..1 Identifier Composite request this is part of --></groupIdentifier> <status value="[code]"/><!-- 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown -->
<</statusReason><statusReason><!-- 0..1 CodeableConcept Reason for current status --></statusReason> <category><!-- 0..* CodeableConcept Message category --></category> <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat --> <doNotPerform value="[boolean]"/><!-- 0..1 True if request is prohibiting action --><</medium> <</subject><medium><!-- 0..* CodeableConcept A channel of communication--></medium> <subject><!-- 0..1 Reference(Group|Patient) Focus of message --></subject> <about><!-- 0..* Reference(Any) Resources that pertain to this communication request --></about>
<</encounter><encounter><!-- 0..1 Reference(Encounter) The Encounter during which this CommunicationRequest was created --></encounter> <payload> <!-- 0..* Message payload --><</content[x]><content[x]><!-- 1..1 Attachment|Reference(Any)|CodeableConcept Message part content --></content[x]> </payload> <occurrence[x]><!-- 0..1 dateTime|Period When scheduled --></occurrence[x]> <authoredOn value="[dateTime]"/><!-- 0..1 When request transitioned to being actionable --><| </requester> <| </recipient> <| </sender> <</reasonCode> <| </reasonReference><requester><!-- 0..1 Reference(Device|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Who asks for the information to be shared --></requester> <recipient><!-- 0..* Reference(CareTeam|Device|Endpoint|Group|HealthcareService| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Who to share the information with --></recipient> <informationProvider><!-- 0..* Reference(Device|Endpoint|HealthcareService| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Who should share the information --></informationProvider> <reason><!-- 0..* CodeableReference(Any) Why is communication needed?--></reason> <note><!-- 0..* Annotation Comments made about communication request --></note> </CommunicationRequest>
JSON Template
{"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(Group|Patient) }, // Focus of message "about" : [{ Reference(Any) }], // Resources that pertain to this communication request
""encounter" : { Reference(Encounter) }, // The Encounter during which this CommunicationRequest was created "payload" : [{ // Message payload // content[x]: Message part content. One of these 3:">""contentAttachment" : { Attachment } "contentReference" : { Reference(Any) } "contentCodeableConcept" : { CodeableConcept } }], // occurrence[x]: When scheduled. One of these 2: "occurrenceDateTime" : "<dateTime>", "occurrencePeriod" : { Period }, "authoredOn" : "<dateTime>", // When request transitioned to being actionable"| "| "| " "|"requester" : { Reference(Device|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) }, // Who asks for the information to be shared "recipient" : [{ Reference(CareTeam|Device|Endpoint|Group|HealthcareService| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }], // Who to share the information with "informationProvider" : [{ Reference(Device|Endpoint|HealthcareService| Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }], // Who should share the information "reason" : [{ CodeableReference(Any) }], // Why is communication needed?"note" : [{ Annotation }] // Comments made about communication request }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:CommunicationRequest; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:CommunicationRequest.identifier [ Identifier ], ... ; # 0..* Unique identifier fhir:CommunicationRequest.basedOn [ Reference(Any) ], ... ; # 0..* Fulfills plan or proposal fhir:CommunicationRequest.replaces [ Reference(CommunicationRequest) ], ... ; # 0..* Request(s) replaced by this request fhir:CommunicationRequest.groupIdentifier [ Identifier ]; # 0..1 Composite request this is part of fhir:CommunicationRequest.status [ code ]; # 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown fhir:CommunicationRequest.statusReason [ CodeableConcept ]; # 0..1 Reason for current status fhir:CommunicationRequest.category [ CodeableConcept ], ... ; # 0..* Message category fhir:CommunicationRequest.priority [ code ]; # 0..1 routine | urgent | asap | stat fhir:CommunicationRequest.doNotPerform [ boolean ]; # 0..1 True if request is prohibiting action fhir:CommunicationRequest.medium [ CodeableConcept ], ... ; # 0..* A channel of communication
fhir:fhir:CommunicationRequest.subject [ Reference(Group|Patient) ]; # 0..1 Focus of message fhir:CommunicationRequest.about [ Reference(Any) ], ... ; # 0..* Resources that pertain to this communication requestfhir:fhir:CommunicationRequest.encounter [ Reference(Encounter) ]; # 0..1 The Encounter during which this CommunicationRequest was created fhir:CommunicationRequest.payload [ # 0..* Message payload # CommunicationRequest.payload.content[x] : 1..1 Message part content. One of these 3fhir: ]fhir:CommunicationRequest.payload.contentAttachment [ Attachment ] fhir:CommunicationRequest.payload.contentReference [ Reference(Any) ] fhir:CommunicationRequest.payload.contentCodeableConcept [ CodeableConcept ] ], ...; # CommunicationRequest.occurrence[x] : 0..1 When scheduled. One of these 2 fhir:CommunicationRequest.occurrenceDateTime [ dateTime ] fhir:CommunicationRequest.occurrencePeriod [ Period ] fhir:CommunicationRequest.authoredOn [ dateTime ]; # 0..1 When request transitioned to being actionablefhir: fhir:| fhir:| fhir: fhir:fhir:CommunicationRequest.requester [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who asks for the information to be shared fhir:CommunicationRequest.recipient [ Reference(CareTeam|Device|Endpoint|Group|HealthcareService|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 0..* Who to share the information with fhir:CommunicationRequest.informationProvider [ Reference(Device|Endpoint|HealthcareService|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) ], ... ; # 0..* Who should share the information fhir:CommunicationRequest.reason [ CodeableReference(Any) ], ... ; # 0..* Why is communication needed? fhir:CommunicationRequest.note [ Annotation ], ... ; # 0..* Comments made about communication request ]
Changes since Release 3
CommunicationRequest | |
CommunicationRequest.status |
|
CommunicationRequest.priority |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See R3 <--> R4 Conversion Maps (status = 2 tests that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). )
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis a
Path | Definition | Type | Reference |
---|---|---|---|
CommunicationRequest.status | The status of the communication request. | Required | RequestStatus |
CommunicationRequest.statusReason | Codes identifying the reason for the current state of a request. |
|
|
CommunicationRequest.category | Codes for general categories of communications such as alerts, instruction, etc. | Example | CommunicationCategory |
CommunicationRequest.priority | Codes indicating the relative importance of a communication request. | Required | RequestPriority |
CommunicationRequest.medium | Codes for communication mediums such as phone, fax, email, in person, etc. | Example |
![]() |
CommunicationRequest.reason | Codes for describing reasons for the occurrence of a communication. | Example |
![]() |
Notes to reviewers:
At this time, the code bindings are placeholders to be fleshed out upon further review by the community.
CommunicationRequest.sender allows Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService and CommunicationRequest.recipient allows Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService - but it is not unusual to have a communication target - even a defined one - where it is unknown what kind of role the person is playing.
If the communication request is to or from an individual, whose role is not known (practitioner, patient or related person), - for example, only email address is captured in the system; then RelatedPerson should be used by default.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
authored N | date | When request transitioned to being actionable | CommunicationRequest.authoredOn | |
based-on | reference | Fulfills plan or proposal |
CommunicationRequest.basedOn
(Any) | |
category | token | Message category | CommunicationRequest.category | |
encounter | reference |
The
Encounter
during
which
this
CommunicationRequest
was
created
|
CommunicationRequest.encounter
( Encounter ) | |
group-identifier | token | Composite request this is part of | CommunicationRequest.groupIdentifier | |
identifier | token | Unique identifier | CommunicationRequest.identifier | |
information-provider | reference | Who should share the information |
CommunicationRequest.informationProvider
( Practitioner , Organization , Endpoint , Device , Patient , HealthcareService , PractitionerRole , RelatedPerson ) | |
medium | token | A channel of communication | CommunicationRequest.medium | |
occurrence | date | When scheduled |
| |
patient | reference | Focus of message |
CommunicationRequest.subject.where(resolve()
is
Patient)
( Group , Patient ) | |
priority N | token | routine | urgent | asap | stat | CommunicationRequest.priority | |
recipient | reference |
|
CommunicationRequest.recipient
( Practitioner , Group , Organization , CareTeam , Endpoint , Device , Patient , HealthcareService , PractitionerRole , RelatedPerson ) | |
replaces | reference | Request(s) replaced by this request |
CommunicationRequest.replaces
( CommunicationRequest ) | |
requester | reference |
|
CommunicationRequest.requester
( Practitioner , Organization , Device , Patient , PractitionerRole , RelatedPerson ) | |
| token | draft | active | on-hold | revoked | completed | entered-in-error | unknown | CommunicationRequest.status | |
subject | reference | Focus of message |
CommunicationRequest.subject
( Group , Patient ) |