CommunicationRequest
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
dev
https://api.sandbox.ovok.com/fhir/R5/CommunicationRequest| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R5/CommunicationRequest/[id] |
| Vread | GET | /fhir/R5/CommunicationRequest/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/CommunicationRequest/[id] |
| Patch | PATCH | /fhir/R5/CommunicationRequest/[id] |
| Delete | DELETE | /fhir/R5/CommunicationRequest/[id] |
| Create | POST | /fhir/R5/CommunicationRequest |
| Search | GET | /fhir/R5/CommunicationRequest?... |
| History | GET | /fhir/R5/CommunicationRequest/[id]/_history |
| Type-history | GET | /fhir/R5/CommunicationRequest/_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 |
statusReason | CodeableConcept | 0..1 | Reason for current status |
intent | code | 1..1 | proposal |
category | CodeableConcept | 0..* | Message category |
priority | code | 0..1 | routine |
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 | The Encounter during which this CommunicationRequest was created |
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 asks for the information to be shared |
recipient | Reference | 0..* | Who to share the information with |
informationProvider | Reference | 0..* | Who should share the information |
reason | CodeableReference | 0..* | Why is communication needed? |
note | Annotation | 0..* | Comments made about communication request |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
authored | date | When request transitioned to being actionable |
based-on | reference | Fulfills plan or proposal |
category | token | Message category |
encounter | reference | Encounter related to the activity recorded in the AuditEvent |
group-identifier | token | Composite request this is part of |
identifier | token | Account number |
information-provider | reference | Who should share the information |
medium | token | A channel of communication |
occurrence | date | When scheduled |
patient | reference | The entity that caused the expenses |
priority | token | routine |
recipient | reference | Who to share the information with |
replaces | reference | Request(s) replaced by this request |
requester | reference | Who asks for the information to be shared |
status | token | draft |
subject | reference | Focus of message |
Reference
- Official FHIR R5 spec:
CommunicationRequest - Maturity: Trial Use 2 (FMM 2).