1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
//! CommunicationRequest
//!
//! URL: http://hl7.org/fhir/StructureDefinition/CommunicationRequest
//!
//! Version: 5.0.0
//!
//! CommunicationRequest Resource: 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.
//!
//! FHIR: <https://build.fhir.org/>
//!
//! UML: <https://build.fhir.org/uml.html>
// Allow unused crate::r5::types as types;
#![allow(unused_imports)]
use crate::r5::types;
use ::serde::{Deserialize, Serialize};
use fhir_derive_macros::Validate;
/// 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. It records the intent to
/// communicate, who should be involved, and what payload should be conveyed, and is
/// commonly used to schedule or prompt future communications within a workflow.
///
/// Clinically and administratively, `CommunicationRequest` supports order-driven or
/// decision-support-driven messaging: it captures the requester, the intended
/// recipient(s) or information provider(s), the subject the communication concerns,
/// the reason it is needed, and the timing (either a fixed date/time or a period)
/// during which the communication should occur. Its status and intent codes track
/// the request through a typical workflow lifecycle, from `draft` or `proposal`
/// through to `active`, `completed`, or `revoked`. Once the communication has
/// actually taken place, the corresponding event is recorded using the related
/// `Communication` resource, which references the fulfilled request via `based_on`.
///
/// # Related resources
///
/// - `Communication` — records the actual communication event that fulfills this request.
/// - [`Patient`](crate::r5::resources::patient::Patient) — commonly referenced as the `subject` or `about` this request concerns.
/// - [`CodeableConcept`](crate::r5::types::CodeableConcept) — used for `category`, `medium`, and `status_reason`.
/// - [`Reference`](crate::r5::types::Reference) — used for `requester`, `recipient`, and `information_provider`.
///
/// # Examples
///
/// ```
/// use fhir::r5::resources::communication_request::CommunicationRequest;
///
/// let value = CommunicationRequest::default();
/// let json = ::serde_json::to_value(&value).unwrap();
/// let back: CommunicationRequest = ::serde_json::from_value(json).unwrap();
/// assert_eq!(value, back);
/// ```
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct CommunicationRequest {
/// Logical id of this artifact
pub id: Option<types::String>,
/// Metadata about the resource
pub meta: Option<types::Meta>,
/// A set of rules under which this content was created
pub implicit_rules: Option<types::Uri>,
/// Language of the resource content
pub language: Option<types::Code>,
/// Text summary of the resource, for human interpretation
pub text: Option<types::Narrative>,
/// Contained, inline Resources
pub contained: Option<Vec<::serde_json::Value>>,
/// Additional content defined by implementations
pub extension: Option<Vec<types::Extension>>,
/// Extensions that cannot be ignored
pub modifier_extension: Option<Vec<types::Extension>>,
/// Unique identifier
pub identifier: Option<Vec<types::Identifier>>,
/// Fulfills plan or proposal
pub based_on: Option<Vec<types::Reference>>,
/// Request(s) replaced by this request
pub replaces: Option<Vec<types::Reference>>,
/// Composite request this is part of
pub group_identifier: Option<types::Identifier>,
/// The current lifecycle status of the request: draft | active | on-hold | revoked | completed | entered-in-error | unknown.
pub status: types::Code,
/// Reason for current status
pub status_reason: Option<types::CodeableConcept>,
/// Indicates the level of authority the request carries in the workflow, e.g. proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option.
pub intent: types::Code,
/// Message category
pub category: Option<Vec<types::CodeableConcept>>,
/// routine | urgent | asap | stat
pub priority: Option<types::Code>,
/// True if request is prohibiting action
pub do_not_perform: Option<types::Boolean>,
/// A channel of communication
pub medium: Option<Vec<types::CodeableConcept>>,
/// The patient or group that is the focus of this communication request.
pub subject: Option<types::Reference>,
/// Resources that pertain to this communication request
pub about: Option<Vec<types::Reference>>,
/// The Encounter during which this CommunicationRequest was created
pub encounter: Option<types::Reference>,
/// Message payload
pub payload: Option<Vec<CommunicationRequestPayload>>,
/// When scheduled
pub occurrence_date_time: Option<types::DateTime>,
/// When scheduled
pub occurrence_period: Option<types::Period>,
/// When request transitioned to being actionable
pub authored_on: Option<types::DateTime>,
/// Who asks for the information to be shared
pub requester: Option<types::Reference>,
/// Who to share the information with
pub recipient: Option<Vec<types::Reference>>,
/// Who should share the information
pub information_provider: Option<Vec<types::Reference>>,
/// Why is communication needed?
pub reason: Option<Vec<types::CodeableReference>>,
/// Comments made about communication request
pub note: Option<Vec<types::Annotation>>,
}
/// CommunicationRequestPayload
///
/// Text, attachment(s), or resource(s) to be communicated to the recipient.
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct CommunicationRequestPayload {
/// Unique id for inter-element referencing
pub id: Option<types::String>,
/// Additional content defined by implementations
pub extension: Option<Vec<types::Extension>>,
/// Extensions that cannot be ignored even if unrecognized
pub modifier_extension: Option<Vec<types::Extension>>,
/// Message part content
pub content_attachment: Option<types::Attachment>,
/// Message part content
pub content_reference: Option<types::Reference>,
/// Message part content
pub content_codeable_concept: Option<types::CodeableConcept>,
}
#[cfg(test)]
mod tests {
use super::*;
type T = CommunicationRequest;
#[test]
fn test_default() {
let _ = T::default();
}
#[test]
fn test_serde_round_trip() {
let value = T::default();
let json = ::serde_json::to_value(&value).expect("to_value");
let back: T = ::serde_json::from_value(json).expect("from_value");
assert_eq!(value, back);
}
}