This repository was archived by the owner on May 7, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 119
Expand file tree
/
Copy pathcommunication.yaml
More file actions
227 lines (216 loc) · 6.44 KB
/
communication.yaml
File metadata and controls
227 lines (216 loc) · 6.44 KB
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
---
name: Communication
field_name_base_url: https://hl7.org/fhir/r4/communication-definitions.html#Communication
fields:
- name: resourceType
required: 'Yes'
cardinality: 1..1
type: string
description: The type of the FHIR resource.
url: https://hl7.org/fhir/r4/Communication-definitions.html#Communication
note: The resourceType must be 'Communication'.
action: create
example: |
{
"resourceType": "Communication"
}
- name: status
required: 'Yes'
cardinality: 1..1
type: code
description: The status of the communication.
url: https://hl7.org/fhir/r4/communication-definitions.html#Communication.status
action: create
note: All communications must be in 'completed' status.
example: |
{
"status": "completed"
}
- name: category
required: 'Yes'
cardinality: 0..1
type: CodeableConcept
description: Codeable definition of the communication type.
url: https://hl7.org/fhir/r4/communication-definitions.html#Communication.category
note: |
<ul>
<li>Only CommunicationCategory values of <code>notification</code> is supported.</li>
</ul>
example: |
{
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/communication-category",
"code": "notification"
}
]
}
]
}
action:
- terminology
- create
binding:
description: The category of the communication.
terminology:
- display: Communication Category
system: http://terminology.hl7.org/CodeSystem/communication-category
info_link: https://hl7.org/fhir/R4/valueset-communication-category.html
- display: SNOMED CT
system: http://snomed.info/sct
info_link: https://hl7.org/fhir/r4/snomedct.html
- name: priority
required: 'No'
cardinality: 0..1
type: code
description: The priority of the communication.
url: https://hl7.org/fhir/r4/communication-definitions.html#Communication.priority
action: create
note: Only 'routine' and 'urgent' priorities are supported.
example: |
{
"priority": "routine"
}
- name: subject
required: 'No'
cardinality: 0..1
type: Reference (Patient)
description: The patient that is the focus of the communication.
url: https://hl7.org/fhir/r4/communication-definitions.html#Communication.subject
action: create
note: Only Patient is supported as subject.
example: |
{
"subject": {
"reference": "Patient/9836548"
}
}
- name: topic
required: 'No'
cardinality: 0..1
type: code
description: The topic of the communication, similar to the subject field of an email.
url: https://hl7.org/fhir/r4/communication-definitions.html#Communication.topic
note: Currently only free-text topics are supported.
example: |
{
"topic" : {
"text": "Patient Consult Request"
}
}
action: create
- name: encounter
required: 'No'
cardinality: 0..1
type: Reference (Encounter)
note: Subject is required when writing an encounter.
description: The encounter associated to the communication.
url: https://hl7.org/fhir/r4/communication-definitions.html#Communication.encounter
example: |
{
"encounter" : {
"reference" : "Encounter/89363836"
}
}
action: create
- name: recipient
required: 'Yes'
cardinality: 1..*
type: Reference (Practitioner, Group)
description: The entity receiving the communication.
url: https://hl7.org/fhir/r4/communication-definitions.html#Communication.recipient
note: Each recipient must be a Practitioner or Group.
example: |
{
"recipient": [
{
"reference" : "Practitioner/6373634"
},
{
"reference" : "Group/44466678"
}
]
}
action: create
- name: sender
required: 'Yes'
cardinality: 1..1
type: Reference (Practitioner)
description: The entity sending the communication.
url: https://hl7.org/fhir/r4/communication-definitions.html#Communication.sender
note: The sender must be a Practitioner.
example: |
{
"sender": {
"reference": "Practitioner/631923"
}
}
action: create
- name: payload
required: 'Yes'
cardinality: 1..1
type: BackboneElement
description: The text of the communication.
url: https://hl7.org/fhir/r4/communication-definitions.html#Communication.payload
note: |
<ul>
<li>content must be supplied as a contentAttachment with contentType and data defined</li>
<li>contentType can be set to:
<ul>
<li>application/xhtml+xml</li>
<li>text/plain</li>
</ul>
</li>
<li>contentType can contain a charset set to:
<ul>
<li>utf-8</li>
<li>us-ascii</li>
</ul>
</li>
<li>data should be base64 encoded</li>
<li>If the contentType is "application/xhtml+xml", then the data (when decoded) should at least contain the
following:
<pre><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><body></body></html></pre>
</li>
</ul>
example: |
{
"payload" : [
{
"contentAttachment" : {
"contentType" : "application/xhtml+xml",
"data" : "PCFET0NUWVBFIGh0bWwgUFVCTElDICItLy9XM0MvL0RURCBYSFRNTCAxLjAgVHJhbnNpdGlvbmFsLy9FTiIKImh0dHA6Ly93d3cudzMub3JnL1RSL3hodG1sMS9EVEQveGh0bWwxLXRyYW5zaXRpb25hbC5kdGQiPjxodG1sPjxib2R5PjwvYm9keT48L2h0bWw+"
}
}
]
}
action:
- create
- name: email-status
description: The status of the email. May be received, in-progress or completed.
action: terminology
url: https://fhir-ehr.cerner.com/r4/StructureDefinition/email-status?_format=json
binding:
description: The status of the email. May be received, in-progress or completed.
terminology:
- display: Communication Email Status Extension
system: http://hl7.org/fhir/task-status
info_link: https://www.hl7.org/fhir/r4/valueset-task-status.html
- name: reply-to
terminology_name: extension[x].valueReference
required: 'No'
type: Reference (Group)
description: The entity replies will be directed to.
note: The reply-to must be a Group.
action: create
example: |
{
"url": "https://fhir-ehr.cerner.com/r4/StructureDefinition/reply-to",
"valueReference": {
"reference": "Group/123"
}
}
url: https://fhir-ehr.cerner.com/r4/StructureDefinition/reply-to?_format=json