CommunicationRequest

Trial Use 2 Clinical — Care Provision

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.

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/CommunicationRequest

Interaction	Method	Path
Read	GET	/fhir/R4/CommunicationRequest/[id]
Vread	GET	/fhir/R4/CommunicationRequest/[id]/_history/[vid]
Update	PUT	/fhir/R4/CommunicationRequest/[id]
Patch	PATCH	/fhir/R4/CommunicationRequest/[id]
Delete	DELETE	/fhir/R4/CommunicationRequest/[id]
Create	POST	/fhir/R4/CommunicationRequest
Search	GET	/fhir/R4/CommunicationRequest
History	GET	/fhir/R4/CommunicationRequest/[id]/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	Unique identifier
basedOn	Reference	0..*	Fulfills plan or proposal
replaces	Reference	0..*	Request(s) replaced by this request
groupIdentifier	Identifier	0..1	Composite request this is part of
status	code	1..1	draft | active | on-hold | revoked | completed | entered-in-error | unknown modifier
statusReason	CodeableConcept	0..1	Reason for current status
category	CodeableConcept	0..*	Message category
priority	code	0..1	routine | urgent | asap | stat
doNotPerform	boolean	0..1	True if request is prohibiting action modifier
medium	CodeableConcept	0..*	A channel of communication
subject	Reference	0..1	Focus of message
about	Reference	0..*	Resources that pertain to this communication request
encounter	Reference	0..1	Encounter created as part of
payload	BackboneElement	0..*	Message payload
occurrence[x]	dateTime / Period	0..1	When scheduled
authoredOn	dateTime	0..1	When request transitioned to being actionable
requester	Reference	0..1	Who/what is requesting service
recipient	Reference	0..*	Message recipient
sender	Reference	0..1	Message sender
reasonCode	CodeableConcept	0..*	Why is communication needed?
reasonReference	Reference	0..*	Why is communication needed?
note	Annotation	0..*	Comments made about communication request

Resource-specific search parameters

Parameter	Type	Description
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
authored	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-authored
based-on	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-based-on
category	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-category
encounter	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-encounter
group-identifier	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-group-identifier
identifier	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-identifier
medium	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-medium
occurrence	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-occurrence
patient	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-patient
priority	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-priority
priority-order	string	https://medplum.com/fhir/SearchParameter/priority-order
recipient	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-recipient
replaces	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-replaces
requester	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-requester
sender	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-sender
status	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-status
subject	string	http://hl7.org/fhir/SearchParameter/CommunicationRequest-subject

Reference

• Official FHIR R4 spec: CommunicationRequest
• Maturity: Trial Use 2 (FMM 2).