CommunicationRequest

ResourceClinical · Request & ResponseTrial useMaturity 2

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

16 of 16 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Unique identifier
basedOnΣ	0..*	Reference(Resource)	Fulfills plan or proposal
replacesΣ	0..*	Reference(CommunicationRequest)	Request(s) replaced by this request
groupIdentifierΣ	0..1	Identifier	Composite request this is part of
statusRequired?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknownBinding (required): request-status
statusReason	0..1	CodeableConcept	Reason for current status
category	0..*	CodeableConcept	Message categoryBinding (example): communication-category
priorityΣ	0..1	code	routine | urgent | asap | statBinding (required): request-priority
doNotPerform?!Σ	0..1	boolean	True if request is prohibiting action
medium	0..*	CodeableConcept	A channel of communicationBinding (example): v3-ParticipationMode
subject	0..1	Reference(Patient | Group)	Focus of message
about	0..*	Reference(Resource)	Resources that pertain to this communication request
encounterΣ	0..1	Reference(Encounter)	Encounter created as part of
payload	0..*	BackboneElement	Message payload
content[x]Required	1..1	string | Attachment | Reference(Resource)	Message part content
occurrence[x]Σ	0..1	dateTime | Period	When scheduled
authoredOnΣ	0..1	dateTime	When request transitioned to being actionable
requesterΣ	0..1	Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)	Who/what is requesting service
recipient	0..*	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService)	Message recipient
senderΣ	0..1	Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService)	Message sender
reasonCodeΣ	0..*	CodeableConcept	Why is communication needed?Binding (example): v3-ActReason
reasonReferenceΣ	0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Why is communication needed?
note	0..*	Annotation	Comments made about communication request

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/CommunicationRequest?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
authored	date	When request transitioned to being actionable CommunicationRequest.authoredOn
based-on	reference	Fulfills plan or proposal CommunicationRequest.basedOn
category	token	Message category CommunicationRequest.category
encounter	reference	Encounter created as part of CommunicationRequest.encounter
group-identifier	token	Composite request this is part of CommunicationRequest.groupIdentifier
identifier	token	Unique identifier CommunicationRequest.identifier
medium	token	A channel of communication CommunicationRequest.medium
occurrence	date	When scheduled (CommunicationRequest.occurrence.ofType(dateTime))
patient	reference	Focus of message CommunicationRequest.subject.where(resolve() is Patient)
priority	token	routine | urgent | asap | stat CommunicationRequest.priority
recipient	reference	Message recipient CommunicationRequest.recipient
replaces	reference	Request(s) replaced by this request CommunicationRequest.replaces
requester	reference	Who/what is requesting service CommunicationRequest.requester
sender	reference	Message sender CommunicationRequest.sender
status	token	draft | active | on-hold | revoked | completed | entered-in-error | unknown CommunicationRequest.status
subject	reference	Focus of message CommunicationRequest.subject

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition