8
8
description : " APIs to fetch and receive basic patient information. These API facilitates various
9
9
Opal functionality. At a minimum, the patient demographics lookup must be supported in order for Opal
10
10
to successfully complete a patient registration."
11
- version : 1.0 .0
11
+ version : 1.1 .0
12
12
13
13
tags :
14
14
- name : demographics
15
15
description : Endpoints for accessing patient demographic information
16
16
- name : historical data
17
17
description : Endpoints for providing historical patient data for newly registered Opal patients
18
+ - name : update source
19
+ description : Endpoints for updating the source data with information about the patient from Opal
18
20
- name : wait room
19
21
description : Endpoints for updating a hospital with waiting room management information about a patient
20
22
@@ -127,12 +129,12 @@ paths:
127
129
type : string
128
130
example : " The patient could not be found."
129
131
130
- /uploadPatientMeasurementDocument :
132
+ /addPatientMeasurementDocument :
131
133
post :
132
134
tags :
133
- - wait room
134
- summary : Upload patient measurement PDF document
135
- description : " Update the hospital with a PDF document containing patient measurements information ."
135
+ - update source
136
+ summary : Add weight measurement document to patient chart
137
+ description : " Add a PDF containing a patient's weight measurement information to the patient chart in the source system ."
136
138
requestBody :
137
139
required : true
138
140
content :
@@ -146,19 +148,72 @@ paths:
146
148
site :
147
149
type : string
148
150
example : " XXX"
149
- reportContent :
151
+ document :
152
+ type : string
153
+ example : " VERY_LONG_REPORT_PDF_BASE64_ENCODED_STRING"
154
+ documentDatetime :
155
+ type : string
156
+ format : date-time
157
+ example : " 2024-07-08T11:25:10Z"
158
+ responses :
159
+ ' 200 ' :
160
+ description : Document added successfully
161
+ ' 400 ' :
162
+ description : Invalid JSON or Parameters
163
+ content :
164
+ application/json :
165
+ schema :
166
+ type : object
167
+ properties :
168
+ status :
169
+ type : string
170
+ example : " 400"
171
+ message :
172
+ type : string
173
+ example : " Invalid mrn or site provided."
174
+ ' 404 ' :
175
+ description : The patient could not be found
176
+ content :
177
+ application/json :
178
+ schema :
179
+ type : object
180
+ properties :
181
+ status :
182
+ type : string
183
+ example : " 404"
184
+ message :
185
+ type : string
186
+ example : " The patient could not be found."
187
+
188
+ /addPatientQuestionnaireDocument :
189
+ post :
190
+ tags :
191
+ - update source
192
+ summary : Add questionnaire document to patient chart
193
+ description : " Add a PDF containing a patient's questionnaire data to the patient chart in the source system."
194
+ requestBody :
195
+ required : true
196
+ content :
197
+ application/json :
198
+ schema :
199
+ type : object
200
+ properties :
201
+ mrn :
202
+ type : string
203
+ example : " 1111111"
204
+ site :
150
205
type : string
151
- example : " VERY_LONG_REPORT_PDF_ENCODED_STRING "
152
- docNumber :
206
+ example : " XXX "
207
+ document :
153
208
type : string
154
- example : " MU-4183 "
155
- documentDate :
209
+ example : " VERY_LONG_REPORT_PDF_BASE64_ENCODED_STRING "
210
+ documentDatetime :
156
211
type : string
157
212
format : date-time
158
213
example : " 2024-07-08T11:25:10Z"
159
214
responses :
160
215
' 200 ' :
161
- description : Document uploaded successfully
216
+ description : Document added successfully
162
217
' 400 ' :
163
218
description : Invalid JSON or Parameters
164
219
content :
0 commit comments