UNPKG

106 kBJSONView Raw
1{
2 "swagger": "2.0",
3 "info": {
4 "description": "RippleOSI Middle Tier REST APIs",
5 "version": "1.1.0",
6 "title": "Ripple Showcase Stack - Swagger - Open APIs"
7 },
8 "schemes": [
9 "http"
10 ],
11 "tags": [
12 {
13 "name": "Ripple"
14 }
15 ],
16 "securityDefinitions": {
17 "QEWDToken": {
18 "description": "For accessing the API a valid token must be passed in all the queries in the 'Cookies' header. A valid token is generated by the /api/initialise API. The following syntax must be used in the 'Cookie' header : JSESSIONID=xxxxxxx",
19 "type": "apiKey",
20 "name": "Authorization",
21 "in": "header"
22 }
23 },
24 "paths": {
25 "/api/initialise": {
26 "get": {
27 "tags": [
28 "Ripple"
29 ],
30 "description": "Starts a User Session",
31 "parameters": [],
32 "produces": [
33 "application/json"
34 ],
35 "responses": {
36 "200": {
37 "description": "The users session token and mode",
38 "headers": {
39 "X-ResponseTime": {
40 "description": "Back-end response time",
41 "type": "string"
42 }
43 },
44 "schema": {
45 "$ref": "#/definitions/initialiseResponse"
46 }
47 }
48 }
49 }
50 },
51 "/api/ui/{uiType}": {
52 "get": {
53 "tags": [
54 "Ripple"
55 ],
56 "description": "Switch UI between React and Angular versions",
57 "security": [
58 {
59 "QEWDToken": []
60 }
61 ],
62 "produces": [
63 "application/json"
64 ],
65 "parameters": [
66 {
67 "name": "uiType",
68 "in": "path",
69 "description": "UI Type: react or angular",
70 "required": true,
71 "type": "string"
72 }
73 ],
74 "responses": {
75 "200": {
76 "description": "Confirmation of UI swap",
77 "headers": {
78 "X-ResponseTime": {
79 "description": "Back-end response time",
80 "type": "string"
81 }
82 },
83 "schema": {
84 "$ref": "#/definitions/uiResponse"
85 }
86 },
87 "403": {
88 "description": "Missing or invalid authentication credentials"
89 }
90 }
91 }
92 },
93 "/api/application": {
94 "get": {
95 "tags": [
96 "Ripple"
97 ],
98 "description": "Gets user's application settings",
99 "security": [
100 {
101 "QEWDToken": []
102 }
103 ],
104 "produces": [
105 "application/json"
106 ],
107 "parameters": [],
108 "responses": {
109 "200": {
110 "description": "The users application settings",
111 "headers": {
112 "X-ResponseTime": {
113 "description": "Back-end response time",
114 "type": "string"
115 }
116 },
117 "schema": {
118 "$ref": "#/definitions/applicationPayload"
119 }
120 },
121 "403": {
122 "description": "Missing or invalid authentication credentials"
123 }
124 }
125 },
126 "post": {
127 "tags": [
128 "Ripple"
129 ],
130 "description": "Saves user's application settings",
131 "security": [
132 {
133 "QEWDToken": []
134 }
135 ],
136 "produces": [
137 "application/json"
138 ],
139 "parameters": [
140 {
141 "in": "body",
142 "name": "body",
143 "description": "Body Payload containing application settings",
144 "required": true,
145 "schema": {
146 "$ref": "#/definitions/applicationPayload"
147 }
148 }
149 ],
150 "responses": {
151 "200": {
152 "description": "",
153 "headers": {
154 "X-ResponseTime": {
155 "description": "Back-end response time",
156 "type": "string"
157 }
158 },
159 "schema": {
160 "$ref": "#/definitions/applicationSaveResponse"
161 }
162 },
163 "403": {
164 "description": "Missing or invalid authentication credentials"
165 }
166 }
167 },
168 "put": {
169 "tags": [
170 "Ripple"
171 ],
172 "description": "Saves user's application settings",
173 "security": [
174 {
175 "QEWDToken": []
176 }
177 ],
178 "produces": [
179 "application/json"
180 ],
181 "parameters": [
182 {
183 "in": "body",
184 "name": "body",
185 "description": "Body Payload containing application settings",
186 "required": true,
187 "schema": {
188 "$ref": "#/definitions/applicationPayload"
189 }
190 }
191 ],
192 "responses": {
193 "200": {
194 "description": "",
195 "headers": {
196 "X-ResponseTime": {
197 "description": "Back-end response time",
198 "type": "string"
199 }
200 },
201 "schema": {
202 "$ref": "#/definitions/applicationSaveResponse"
203 }
204 },
205 "403": {
206 "description": "Missing or invalid authentication credentials"
207 }
208 }
209 }
210 },
211 "/api/user": {
212 "get": {
213 "tags": [
214 "Ripple"
215 ],
216 "description": "Gets current user's details",
217 "security": [
218 {
219 "QEWDToken": []
220 }
221 ],
222 "produces": [
223 "application/json"
224 ],
225 "parameters": [],
226 "responses": {
227 "200": {
228 "description": "The users details",
229 "headers": {
230 "X-ResponseTime": {
231 "description": "Back-end response time",
232 "type": "string"
233 }
234 },
235 "schema": {
236 "$ref": "#/definitions/userResponse"
237 }
238 },
239 "400": {
240 "description": "Delivers new user session token to browser and signals it to reload",
241 "schema": {
242 "$ref": "#/definitions/userError"
243 }
244 }
245 }
246 }
247 },
248 "/api/patients": {
249 "get": {
250 "tags": [
251 "Ripple"
252 ],
253 "description": "Gets data for all patients in PAS",
254 "security": [
255 {
256 "QEWDToken": []
257 }
258 ],
259 "produces": [
260 "application/json"
261 ],
262 "parameters": [],
263 "responses": {
264 "200": {
265 "description": "Patient Data",
266 "headers": {
267 "X-ResponseTime": {
268 "description": "Back-end response time",
269 "type": "string"
270 }
271 },
272 "schema": {
273 "$ref": "#/definitions/patientsResponse"
274 }
275 },
276 "403": {
277 "description": "Missing or invalid authentication credentials"
278 }
279 }
280 }
281 },
282 "/api/patients/{patientId}/counts": {
283 "get": {
284 "tags": [
285 "Ripple"
286 ],
287 "description": "Gets Heading counts for specified patient",
288 "security": [
289 {
290 "QEWDToken": []
291 }
292 ],
293 "produces": [
294 "application/json"
295 ],
296 "parameters": [
297 {
298 "name": "patientId",
299 "in": "path",
300 "description": "Patient Id",
301 "required": true,
302 "type": "string"
303 }
304 ],
305 "responses": {
306 "200": {
307 "description": "Counts for selected headings",
308 "headers": {
309 "X-ResponseTime": {
310 "description": "Back-end response time",
311 "type": "string"
312 }
313 },
314 "schema": {
315 "$ref": "#/definitions/countsResponse"
316 }
317 },
318 "403": {
319 "description": "Missing or invalid authentication credentials"
320 }
321 }
322 }
323 },
324 "/api/patients/{patientId}/dicom/studies": {
325 "get": {
326 "tags": [
327 "Ripple"
328 ],
329 "description": "Gets all Digital Imaging for Communications in Medicine (DICOM) records for specified patient",
330 "security": [
331 {
332 "QEWDToken": []
333 }
334 ],
335 "produces": [
336 "application/json"
337 ],
338 "parameters": [
339 {
340 "name": "patientId",
341 "in": "path",
342 "description": "Patient Id",
343 "required": true,
344 "type": "string"
345 }
346 ],
347 "responses": {
348 "200": {
349 "description": "All DICOM documents",
350 "headers": {
351 "X-ResponseTime": {
352 "description": "Back-end response time",
353 "type": "string"
354 }
355 },
356 "schema": {
357 "$ref": "#/definitions/dicomStudiesResponse"
358 }
359 },
360 "403": {
361 "description": "Missing or invalid authentication credentials"
362 }
363 }
364 }
365 },
366 "/api/documents/patient/{patientId}": {
367 "get": {
368 "tags": [
369 "Documents"
370 ],
371 "description": "Get a summary list of documents for a patient",
372 "security": [
373 {
374 "QEWDToken": []
375 }
376 ],
377 "produces": [
378 "application/json"
379 ],
380 "parameters": [
381 {
382 "name": "patientId",
383 "in": "path",
384 "description": "Patient Id",
385 "required": true,
386 "type": "string"
387 }
388 ],
389 "responses": {
390 "200": {
391 "description": "Summary List of Documents",
392 "headers": {
393 "X-ResponseTime": {
394 "description": "Back-end response time",
395 "type": "string"
396 }
397 },
398 "schema": {
399 "$ref": "#/definitions/documentsSummaryResponse"
400 }
401 },
402 "403": {
403 "description": "Missing or invalid authentication credentials"
404 }
405 }
406 }
407 },
408 "/api/documents/patient/{patientId}/{sourceId}": {
409 "get": {
410 "tags": [
411 "Documents"
412 ],
413 "description": "Get the contents of a specified document for a patient",
414 "security": [
415 {
416 "QEWDToken": []
417 }
418 ],
419 "produces": [
420 "application/json"
421 ],
422 "parameters": [
423 {
424 "name": "patientId",
425 "in": "path",
426 "description": "Patient Id",
427 "required": true,
428 "type": "string"
429 },
430 {
431 "name": "sourceId",
432 "in": "path",
433 "description": "Document Composition Id",
434 "required": true,
435 "type": "string"
436 }
437 ],
438 "responses": {
439 "200": {
440 "description": "Document Contents",
441 "headers": {
442 "X-ResponseTime": {
443 "description": "Back-end response time",
444 "type": "string"
445 }
446 },
447 "schema": {
448 "$ref": "#/definitions/documentsDetailResponse"
449 }
450 },
451 "403": {
452 "description": "Missing or invalid authentication credentials"
453 }
454 }
455 }
456 },
457 "/api/documents/patient/{patientId}/{host}": {
458 "post": {
459 "tags": [
460 "Documents"
461 ],
462 "description": "Saves a Healthlink Referral or Discharge Document",
463 "security": [
464 {
465 "QEWDToken": []
466 }
467 ],
468 "consumes": [
469 "application/xml"
470 ],
471 "produces": [
472 "application/json"
473 ],
474 "parameters": [
475 {
476 "in": "body",
477 "name": "body",
478 "description": "Body Payload containing HealthLink XML Document",
479 "required": true,
480 "schema": {
481 "type": "string"
482 }
483 },
484 {
485 "name": "patientId",
486 "in": "path",
487 "description": "Patient Id",
488 "required": true,
489 "type": "string"
490 },
491 {
492 "name": "host",
493 "in": "path",
494 "description": "OpenEHR Host System on which to save Document (eg marand, ethercis)",
495 "required": true,
496 "type": "string"
497 }
498 ],
499 "responses": {
500 "200": {
501 "description": "",
502 "headers": {
503 "X-ResponseTime": {
504 "description": "Back-end response time",
505 "type": "string"
506 }
507 },
508 "schema": {
509 "$ref": "#/definitions/postDocumentResponse"
510 }
511 },
512 "403": {
513 "description": "Missing or invalid authentication credentials"
514 }
515 }
516 }
517 },
518 "/api/patients/{patientId}/allergies": {
519 "get": {
520 "tags": [
521 "Headings"
522 ],
523 "description": "Get allergies summary data",
524 "security": [
525 {
526 "QEWDToken": []
527 }
528 ],
529 "produces": [
530 "application/json"
531 ],
532 "parameters": [
533 {
534 "name": "patientId",
535 "in": "path",
536 "description": "Patient Id",
537 "required": true,
538 "type": "string"
539 }
540 ],
541 "responses": {
542 "200": {
543 "description": "Summary Data for allergies",
544 "headers": {
545 "X-ResponseTime": {
546 "description": "Back-end response time",
547 "type": "string"
548 }
549 },
550 "schema": {
551 "$ref": "#/definitions/allergiesSummaryResponse"
552 }
553 },
554 "403": {
555 "description": "Missing or invalid authentication credentials"
556 }
557 }
558 },
559 "post": {
560 "tags": [
561 "Headings"
562 ],
563 "description": "Save a new allergies record",
564 "security": [
565 {
566 "QEWDToken": []
567 }
568 ],
569 "produces": [
570 "application/json"
571 ],
572 "parameters": [
573 {
574 "name": "patientId",
575 "in": "path",
576 "description": "Patient Id",
577 "required": true,
578 "type": "string"
579 },
580 {
581 "in": "body",
582 "name": "body",
583 "description": "Body Payload containing heading data",
584 "required": true,
585 "schema": {
586 "$ref": "#/definitions/allergiesSchema"
587 }
588 }
589 ],
590 "responses": {
591 "200": {
592 "description": "Confirmation that data has been saved",
593 "headers": {
594 "X-ResponseTime": {
595 "description": "Back-end response time",
596 "type": "string"
597 }
598 },
599 "schema": {
600 "$ref": "#/definitions/headingPostResponse"
601 }
602 },
603 "403": {
604 "description": "Missing or invalid authentication credentials"
605 }
606 }
607 }
608 },
609 "/api/patients/{patientId}/allergies/{sourceId}": {
610 "get": {
611 "tags": [
612 "Headings"
613 ],
614 "description": "Get complete allergies data",
615 "security": [
616 {
617 "QEWDToken": []
618 }
619 ],
620 "produces": [
621 "application/json"
622 ],
623 "parameters": [
624 {
625 "name": "patientId",
626 "in": "path",
627 "description": "Patient Id",
628 "required": true,
629 "type": "string"
630 },
631 {
632 "name": "sourceId",
633 "in": "path",
634 "description": "OpenEHR Composition Id",
635 "required": true,
636 "type": "string"
637 }
638 ],
639 "responses": {
640 "200": {
641 "description": "Full Data for allergies",
642 "headers": {
643 "X-ResponseTime": {
644 "description": "Back-end response time",
645 "type": "string"
646 }
647 },
648 "schema": {
649 "$ref": "#/definitions/allergiesDetailResponse"
650 }
651 },
652 "403": {
653 "description": "Missing or invalid authentication credentials"
654 }
655 }
656 }
657 },
658 "/api/patients/{patientId}/problems": {
659 "get": {
660 "tags": [
661 "Headings"
662 ],
663 "description": "Get problems summary data",
664 "security": [
665 {
666 "QEWDToken": []
667 }
668 ],
669 "produces": [
670 "application/json"
671 ],
672 "parameters": [
673 {
674 "name": "patientId",
675 "in": "path",
676 "description": "Patient Id",
677 "required": true,
678 "type": "string"
679 }
680 ],
681 "responses": {
682 "200": {
683 "description": "Summary Data for problems",
684 "headers": {
685 "X-ResponseTime": {
686 "description": "Back-end response time",
687 "type": "string"
688 }
689 },
690 "schema": {
691 "$ref": "#/definitions/problemsSummaryResponse"
692 }
693 },
694 "403": {
695 "description": "Missing or invalid authentication credentials"
696 }
697 }
698 },
699 "post": {
700 "tags": [
701 "Headings"
702 ],
703 "description": "Save a new problems record",
704 "security": [
705 {
706 "QEWDToken": []
707 }
708 ],
709 "produces": [
710 "application/json"
711 ],
712 "parameters": [
713 {
714 "name": "patientId",
715 "in": "path",
716 "description": "Patient Id",
717 "required": true,
718 "type": "string"
719 },
720 {
721 "in": "body",
722 "name": "body",
723 "description": "Body Payload containing heading data",
724 "required": true,
725 "schema": {
726 "$ref": "#/definitions/problemsSchema"
727 }
728 }
729 ],
730 "responses": {
731 "200": {
732 "description": "Confirmation that data has been saved",
733 "headers": {
734 "X-ResponseTime": {
735 "description": "Back-end response time",
736 "type": "string"
737 }
738 },
739 "schema": {
740 "$ref": "#/definitions/headingPostResponse"
741 }
742 },
743 "403": {
744 "description": "Missing or invalid authentication credentials"
745 }
746 }
747 }
748 },
749 "/api/patients/{patientId}/problems/{sourceId}": {
750 "get": {
751 "tags": [
752 "Headings"
753 ],
754 "description": "Get complete problems data",
755 "security": [
756 {
757 "QEWDToken": []
758 }
759 ],
760 "produces": [
761 "application/json"
762 ],
763 "parameters": [
764 {
765 "name": "patientId",
766 "in": "path",
767 "description": "Patient Id",
768 "required": true,
769 "type": "string"
770 },
771 {
772 "name": "sourceId",
773 "in": "path",
774 "description": "OpenEHR Composition Id",
775 "required": true,
776 "type": "string"
777 }
778 ],
779 "responses": {
780 "200": {
781 "description": "Full Data for problems",
782 "headers": {
783 "X-ResponseTime": {
784 "description": "Back-end response time",
785 "type": "string"
786 }
787 },
788 "schema": {
789 "$ref": "#/definitions/problemsDetailResponse"
790 }
791 },
792 "403": {
793 "description": "Missing or invalid authentication credentials"
794 }
795 }
796 }
797 },
798 "/api/patients/{patientId}/medications": {
799 "get": {
800 "tags": [
801 "Headings"
802 ],
803 "description": "Get medications summary data",
804 "security": [
805 {
806 "QEWDToken": []
807 }
808 ],
809 "produces": [
810 "application/json"
811 ],
812 "parameters": [
813 {
814 "name": "patientId",
815 "in": "path",
816 "description": "Patient Id",
817 "required": true,
818 "type": "string"
819 }
820 ],
821 "responses": {
822 "200": {
823 "description": "Summary Data for medications",
824 "headers": {
825 "X-ResponseTime": {
826 "description": "Back-end response time",
827 "type": "string"
828 }
829 },
830 "schema": {
831 "$ref": "#/definitions/medicationsSummaryResponse"
832 }
833 },
834 "403": {
835 "description": "Missing or invalid authentication credentials"
836 }
837 }
838 },
839 "post": {
840 "tags": [
841 "Headings"
842 ],
843 "description": "Save a new medications record",
844 "security": [
845 {
846 "QEWDToken": []
847 }
848 ],
849 "produces": [
850 "application/json"
851 ],
852 "parameters": [
853 {
854 "name": "patientId",
855 "in": "path",
856 "description": "Patient Id",
857 "required": true,
858 "type": "string"
859 },
860 {
861 "in": "body",
862 "name": "body",
863 "description": "Body Payload containing heading data",
864 "required": true,
865 "schema": {
866 "$ref": "#/definitions/medicationsSchema"
867 }
868 }
869 ],
870 "responses": {
871 "200": {
872 "description": "Confirmation that data has been saved",
873 "headers": {
874 "X-ResponseTime": {
875 "description": "Back-end response time",
876 "type": "string"
877 }
878 },
879 "schema": {
880 "$ref": "#/definitions/headingPostResponse"
881 }
882 },
883 "403": {
884 "description": "Missing or invalid authentication credentials"
885 }
886 }
887 }
888 },
889 "/api/patients/{patientId}/medications/{sourceId}": {
890 "get": {
891 "tags": [
892 "Headings"
893 ],
894 "description": "Get complete medications data",
895 "security": [
896 {
897 "QEWDToken": []
898 }
899 ],
900 "produces": [
901 "application/json"
902 ],
903 "parameters": [
904 {
905 "name": "patientId",
906 "in": "path",
907 "description": "Patient Id",
908 "required": true,
909 "type": "string"
910 },
911 {
912 "name": "sourceId",
913 "in": "path",
914 "description": "OpenEHR Composition Id",
915 "required": true,
916 "type": "string"
917 }
918 ],
919 "responses": {
920 "200": {
921 "description": "Full Data for medications",
922 "headers": {
923 "X-ResponseTime": {
924 "description": "Back-end response time",
925 "type": "string"
926 }
927 },
928 "schema": {
929 "$ref": "#/definitions/medicationsDetailResponse"
930 }
931 },
932 "403": {
933 "description": "Missing or invalid authentication credentials"
934 }
935 }
936 }
937 },
938 "/api/patients/{patientId}/contacts": {
939 "get": {
940 "tags": [
941 "Headings"
942 ],
943 "description": "Get contacts summary data",
944 "security": [
945 {
946 "QEWDToken": []
947 }
948 ],
949 "produces": [
950 "application/json"
951 ],
952 "parameters": [
953 {
954 "name": "patientId",
955 "in": "path",
956 "description": "Patient Id",
957 "required": true,
958 "type": "string"
959 }
960 ],
961 "responses": {
962 "200": {
963 "description": "Summary Data for contacts",
964 "headers": {
965 "X-ResponseTime": {
966 "description": "Back-end response time",
967 "type": "string"
968 }
969 },
970 "schema": {
971 "$ref": "#/definitions/contactsSummaryResponse"
972 }
973 },
974 "403": {
975 "description": "Missing or invalid authentication credentials"
976 }
977 }
978 },
979 "post": {
980 "tags": [
981 "Headings"
982 ],
983 "description": "Save a new contacts record",
984 "security": [
985 {
986 "QEWDToken": []
987 }
988 ],
989 "produces": [
990 "application/json"
991 ],
992 "parameters": [
993 {
994 "name": "patientId",
995 "in": "path",
996 "description": "Patient Id",
997 "required": true,
998 "type": "string"
999 },
1000 {
1001 "in": "body",
1002 "name": "body",
1003 "description": "Body Payload containing heading data",
1004 "required": true,
1005 "schema": {
1006 "$ref": "#/definitions/contactsSchema"
1007 }
1008 }
1009 ],
1010 "responses": {
1011 "200": {
1012 "description": "Confirmation that data has been saved",
1013 "headers": {
1014 "X-ResponseTime": {
1015 "description": "Back-end response time",
1016 "type": "string"
1017 }
1018 },
1019 "schema": {
1020 "$ref": "#/definitions/headingPostResponse"
1021 }
1022 },
1023 "403": {
1024 "description": "Missing or invalid authentication credentials"
1025 }
1026 }
1027 }
1028 },
1029 "/api/patients/{patientId}/contacts/{sourceId}": {
1030 "get": {
1031 "tags": [
1032 "Headings"
1033 ],
1034 "description": "Get complete contacts data",
1035 "security": [
1036 {
1037 "QEWDToken": []
1038 }
1039 ],
1040 "produces": [
1041 "application/json"
1042 ],
1043 "parameters": [
1044 {
1045 "name": "patientId",
1046 "in": "path",
1047 "description": "Patient Id",
1048 "required": true,
1049 "type": "string"
1050 },
1051 {
1052 "name": "sourceId",
1053 "in": "path",
1054 "description": "OpenEHR Composition Id",
1055 "required": true,
1056 "type": "string"
1057 }
1058 ],
1059 "responses": {
1060 "200": {
1061 "description": "Full Data for contacts",
1062 "headers": {
1063 "X-ResponseTime": {
1064 "description": "Back-end response time",
1065 "type": "string"
1066 }
1067 },
1068 "schema": {
1069 "$ref": "#/definitions/contactsDetailResponse"
1070 }
1071 },
1072 "403": {
1073 "description": "Missing or invalid authentication credentials"
1074 }
1075 }
1076 }
1077 },
1078 "/api/patients/{patientId}/laborders": {
1079 "get": {
1080 "tags": [
1081 "Headings"
1082 ],
1083 "description": "Get laborders summary data",
1084 "security": [
1085 {
1086 "QEWDToken": []
1087 }
1088 ],
1089 "produces": [
1090 "application/json"
1091 ],
1092 "parameters": [
1093 {
1094 "name": "patientId",
1095 "in": "path",
1096 "description": "Patient Id",
1097 "required": true,
1098 "type": "string"
1099 }
1100 ],
1101 "responses": {
1102 "200": {
1103 "description": "Summary Data for laborders",
1104 "headers": {
1105 "X-ResponseTime": {
1106 "description": "Back-end response time",
1107 "type": "string"
1108 }
1109 },
1110 "schema": {
1111 "$ref": "#/definitions/labordersSummaryResponse"
1112 }
1113 },
1114 "403": {
1115 "description": "Missing or invalid authentication credentials"
1116 }
1117 }
1118 },
1119 "post": {
1120 "tags": [
1121 "Headings"
1122 ],
1123 "description": "Save a new laborders record",
1124 "security": [
1125 {
1126 "QEWDToken": []
1127 }
1128 ],
1129 "produces": [
1130 "application/json"
1131 ],
1132 "parameters": [
1133 {
1134 "name": "patientId",
1135 "in": "path",
1136 "description": "Patient Id",
1137 "required": true,
1138 "type": "string"
1139 },
1140 {
1141 "in": "body",
1142 "name": "body",
1143 "description": "Body Payload containing heading data",
1144 "required": true,
1145 "schema": {
1146 "$ref": "#/definitions/labordersSchema"
1147 }
1148 }
1149 ],
1150 "responses": {
1151 "200": {
1152 "description": "Confirmation that data has been saved",
1153 "headers": {
1154 "X-ResponseTime": {
1155 "description": "Back-end response time",
1156 "type": "string"
1157 }
1158 },
1159 "schema": {
1160 "$ref": "#/definitions/headingPostResponse"
1161 }
1162 },
1163 "403": {
1164 "description": "Missing or invalid authentication credentials"
1165 }
1166 }
1167 }
1168 },
1169 "/api/patients/{patientId}/laborders/{sourceId}": {
1170 "get": {
1171 "tags": [
1172 "Headings"
1173 ],
1174 "description": "Get complete laborders data",
1175 "security": [
1176 {
1177 "QEWDToken": []
1178 }
1179 ],
1180 "produces": [
1181 "application/json"
1182 ],
1183 "parameters": [
1184 {
1185 "name": "patientId",
1186 "in": "path",
1187 "description": "Patient Id",
1188 "required": true,
1189 "type": "string"
1190 },
1191 {
1192 "name": "sourceId",
1193 "in": "path",
1194 "description": "OpenEHR Composition Id",
1195 "required": true,
1196 "type": "string"
1197 }
1198 ],
1199 "responses": {
1200 "200": {
1201 "description": "Full Data for laborders",
1202 "headers": {
1203 "X-ResponseTime": {
1204 "description": "Back-end response time",
1205 "type": "string"
1206 }
1207 },
1208 "schema": {
1209 "$ref": "#/definitions/labordersDetailResponse"
1210 }
1211 },
1212 "403": {
1213 "description": "Missing or invalid authentication credentials"
1214 }
1215 }
1216 }
1217 },
1218 "/api/patients/{patientId}/labresults": {
1219 "get": {
1220 "tags": [
1221 "Headings"
1222 ],
1223 "description": "Get labresults summary data",
1224 "security": [
1225 {
1226 "QEWDToken": []
1227 }
1228 ],
1229 "produces": [
1230 "application/json"
1231 ],
1232 "parameters": [
1233 {
1234 "name": "patientId",
1235 "in": "path",
1236 "description": "Patient Id",
1237 "required": true,
1238 "type": "string"
1239 }
1240 ],
1241 "responses": {
1242 "200": {
1243 "description": "Summary Data for labresults",
1244 "headers": {
1245 "X-ResponseTime": {
1246 "description": "Back-end response time",
1247 "type": "string"
1248 }
1249 },
1250 "schema": {
1251 "$ref": "#/definitions/labresultsSummaryResponse"
1252 }
1253 },
1254 "403": {
1255 "description": "Missing or invalid authentication credentials"
1256 }
1257 }
1258 }
1259 },
1260 "/api/patients/{patientId}/labresults/{sourceId}": {
1261 "get": {
1262 "tags": [
1263 "Headings"
1264 ],
1265 "description": "Get complete labresults data",
1266 "security": [
1267 {
1268 "QEWDToken": []
1269 }
1270 ],
1271 "produces": [
1272 "application/json"
1273 ],
1274 "parameters": [
1275 {
1276 "name": "patientId",
1277 "in": "path",
1278 "description": "Patient Id",
1279 "required": true,
1280 "type": "string"
1281 },
1282 {
1283 "name": "sourceId",
1284 "in": "path",
1285 "description": "OpenEHR Composition Id",
1286 "required": true,
1287 "type": "string"
1288 }
1289 ],
1290 "responses": {
1291 "200": {
1292 "description": "Full Data for labresults",
1293 "headers": {
1294 "X-ResponseTime": {
1295 "description": "Back-end response time",
1296 "type": "string"
1297 }
1298 },
1299 "schema": {
1300 "$ref": "#/definitions/labresultsDetailResponse"
1301 }
1302 },
1303 "403": {
1304 "description": "Missing or invalid authentication credentials"
1305 }
1306 }
1307 }
1308 },
1309 "/api/patients/{patientId}/procedures": {
1310 "get": {
1311 "tags": [
1312 "Headings"
1313 ],
1314 "description": "Get procedures summary data",
1315 "security": [
1316 {
1317 "QEWDToken": []
1318 }
1319 ],
1320 "produces": [
1321 "application/json"
1322 ],
1323 "parameters": [
1324 {
1325 "name": "patientId",
1326 "in": "path",
1327 "description": "Patient Id",
1328 "required": true,
1329 "type": "string"
1330 }
1331 ],
1332 "responses": {
1333 "200": {
1334 "description": "Summary Data for procedures",
1335 "headers": {
1336 "X-ResponseTime": {
1337 "description": "Back-end response time",
1338 "type": "string"
1339 }
1340 },
1341 "schema": {
1342 "$ref": "#/definitions/proceduresSummaryResponse"
1343 }
1344 },
1345 "403": {
1346 "description": "Missing or invalid authentication credentials"
1347 }
1348 }
1349 },
1350 "post": {
1351 "tags": [
1352 "Headings"
1353 ],
1354 "description": "Save a new procedures record",
1355 "security": [
1356 {
1357 "QEWDToken": []
1358 }
1359 ],
1360 "produces": [
1361 "application/json"
1362 ],
1363 "parameters": [
1364 {
1365 "name": "patientId",
1366 "in": "path",
1367 "description": "Patient Id",
1368 "required": true,
1369 "type": "string"
1370 },
1371 {
1372 "in": "body",
1373 "name": "body",
1374 "description": "Body Payload containing heading data",
1375 "required": true,
1376 "schema": {
1377 "$ref": "#/definitions/proceduresSchema"
1378 }
1379 }
1380 ],
1381 "responses": {
1382 "200": {
1383 "description": "Confirmation that data has been saved",
1384 "headers": {
1385 "X-ResponseTime": {
1386 "description": "Back-end response time",
1387 "type": "string"
1388 }
1389 },
1390 "schema": {
1391 "$ref": "#/definitions/headingPostResponse"
1392 }
1393 },
1394 "403": {
1395 "description": "Missing or invalid authentication credentials"
1396 }
1397 }
1398 }
1399 },
1400 "/api/patients/{patientId}/procedures/{sourceId}": {
1401 "get": {
1402 "tags": [
1403 "Headings"
1404 ],
1405 "description": "Get complete procedures data",
1406 "security": [
1407 {
1408 "QEWDToken": []
1409 }
1410 ],
1411 "produces": [
1412 "application/json"
1413 ],
1414 "parameters": [
1415 {
1416 "name": "patientId",
1417 "in": "path",
1418 "description": "Patient Id",
1419 "required": true,
1420 "type": "string"
1421 },
1422 {
1423 "name": "sourceId",
1424 "in": "path",
1425 "description": "OpenEHR Composition Id",
1426 "required": true,
1427 "type": "string"
1428 }
1429 ],
1430 "responses": {
1431 "200": {
1432 "description": "Full Data for procedures",
1433 "headers": {
1434 "X-ResponseTime": {
1435 "description": "Back-end response time",
1436 "type": "string"
1437 }
1438 },
1439 "schema": {
1440 "$ref": "#/definitions/proceduresDetailResponse"
1441 }
1442 },
1443 "403": {
1444 "description": "Missing or invalid authentication credentials"
1445 }
1446 }
1447 }
1448 },
1449 "/api/patients/{patientId}/referrals": {
1450 "get": {
1451 "tags": [
1452 "Headings"
1453 ],
1454 "description": "Get referrals summary data",
1455 "security": [
1456 {
1457 "QEWDToken": []
1458 }
1459 ],
1460 "produces": [
1461 "application/json"
1462 ],
1463 "parameters": [
1464 {
1465 "name": "patientId",
1466 "in": "path",
1467 "description": "Patient Id",
1468 "required": true,
1469 "type": "string"
1470 }
1471 ],
1472 "responses": {
1473 "200": {
1474 "description": "Summary Data for referrals",
1475 "headers": {
1476 "X-ResponseTime": {
1477 "description": "Back-end response time",
1478 "type": "string"
1479 }
1480 },
1481 "schema": {
1482 "$ref": "#/definitions/referralsSummaryResponse"
1483 }
1484 },
1485 "403": {
1486 "description": "Missing or invalid authentication credentials"
1487 }
1488 }
1489 },
1490 "post": {
1491 "tags": [
1492 "Headings"
1493 ],
1494 "description": "Save a new referrals record",
1495 "security": [
1496 {
1497 "QEWDToken": []
1498 }
1499 ],
1500 "produces": [
1501 "application/json"
1502 ],
1503 "parameters": [
1504 {
1505 "name": "patientId",
1506 "in": "path",
1507 "description": "Patient Id",
1508 "required": true,
1509 "type": "string"
1510 },
1511 {
1512 "in": "body",
1513 "name": "body",
1514 "description": "Body Payload containing heading data",
1515 "required": true,
1516 "schema": {
1517 "$ref": "#/definitions/referralsSchema"
1518 }
1519 }
1520 ],
1521 "responses": {
1522 "200": {
1523 "description": "Confirmation that data has been saved",
1524 "headers": {
1525 "X-ResponseTime": {
1526 "description": "Back-end response time",
1527 "type": "string"
1528 }
1529 },
1530 "schema": {
1531 "$ref": "#/definitions/headingPostResponse"
1532 }
1533 },
1534 "403": {
1535 "description": "Missing or invalid authentication credentials"
1536 }
1537 }
1538 }
1539 },
1540 "/api/patients/{patientId}/referrals/{sourceId}": {
1541 "get": {
1542 "tags": [
1543 "Headings"
1544 ],
1545 "description": "Get complete referrals data",
1546 "security": [
1547 {
1548 "QEWDToken": []
1549 }
1550 ],
1551 "produces": [
1552 "application/json"
1553 ],
1554 "parameters": [
1555 {
1556 "name": "patientId",
1557 "in": "path",
1558 "description": "Patient Id",
1559 "required": true,
1560 "type": "string"
1561 },
1562 {
1563 "name": "sourceId",
1564 "in": "path",
1565 "description": "OpenEHR Composition Id",
1566 "required": true,
1567 "type": "string"
1568 }
1569 ],
1570 "responses": {
1571 "200": {
1572 "description": "Full Data for referrals",
1573 "headers": {
1574 "X-ResponseTime": {
1575 "description": "Back-end response time",
1576 "type": "string"
1577 }
1578 },
1579 "schema": {
1580 "$ref": "#/definitions/referralsDetailResponse"
1581 }
1582 },
1583 "403": {
1584 "description": "Missing or invalid authentication credentials"
1585 }
1586 }
1587 }
1588 },
1589 "/api/patients/{patientId}/appointments": {
1590 "get": {
1591 "tags": [
1592 "Headings"
1593 ],
1594 "description": "Get appointments summary data",
1595 "security": [
1596 {
1597 "QEWDToken": []
1598 }
1599 ],
1600 "produces": [
1601 "application/json"
1602 ],
1603 "parameters": [
1604 {
1605 "name": "patientId",
1606 "in": "path",
1607 "description": "Patient Id",
1608 "required": true,
1609 "type": "string"
1610 }
1611 ],
1612 "responses": {
1613 "200": {
1614 "description": "Summary Data for appointments",
1615 "headers": {
1616 "X-ResponseTime": {
1617 "description": "Back-end response time",
1618 "type": "string"
1619 }
1620 },
1621 "schema": {
1622 "$ref": "#/definitions/appointmentsSummaryResponse"
1623 }
1624 },
1625 "403": {
1626 "description": "Missing or invalid authentication credentials"
1627 }
1628 }
1629 },
1630 "post": {
1631 "tags": [
1632 "Headings"
1633 ],
1634 "description": "Save a new appointments record",
1635 "security": [
1636 {
1637 "QEWDToken": []
1638 }
1639 ],
1640 "produces": [
1641 "application/json"
1642 ],
1643 "parameters": [
1644 {
1645 "name": "patientId",
1646 "in": "path",
1647 "description": "Patient Id",
1648 "required": true,
1649 "type": "string"
1650 },
1651 {
1652 "in": "body",
1653 "name": "body",
1654 "description": "Body Payload containing heading data",
1655 "required": true,
1656 "schema": {
1657 "$ref": "#/definitions/appointmentsSchema"
1658 }
1659 }
1660 ],
1661 "responses": {
1662 "200": {
1663 "description": "Confirmation that data has been saved",
1664 "headers": {
1665 "X-ResponseTime": {
1666 "description": "Back-end response time",
1667 "type": "string"
1668 }
1669 },
1670 "schema": {
1671 "$ref": "#/definitions/headingPostResponse"
1672 }
1673 },
1674 "403": {
1675 "description": "Missing or invalid authentication credentials"
1676 }
1677 }
1678 }
1679 },
1680 "/api/patients/{patientId}/appointments/{sourceId}": {
1681 "get": {
1682 "tags": [
1683 "Headings"
1684 ],
1685 "description": "Get complete appointments data",
1686 "security": [
1687 {
1688 "QEWDToken": []
1689 }
1690 ],
1691 "produces": [
1692 "application/json"
1693 ],
1694 "parameters": [
1695 {
1696 "name": "patientId",
1697 "in": "path",
1698 "description": "Patient Id",
1699 "required": true,
1700 "type": "string"
1701 },
1702 {
1703 "name": "sourceId",
1704 "in": "path",
1705 "description": "OpenEHR Composition Id",
1706 "required": true,
1707 "type": "string"
1708 }
1709 ],
1710 "responses": {
1711 "200": {
1712 "description": "Full Data for appointments",
1713 "headers": {
1714 "X-ResponseTime": {
1715 "description": "Back-end response time",
1716 "type": "string"
1717 }
1718 },
1719 "schema": {
1720 "$ref": "#/definitions/appointmentsDetailResponse"
1721 }
1722 },
1723 "403": {
1724 "description": "Missing or invalid authentication credentials"
1725 }
1726 }
1727 }
1728 },
1729 "/api/patients/{patientId}/eolcareplans": {
1730 "get": {
1731 "tags": [
1732 "Headings"
1733 ],
1734 "description": "Get eolcareplans summary data",
1735 "security": [
1736 {
1737 "QEWDToken": []
1738 }
1739 ],
1740 "produces": [
1741 "application/json"
1742 ],
1743 "parameters": [
1744 {
1745 "name": "patientId",
1746 "in": "path",
1747 "description": "Patient Id",
1748 "required": true,
1749 "type": "string"
1750 }
1751 ],
1752 "responses": {
1753 "200": {
1754 "description": "Summary Data for eolcareplans",
1755 "headers": {
1756 "X-ResponseTime": {
1757 "description": "Back-end response time",
1758 "type": "string"
1759 }
1760 },
1761 "schema": {
1762 "$ref": "#/definitions/eolcareplansSummaryResponse"
1763 }
1764 },
1765 "403": {
1766 "description": "Missing or invalid authentication credentials"
1767 }
1768 }
1769 },
1770 "post": {
1771 "tags": [
1772 "Headings"
1773 ],
1774 "description": "Save a new eolcareplans record",
1775 "security": [
1776 {
1777 "QEWDToken": []
1778 }
1779 ],
1780 "produces": [
1781 "application/json"
1782 ],
1783 "parameters": [
1784 {
1785 "name": "patientId",
1786 "in": "path",
1787 "description": "Patient Id",
1788 "required": true,
1789 "type": "string"
1790 },
1791 {
1792 "in": "body",
1793 "name": "body",
1794 "description": "Body Payload containing heading data",
1795 "required": true,
1796 "schema": {
1797 "$ref": "#/definitions/eolcareplansSchema"
1798 }
1799 }
1800 ],
1801 "responses": {
1802 "200": {
1803 "description": "Confirmation that data has been saved",
1804 "headers": {
1805 "X-ResponseTime": {
1806 "description": "Back-end response time",
1807 "type": "string"
1808 }
1809 },
1810 "schema": {
1811 "$ref": "#/definitions/headingPostResponse"
1812 }
1813 },
1814 "403": {
1815 "description": "Missing or invalid authentication credentials"
1816 }
1817 }
1818 }
1819 },
1820 "/api/patients/{patientId}/eolcareplans/{sourceId}": {
1821 "get": {
1822 "tags": [
1823 "Headings"
1824 ],
1825 "description": "Get complete eolcareplans data",
1826 "security": [
1827 {
1828 "QEWDToken": []
1829 }
1830 ],
1831 "produces": [
1832 "application/json"
1833 ],
1834 "parameters": [
1835 {
1836 "name": "patientId",
1837 "in": "path",
1838 "description": "Patient Id",
1839 "required": true,
1840 "type": "string"
1841 },
1842 {
1843 "name": "sourceId",
1844 "in": "path",
1845 "description": "OpenEHR Composition Id",
1846 "required": true,
1847 "type": "string"
1848 }
1849 ],
1850 "responses": {
1851 "200": {
1852 "description": "Full Data for eolcareplans",
1853 "headers": {
1854 "X-ResponseTime": {
1855 "description": "Back-end response time",
1856 "type": "string"
1857 }
1858 },
1859 "schema": {
1860 "$ref": "#/definitions/eolcareplansDetailResponse"
1861 }
1862 },
1863 "403": {
1864 "description": "Missing or invalid authentication credentials"
1865 }
1866 }
1867 }
1868 },
1869 "/api/patients/{patientId}/mdtreports": {
1870 "get": {
1871 "tags": [
1872 "Headings"
1873 ],
1874 "description": "Get mdtreports summary data",
1875 "security": [
1876 {
1877 "QEWDToken": []
1878 }
1879 ],
1880 "produces": [
1881 "application/json"
1882 ],
1883 "parameters": [
1884 {
1885 "name": "patientId",
1886 "in": "path",
1887 "description": "Patient Id",
1888 "required": true,
1889 "type": "string"
1890 }
1891 ],
1892 "responses": {
1893 "200": {
1894 "description": "Summary Data for mdtreports",
1895 "headers": {
1896 "X-ResponseTime": {
1897 "description": "Back-end response time",
1898 "type": "string"
1899 }
1900 },
1901 "schema": {
1902 "$ref": "#/definitions/mdtreportsSummaryResponse"
1903 }
1904 },
1905 "403": {
1906 "description": "Missing or invalid authentication credentials"
1907 }
1908 }
1909 }
1910 },
1911 "/api/patients/{patientId}/mdtreports/{sourceId}": {
1912 "get": {
1913 "tags": [
1914 "Headings"
1915 ],
1916 "description": "Get complete mdtreports data",
1917 "security": [
1918 {
1919 "QEWDToken": []
1920 }
1921 ],
1922 "produces": [
1923 "application/json"
1924 ],
1925 "parameters": [
1926 {
1927 "name": "patientId",
1928 "in": "path",
1929 "description": "Patient Id",
1930 "required": true,
1931 "type": "string"
1932 },
1933 {
1934 "name": "sourceId",
1935 "in": "path",
1936 "description": "OpenEHR Composition Id",
1937 "required": true,
1938 "type": "string"
1939 }
1940 ],
1941 "responses": {
1942 "200": {
1943 "description": "Full Data for mdtreports",
1944 "headers": {
1945 "X-ResponseTime": {
1946 "description": "Back-end response time",
1947 "type": "string"
1948 }
1949 },
1950 "schema": {
1951 "$ref": "#/definitions/mdtreportsDetailResponse"
1952 }
1953 },
1954 "403": {
1955 "description": "Missing or invalid authentication credentials"
1956 }
1957 }
1958 }
1959 },
1960 "/api/patients/{patientId}/personalnotes": {
1961 "get": {
1962 "tags": [
1963 "Headings"
1964 ],
1965 "description": "Get personalnotes summary data",
1966 "security": [
1967 {
1968 "QEWDToken": []
1969 }
1970 ],
1971 "produces": [
1972 "application/json"
1973 ],
1974 "parameters": [
1975 {
1976 "name": "patientId",
1977 "in": "path",
1978 "description": "Patient Id",
1979 "required": true,
1980 "type": "string"
1981 }
1982 ],
1983 "responses": {
1984 "200": {
1985 "description": "Summary Data for personalnotes",
1986 "headers": {
1987 "X-ResponseTime": {
1988 "description": "Back-end response time",
1989 "type": "string"
1990 }
1991 },
1992 "schema": {
1993 "$ref": "#/definitions/personalnotesSummaryResponse"
1994 }
1995 },
1996 "403": {
1997 "description": "Missing or invalid authentication credentials"
1998 }
1999 }
2000 },
2001 "post": {
2002 "tags": [
2003 "Headings"
2004 ],
2005 "description": "Save a new personalnotes record",
2006 "security": [
2007 {
2008 "QEWDToken": []
2009 }
2010 ],
2011 "produces": [
2012 "application/json"
2013 ],
2014 "parameters": [
2015 {
2016 "name": "patientId",
2017 "in": "path",
2018 "description": "Patient Id",
2019 "required": true,
2020 "type": "string"
2021 },
2022 {
2023 "in": "body",
2024 "name": "body",
2025 "description": "Body Payload containing heading data",
2026 "required": true,
2027 "schema": {
2028 "$ref": "#/definitions/personalnotesSchema"
2029 }
2030 }
2031 ],
2032 "responses": {
2033 "200": {
2034 "description": "Confirmation that data has been saved",
2035 "headers": {
2036 "X-ResponseTime": {
2037 "description": "Back-end response time",
2038 "type": "string"
2039 }
2040 },
2041 "schema": {
2042 "$ref": "#/definitions/headingPostResponse"
2043 }
2044 },
2045 "403": {
2046 "description": "Missing or invalid authentication credentials"
2047 }
2048 }
2049 }
2050 },
2051 "/api/patients/{patientId}/personalnotes/{sourceId}": {
2052 "get": {
2053 "tags": [
2054 "Headings"
2055 ],
2056 "description": "Get complete personalnotes data",
2057 "security": [
2058 {
2059 "QEWDToken": []
2060 }
2061 ],
2062 "produces": [
2063 "application/json"
2064 ],
2065 "parameters": [
2066 {
2067 "name": "patientId",
2068 "in": "path",
2069 "description": "Patient Id",
2070 "required": true,
2071 "type": "string"
2072 },
2073 {
2074 "name": "sourceId",
2075 "in": "path",
2076 "description": "OpenEHR Composition Id",
2077 "required": true,
2078 "type": "string"
2079 }
2080 ],
2081 "responses": {
2082 "200": {
2083 "description": "Full Data for personalnotes",
2084 "headers": {
2085 "X-ResponseTime": {
2086 "description": "Back-end response time",
2087 "type": "string"
2088 }
2089 },
2090 "schema": {
2091 "$ref": "#/definitions/personalnotesDetailResponse"
2092 }
2093 },
2094 "403": {
2095 "description": "Missing or invalid authentication credentials"
2096 }
2097 }
2098 }
2099 },
2100 "/api/patients/{patientId}/vaccinations": {
2101 "get": {
2102 "tags": [
2103 "Headings"
2104 ],
2105 "description": "Get vaccinations summary data",
2106 "security": [
2107 {
2108 "QEWDToken": []
2109 }
2110 ],
2111 "produces": [
2112 "application/json"
2113 ],
2114 "parameters": [
2115 {
2116 "name": "patientId",
2117 "in": "path",
2118 "description": "Patient Id",
2119 "required": true,
2120 "type": "string"
2121 }
2122 ],
2123 "responses": {
2124 "200": {
2125 "description": "Summary Data for vaccinations",
2126 "headers": {
2127 "X-ResponseTime": {
2128 "description": "Back-end response time",
2129 "type": "string"
2130 }
2131 },
2132 "schema": {
2133 "$ref": "#/definitions/vaccinationsSummaryResponse"
2134 }
2135 },
2136 "403": {
2137 "description": "Missing or invalid authentication credentials"
2138 }
2139 }
2140 },
2141 "post": {
2142 "tags": [
2143 "Headings"
2144 ],
2145 "description": "Save a new vaccinations record",
2146 "security": [
2147 {
2148 "QEWDToken": []
2149 }
2150 ],
2151 "produces": [
2152 "application/json"
2153 ],
2154 "parameters": [
2155 {
2156 "name": "patientId",
2157 "in": "path",
2158 "description": "Patient Id",
2159 "required": true,
2160 "type": "string"
2161 },
2162 {
2163 "in": "body",
2164 "name": "body",
2165 "description": "Body Payload containing heading data",
2166 "required": true,
2167 "schema": {
2168 "$ref": "#/definitions/vaccinationsSchema"
2169 }
2170 }
2171 ],
2172 "responses": {
2173 "200": {
2174 "description": "Confirmation that data has been saved",
2175 "headers": {
2176 "X-ResponseTime": {
2177 "description": "Back-end response time",
2178 "type": "string"
2179 }
2180 },
2181 "schema": {
2182 "$ref": "#/definitions/headingPostResponse"
2183 }
2184 },
2185 "403": {
2186 "description": "Missing or invalid authentication credentials"
2187 }
2188 }
2189 }
2190 },
2191 "/api/patients/{patientId}/vaccinations/{sourceId}": {
2192 "get": {
2193 "tags": [
2194 "Headings"
2195 ],
2196 "description": "Get complete vaccinations data",
2197 "security": [
2198 {
2199 "QEWDToken": []
2200 }
2201 ],
2202 "produces": [
2203 "application/json"
2204 ],
2205 "parameters": [
2206 {
2207 "name": "patientId",
2208 "in": "path",
2209 "description": "Patient Id",
2210 "required": true,
2211 "type": "string"
2212 },
2213 {
2214 "name": "sourceId",
2215 "in": "path",
2216 "description": "OpenEHR Composition Id",
2217 "required": true,
2218 "type": "string"
2219 }
2220 ],
2221 "responses": {
2222 "200": {
2223 "description": "Full Data for vaccinations",
2224 "headers": {
2225 "X-ResponseTime": {
2226 "description": "Back-end response time",
2227 "type": "string"
2228 }
2229 },
2230 "schema": {
2231 "$ref": "#/definitions/vaccinationsDetailResponse"
2232 }
2233 },
2234 "403": {
2235 "description": "Missing or invalid authentication credentials"
2236 }
2237 }
2238 }
2239 },
2240 "/api/patients/{patientId}/vitalsigns": {
2241 "get": {
2242 "tags": [
2243 "Headings"
2244 ],
2245 "description": "Get vitalsigns summary data",
2246 "security": [
2247 {
2248 "QEWDToken": []
2249 }
2250 ],
2251 "produces": [
2252 "application/json"
2253 ],
2254 "parameters": [
2255 {
2256 "name": "patientId",
2257 "in": "path",
2258 "description": "Patient Id",
2259 "required": true,
2260 "type": "string"
2261 }
2262 ],
2263 "responses": {
2264 "200": {
2265 "description": "Summary Data for vitalsigns",
2266 "headers": {
2267 "X-ResponseTime": {
2268 "description": "Back-end response time",
2269 "type": "string"
2270 }
2271 },
2272 "schema": {
2273 "$ref": "#/definitions/vitalsignsSummaryResponse"
2274 }
2275 },
2276 "403": {
2277 "description": "Missing or invalid authentication credentials"
2278 }
2279 }
2280 },
2281 "post": {
2282 "tags": [
2283 "Headings"
2284 ],
2285 "description": "Save a new vitalsigns record",
2286 "security": [
2287 {
2288 "QEWDToken": []
2289 }
2290 ],
2291 "produces": [
2292 "application/json"
2293 ],
2294 "parameters": [
2295 {
2296 "name": "patientId",
2297 "in": "path",
2298 "description": "Patient Id",
2299 "required": true,
2300 "type": "string"
2301 },
2302 {
2303 "in": "body",
2304 "name": "body",
2305 "description": "Body Payload containing heading data",
2306 "required": true,
2307 "schema": {
2308 "$ref": "#/definitions/vitalsignsSchema"
2309 }
2310 }
2311 ],
2312 "responses": {
2313 "200": {
2314 "description": "Confirmation that data has been saved",
2315 "headers": {
2316 "X-ResponseTime": {
2317 "description": "Back-end response time",
2318 "type": "string"
2319 }
2320 },
2321 "schema": {
2322 "$ref": "#/definitions/headingPostResponse"
2323 }
2324 },
2325 "403": {
2326 "description": "Missing or invalid authentication credentials"
2327 }
2328 }
2329 }
2330 },
2331 "/api/patients/{patientId}/vitalsigns/{sourceId}": {
2332 "get": {
2333 "tags": [
2334 "Headings"
2335 ],
2336 "description": "Get complete vitalsigns data",
2337 "security": [
2338 {
2339 "QEWDToken": []
2340 }
2341 ],
2342 "produces": [
2343 "application/json"
2344 ],
2345 "parameters": [
2346 {
2347 "name": "patientId",
2348 "in": "path",
2349 "description": "Patient Id",
2350 "required": true,
2351 "type": "string"
2352 },
2353 {
2354 "name": "sourceId",
2355 "in": "path",
2356 "description": "OpenEHR Composition Id",
2357 "required": true,
2358 "type": "string"
2359 }
2360 ],
2361 "responses": {
2362 "200": {
2363 "description": "Full Data for vitalsigns",
2364 "headers": {
2365 "X-ResponseTime": {
2366 "description": "Back-end response time",
2367 "type": "string"
2368 }
2369 },
2370 "schema": {
2371 "$ref": "#/definitions/vitalsignsDetailResponse"
2372 }
2373 },
2374 "403": {
2375 "description": "Missing or invalid authentication credentials"
2376 }
2377 }
2378 }
2379 },
2380 "/api/patients/{patientId}/clinicalnotes": {
2381 "get": {
2382 "tags": [
2383 "Headings"
2384 ],
2385 "description": "Get clinicalnotes summary data",
2386 "security": [
2387 {
2388 "QEWDToken": []
2389 }
2390 ],
2391 "produces": [
2392 "application/json"
2393 ],
2394 "parameters": [
2395 {
2396 "name": "patientId",
2397 "in": "path",
2398 "description": "Patient Id",
2399 "required": true,
2400 "type": "string"
2401 }
2402 ],
2403 "responses": {
2404 "200": {
2405 "description": "Summary Data for clinicalnotes",
2406 "headers": {
2407 "X-ResponseTime": {
2408 "description": "Back-end response time",
2409 "type": "string"
2410 }
2411 },
2412 "schema": {
2413 "$ref": "#/definitions/clinicalnotesSummaryResponse"
2414 }
2415 },
2416 "403": {
2417 "description": "Missing or invalid authentication credentials"
2418 }
2419 }
2420 },
2421 "post": {
2422 "tags": [
2423 "Headings"
2424 ],
2425 "description": "Save a new clinicalnotes record",
2426 "security": [
2427 {
2428 "QEWDToken": []
2429 }
2430 ],
2431 "produces": [
2432 "application/json"
2433 ],
2434 "parameters": [
2435 {
2436 "name": "patientId",
2437 "in": "path",
2438 "description": "Patient Id",
2439 "required": true,
2440 "type": "string"
2441 },
2442 {
2443 "in": "body",
2444 "name": "body",
2445 "description": "Body Payload containing heading data",
2446 "required": true,
2447 "schema": {
2448 "$ref": "#/definitions/clinicalnotesSchema"
2449 }
2450 }
2451 ],
2452 "responses": {
2453 "200": {
2454 "description": "Confirmation that data has been saved",
2455 "headers": {
2456 "X-ResponseTime": {
2457 "description": "Back-end response time",
2458 "type": "string"
2459 }
2460 },
2461 "schema": {
2462 "$ref": "#/definitions/headingPostResponse"
2463 }
2464 },
2465 "403": {
2466 "description": "Missing or invalid authentication credentials"
2467 }
2468 }
2469 }
2470 },
2471 "/api/patients/{patientId}/clinicalnotes/{sourceId}": {
2472 "get": {
2473 "tags": [
2474 "Headings"
2475 ],
2476 "description": "Get complete clinicalnotes data",
2477 "security": [
2478 {
2479 "QEWDToken": []
2480 }
2481 ],
2482 "produces": [
2483 "application/json"
2484 ],
2485 "parameters": [
2486 {
2487 "name": "patientId",
2488 "in": "path",
2489 "description": "Patient Id",
2490 "required": true,
2491 "type": "string"
2492 },
2493 {
2494 "name": "sourceId",
2495 "in": "path",
2496 "description": "OpenEHR Composition Id",
2497 "required": true,
2498 "type": "string"
2499 }
2500 ],
2501 "responses": {
2502 "200": {
2503 "description": "Full Data for clinicalnotes",
2504 "headers": {
2505 "X-ResponseTime": {
2506 "description": "Back-end response time",
2507 "type": "string"
2508 }
2509 },
2510 "schema": {
2511 "$ref": "#/definitions/clinicalnotesDetailResponse"
2512 }
2513 },
2514 "403": {
2515 "description": "Missing or invalid authentication credentials"
2516 }
2517 }
2518 }
2519 },
2520 "/api/patients/{patientId}/events": {
2521 "get": {
2522 "tags": [
2523 "Headings"
2524 ],
2525 "description": "Get events summary data",
2526 "security": [
2527 {
2528 "QEWDToken": []
2529 }
2530 ],
2531 "produces": [
2532 "application/json"
2533 ],
2534 "parameters": [
2535 {
2536 "name": "patientId",
2537 "in": "path",
2538 "description": "Patient Id",
2539 "required": true,
2540 "type": "string"
2541 }
2542 ],
2543 "responses": {
2544 "200": {
2545 "description": "Summary Data for events",
2546 "headers": {
2547 "X-ResponseTime": {
2548 "description": "Back-end response time",
2549 "type": "string"
2550 }
2551 },
2552 "schema": {
2553 "$ref": "#/definitions/eventsSummaryResponse"
2554 }
2555 },
2556 "403": {
2557 "description": "Missing or invalid authentication credentials"
2558 }
2559 }
2560 },
2561 "post": {
2562 "tags": [
2563 "Headings"
2564 ],
2565 "description": "Save a new events record",
2566 "security": [
2567 {
2568 "QEWDToken": []
2569 }
2570 ],
2571 "produces": [
2572 "application/json"
2573 ],
2574 "parameters": [
2575 {
2576 "name": "patientId",
2577 "in": "path",
2578 "description": "Patient Id",
2579 "required": true,
2580 "type": "string"
2581 },
2582 {
2583 "in": "body",
2584 "name": "body",
2585 "description": "Body Payload containing heading data",
2586 "required": true,
2587 "schema": {
2588 "$ref": "#/definitions/eventsSchema"
2589 }
2590 }
2591 ],
2592 "responses": {
2593 "200": {
2594 "description": "Confirmation that data has been saved",
2595 "headers": {
2596 "X-ResponseTime": {
2597 "description": "Back-end response time",
2598 "type": "string"
2599 }
2600 },
2601 "schema": {
2602 "$ref": "#/definitions/headingPostResponse"
2603 }
2604 },
2605 "403": {
2606 "description": "Missing or invalid authentication credentials"
2607 }
2608 }
2609 }
2610 },
2611 "/api/patients/{patientId}/events/{sourceId}": {
2612 "get": {
2613 "tags": [
2614 "Headings"
2615 ],
2616 "description": "Get complete events data",
2617 "security": [
2618 {
2619 "QEWDToken": []
2620 }
2621 ],
2622 "produces": [
2623 "application/json"
2624 ],
2625 "parameters": [
2626 {
2627 "name": "patientId",
2628 "in": "path",
2629 "description": "Patient Id",
2630 "required": true,
2631 "type": "string"
2632 },
2633 {
2634 "name": "sourceId",
2635 "in": "path",
2636 "description": "OpenEHR Composition Id",
2637 "required": true,
2638 "type": "string"
2639 }
2640 ],
2641 "responses": {
2642 "200": {
2643 "description": "Full Data for events",
2644 "headers": {
2645 "X-ResponseTime": {
2646 "description": "Back-end response time",
2647 "type": "string"
2648 }
2649 },
2650 "schema": {
2651 "$ref": "#/definitions/eventsDetailResponse"
2652 }
2653 },
2654 "403": {
2655 "description": "Missing or invalid authentication credentials"
2656 }
2657 }
2658 }
2659 }
2660 },
2661 "definitions": {
2662 "initialiseResponse": {
2663 "properties": {
2664 "token": {
2665 "type": "string"
2666 },
2667 "mode": {
2668 "type": "string"
2669 }
2670 }
2671 },
2672 "uiResponse": {
2673 "properties": {
2674 "ok": {
2675 "type": "string"
2676 },
2677 "uiType": {
2678 "description": "The UI Type selected (react or angular)",
2679 "type": "string"
2680 }
2681 }
2682 },
2683 "applicationPayload": {
2684 "properties": {
2685 "title": {
2686 "description": "Application Heading Title",
2687 "type": "string"
2688 },
2689 "logoB64": {
2690 "description": "Logo image defined as Base64 string, chunked into array elements, max 4000 characters",
2691 "type": "array",
2692 "items": {
2693 "type": "string"
2694 }
2695 },
2696 "themeColor": {
2697 "description": "CSS Theming Colour definition",
2698 "type": "string"
2699 },
2700 "browserTitle": {
2701 "description": "Title for browser tab/heading",
2702 "type": "string"
2703 }
2704 }
2705 },
2706 "applicationSaveResponse": {
2707 "properties": {
2708 "ok": {
2709 "type": "boolean"
2710 },
2711 "role": {
2712 "description": "User role",
2713 "type": "string"
2714 }
2715 }
2716 },
2717 "userResponse": {
2718 "properties": {
2719 "sub": {
2720 "description": "authentication key",
2721 "type": "string"
2722 },
2723 "given_name": {
2724 "description": "User's given (first) name",
2725 "type": "string"
2726 },
2727 "family_name": {
2728 "description": "User's family (last) name",
2729 "type": "string"
2730 },
2731 "email": {
2732 "description": "User's email address",
2733 "type": "string"
2734 },
2735 "tenant": {
2736 "description": "Not used",
2737 "type": "string"
2738 },
2739 "role": {
2740 "description": "User role",
2741 "type": "string"
2742 },
2743 "roles": {
2744 "description": "Array of roles (where more than 1 applies)",
2745 "type": "array",
2746 "items": {
2747 "description": "role",
2748 "type": "string"
2749 }
2750 }
2751 }
2752 },
2753 "userError": {
2754 "properties": {
2755 "error": {
2756 "type": "object",
2757 "properties": {
2758 "token": {
2759 "description": "User Session Token",
2760 "type": "string"
2761 },
2762 "reload": {
2763 "description": "UI reload trigger signal",
2764 "type": "boolean"
2765 }
2766 }
2767 }
2768 }
2769 },
2770 "patientsResponse": {
2771 "properties": {
2772 "patientId": {
2773 "description": "Object containing patient's data",
2774 "type": "object",
2775 "properties": {
2776 "address": {
2777 "description": "Postal Address",
2778 "type": "string"
2779 },
2780 "dateOfBirth": {
2781 "description": "Date of Birth: JavaScript Date().getTime() format",
2782 "type": "string"
2783 },
2784 "department": {
2785 "description": "Department category",
2786 "type": "string"
2787 },
2788 "gender": {
2789 "description": "Patient's Gender (Male/Female)",
2790 "type": "string"
2791 },
2792 "gpAddress": {
2793 "description": "GP's address",
2794 "type": "string"
2795 },
2796 "gpName": {
2797 "description": "GP's Name",
2798 "type": "string"
2799 },
2800 "id": {
2801 "description": "Patient's Id",
2802 "type": "string"
2803 },
2804 "name": {
2805 "description": "Patient's Name",
2806 "type": "string"
2807 },
2808 "nhsNumber": {
2809 "description": "NHS Number",
2810 "type": "string"
2811 },
2812 "pasNo": {
2813 "description": "PAS-specific Patient Identifier",
2814 "type": "string"
2815 },
2816 "phone": {
2817 "description": "User's Phone No",
2818 "type": "string"
2819 }
2820 }
2821 }
2822 }
2823 },
2824 "countsResponse": {
2825 "type": "array",
2826 "items": {
2827 "description": "Counts from one OpenEHR Source",
2828 "type": "object",
2829 "properties": {
2830 "diagnosesCount": {
2831 "description": "Number of Diagnoses",
2832 "type": "string"
2833 },
2834 "diagnosesDate": {
2835 "description": "Date count last updated",
2836 "type": "string"
2837 },
2838 "ordersCount": {
2839 "description": "Number of Orders",
2840 "type": "string"
2841 },
2842 "ordersDate": {
2843 "description": "Date count last updated",
2844 "type": "string"
2845 },
2846 "resultsCount": {
2847 "description": "Number of Results",
2848 "type": "string"
2849 },
2850 "resultsDate": {
2851 "description": "Date count last updated",
2852 "type": "string"
2853 },
2854 "vitalsCount": {
2855 "description": "Number of Vital Sign records",
2856 "type": "string"
2857 },
2858 "vitalsDate": {
2859 "description": "Date count last updated",
2860 "type": "string"
2861 },
2862 "source": {
2863 "description": "Source OpenEHR System",
2864 "type": "string"
2865 },
2866 "sourceId": {
2867 "description": "Notional Source Identifier (for completeness)",
2868 "type": "string"
2869 }
2870 }
2871 }
2872 },
2873 "headingPostResponse": {
2874 "properties": {
2875 "info": {
2876 "description": "Successful Post Confirmation",
2877 "type": "string"
2878 }
2879 }
2880 },
2881 "dicomStudiesResponse": {
2882 "type": "array",
2883 "items": {
2884 "description": "All Digital Imaging and Communications in Medicine (DICOM) studies for a specified patient",
2885 "type": "object",
2886 "properties": {
2887 "dateRecorded": {
2888 "description": "Date the study was recororded",
2889 "type": "string"
2890 },
2891 "studyDescription": {
2892 "description": "Description of the type of study conducted",
2893 "type": "string"
2894 },
2895 "source": {
2896 "description": "Reference to the originating system, e.g. orthanc",
2897 "type": "string"
2898 },
2899 "studyId": {
2900 "description": "Unique ID of the study",
2901 "type": "string"
2902 }
2903 }
2904 }
2905 },
2906 "documentsSummaryResponse": {
2907 "type": "array",
2908 "items": {
2909 "description": "Summary of documents for the selected patient",
2910 "type": "object",
2911 "properties": {
2912 "sourceId": {
2913 "description": "Composition Id of the Document",
2914 "type": "string"
2915 },
2916 "dateCreated": {
2917 "description": "Date on which the Document was created",
2918 "type": "string"
2919 },
2920 "author": {
2921 "description": "The Documents Author",
2922 "type": "string"
2923 },
2924 "documentType": {
2925 "description": "The Document type: Referral or Discharge Summary",
2926 "type": "string"
2927 },
2928 "source": {
2929 "description": "The OpenEHR system from which the Document was retrieved",
2930 "type": "string"
2931 }
2932 }
2933 }
2934 },
2935 "documentsDetailResponse": {
2936 "properties": {
2937 "sourceId": {
2938 "description": "Document Composition Id",
2939 "type": "string"
2940 },
2941 "author_name": {
2942 "description": "Document Author",
2943 "type": "string"
2944 },
2945 "author_id": {
2946 "description": "Document Author Id",
2947 "type": "string"
2948 },
2949 "author_idScheme": {
2950 "description": "Document Author Id Scheme",
2951 "type": "string"
2952 },
2953 "documentDate": {
2954 "description": "Document Creation Date",
2955 "type": "string"
2956 },
2957 "facility": {
2958 "description": "Hospital / Facility for which the document was created",
2959 "type": "string"
2960 },
2961 "patientIdentifer_mrn": {
2962 "description": "Patient Medical Record Number",
2963 "type": "string"
2964 },
2965 "patientIdentifer_mrnType": {
2966 "description": "Patient Medical Record Number Type",
2967 "type": "string"
2968 },
2969 "patientIdentifer_oth": {
2970 "description": "Patient OTH",
2971 "type": "string"
2972 },
2973 "patientIdentifer_othType": {
2974 "description": "Patient OTH Type",
2975 "type": "string"
2976 },
2977 "patientIdentifer_gms": {
2978 "description": "Patient GMS",
2979 "type": "string"
2980 },
2981 "patientIdentifer_gmsType": {
2982 "description": "Patient GMS Type",
2983 "type": "string"
2984 },
2985 "responsibleProfessional_name": {
2986 "description": "Name of Responsible Professional",
2987 "type": "string"
2988 },
2989 "responsibleProfessional_id": {
2990 "description": "Id of Responsible Professional",
2991 "type": "string"
2992 },
2993 "responsibleProfessional_idType": {
2994 "description": "Id Type of Responsible Professional",
2995 "type": "string"
2996 },
2997 "dischargingOrganisation": {
2998 "description": "Discharging Organisation",
2999 "type": "string"
3000 }
3001 }
3002 },
3003 "postDocumentResponse": {
3004 "properties": {
3005 "ok": {
3006 "type": "string"
3007 }
3008 }
3009 },
3010 "allergiesSummaryResponse": {
3011 "properties": {
3012 "source": {
3013 "description": "Source OpenEHR System",
3014 "type": "string"
3015 },
3016 "sourceId": {
3017 "description": "Source OpenEHR Composition Id",
3018 "type": "string"
3019 },
3020 "cause": {
3021 "type": "string"
3022 },
3023 "reaction": {
3024 "type": "string"
3025 }
3026 }
3027 },
3028 "allergiesDetailResponse": {
3029 "properties": {
3030 "source": {
3031 "type": "string"
3032 },
3033 "sourceId": {
3034 "type": "string"
3035 },
3036 "cause": {
3037 "type": "string"
3038 },
3039 "causeCode": {
3040 "type": "string"
3041 },
3042 "causeTerminology": {
3043 "type": "string"
3044 },
3045 "terminologyCode": {
3046 "type": "string"
3047 },
3048 "reaction": {
3049 "type": "string"
3050 },
3051 "author": {
3052 "type": "string"
3053 },
3054 "dateCreated": {
3055 "type": "string"
3056 },
3057 "originalComposition": {
3058 "type": "string"
3059 },
3060 "originalSource": {
3061 "type": "string"
3062 }
3063 }
3064 },
3065 "allergiesSchema": {
3066 "properties": {
3067 "author": {
3068 "type": "string"
3069 },
3070 "healthcareFacilityId": {
3071 "type": "string"
3072 },
3073 "healthcareFacilityName": {
3074 "type": "string"
3075 },
3076 "cause": {
3077 "type": "string"
3078 },
3079 "causeCode": {
3080 "type": "string"
3081 },
3082 "causeTerminology": {
3083 "type": "string"
3084 },
3085 "reaction": {
3086 "type": "string"
3087 },
3088 "originalComposition": {
3089 "type": "string"
3090 },
3091 "originalSource": {
3092 "type": "string"
3093 }
3094 }
3095 },
3096 "problemsSummaryResponse": {
3097 "properties": {
3098 "source": {
3099 "description": "Source OpenEHR System",
3100 "type": "string"
3101 },
3102 "sourceId": {
3103 "description": "Source OpenEHR Composition Id",
3104 "type": "string"
3105 },
3106 "problem": {
3107 "type": "string"
3108 },
3109 "dateOfOnset": {
3110 "type": "string"
3111 }
3112 }
3113 },
3114 "problemsDetailResponse": {
3115 "properties": {
3116 "source": {
3117 "type": "string"
3118 },
3119 "sourceId": {
3120 "type": "string"
3121 },
3122 "problem": {
3123 "type": "string"
3124 },
3125 "dateOfOnset": {
3126 "type": "string"
3127 },
3128 "description": {
3129 "type": "string"
3130 },
3131 "terminology": {
3132 "type": "string"
3133 },
3134 "code": {
3135 "type": "string"
3136 },
3137 "author": {
3138 "type": "string"
3139 },
3140 "dateCreated": {
3141 "type": "string"
3142 },
3143 "originalComposition": {
3144 "type": "string"
3145 },
3146 "originalSource": {
3147 "type": "string"
3148 }
3149 }
3150 },
3151 "problemsSchema": {
3152 "properties": {
3153 "author": {
3154 "type": "string"
3155 },
3156 "healthcareFacilityId": {
3157 "type": "string"
3158 },
3159 "healthcareFacilityName": {
3160 "type": "string"
3161 },
3162 "description": {
3163 "type": "string"
3164 },
3165 "problem": {
3166 "type": "string"
3167 },
3168 "code": {
3169 "type": "string"
3170 },
3171 "terminology": {
3172 "type": "string"
3173 },
3174 "dateOfOnset": {
3175 "type": "string"
3176 },
3177 "originalComposition": {
3178 "type": "string"
3179 },
3180 "originalSource": {
3181 "type": "string"
3182 }
3183 }
3184 },
3185 "medicationsSummaryResponse": {
3186 "properties": {
3187 "source": {
3188 "description": "Source OpenEHR System",
3189 "type": "string"
3190 },
3191 "sourceId": {
3192 "description": "Source OpenEHR Composition Id",
3193 "type": "string"
3194 },
3195 "name": {
3196 "type": "string"
3197 },
3198 "doseAmount": {
3199 "type": "string"
3200 },
3201 "dateCreated": {
3202 "type": "string"
3203 }
3204 }
3205 },
3206 "medicationsDetailResponse": {
3207 "properties": {
3208 "source": {
3209 "type": "string"
3210 },
3211 "sourceId": {
3212 "type": "string"
3213 },
3214 "name": {
3215 "type": "string"
3216 },
3217 "doseAmount": {
3218 "type": "string"
3219 },
3220 "doseDirections": {
3221 "type": "string"
3222 },
3223 "doseTiming": {
3224 "type": "string"
3225 },
3226 "route": {
3227 "type": "string"
3228 },
3229 "startDate": {
3230 "type": "string"
3231 },
3232 "startTime": {
3233 "type": "string"
3234 },
3235 "medicationCode": {
3236 "type": "string"
3237 },
3238 "medicationTerminology": {
3239 "type": "string"
3240 },
3241 "author": {
3242 "type": "string"
3243 },
3244 "dateCreated": {
3245 "type": "string"
3246 }
3247 }
3248 },
3249 "medicationsSchema": {
3250 "properties": {
3251 "author": {
3252 "type": "string"
3253 },
3254 "healthcareFacilityId": {
3255 "type": "string"
3256 },
3257 "healthcareFacilityName": {
3258 "type": "string"
3259 },
3260 "name": {
3261 "type": "string"
3262 },
3263 "medicationCode": {
3264 "type": "string"
3265 },
3266 "medicationTerminology": {
3267 "type": "string"
3268 },
3269 "doseDirections": {
3270 "type": "string"
3271 },
3272 "route": {
3273 "type": "string"
3274 },
3275 "doseAmount": {
3276 "type": "string"
3277 },
3278 "doseTiming": {
3279 "type": "string"
3280 },
3281 "startDate": {
3282 "type": "string"
3283 }
3284 }
3285 },
3286 "contactsSummaryResponse": {
3287 "properties": {
3288 "source": {
3289 "description": "Source OpenEHR System",
3290 "type": "string"
3291 },
3292 "sourceId": {
3293 "description": "Source OpenEHR Composition Id",
3294 "type": "string"
3295 },
3296 "name": {
3297 "type": "string"
3298 },
3299 "relationship": {
3300 "type": "string"
3301 },
3302 "nextOfKin": {
3303 "type": "string"
3304 }
3305 }
3306 },
3307 "contactsDetailResponse": {
3308 "properties": {
3309 "source": {
3310 "type": "string"
3311 },
3312 "sourceId": {
3313 "type": "string"
3314 },
3315 "name": {
3316 "type": "string"
3317 },
3318 "relationship": {
3319 "type": "string"
3320 },
3321 "relationshipType": {
3322 "type": "string"
3323 },
3324 "relationshipCode": {
3325 "type": "string"
3326 },
3327 "relationshipTerminology": {
3328 "type": "string"
3329 },
3330 "contactInformation": {
3331 "type": "string"
3332 },
3333 "nextOfKin": {
3334 "type": "string"
3335 },
3336 "notes": {
3337 "type": "string"
3338 },
3339 "author": {
3340 "type": "string"
3341 },
3342 "dateCreated": {
3343 "type": "string"
3344 }
3345 }
3346 },
3347 "contactsSchema": {
3348 "properties": {
3349 "author": {
3350 "type": "string"
3351 },
3352 "healthcareFacilityId": {
3353 "type": "string"
3354 },
3355 "healthcareFacilityName": {
3356 "type": "string"
3357 },
3358 "name": {
3359 "type": "string"
3360 },
3361 "contactInformation": {
3362 "type": "string"
3363 },
3364 "relationshipCode": {
3365 "type": "string"
3366 },
3367 "relationship": {
3368 "type": "string"
3369 },
3370 "nextOfKin": {
3371 "type": "string"
3372 },
3373 "notes": {
3374 "type": "string"
3375 }
3376 }
3377 },
3378 "labordersSummaryResponse": {
3379 "properties": {
3380 "source": {
3381 "description": "Source OpenEHR System",
3382 "type": "string"
3383 },
3384 "sourceId": {
3385 "description": "Source OpenEHR Composition Id",
3386 "type": "string"
3387 },
3388 "name": {
3389 "type": "string"
3390 },
3391 "orderDate": {
3392 "type": "string"
3393 }
3394 }
3395 },
3396 "labordersDetailResponse": {
3397 "properties": {
3398 "source": {
3399 "type": "string"
3400 },
3401 "sourceId": {
3402 "type": "string"
3403 },
3404 "name": {
3405 "type": "string"
3406 },
3407 "code": {
3408 "type": "string"
3409 },
3410 "terminology": {
3411 "type": "string"
3412 },
3413 "orderDate": {
3414 "type": "string"
3415 },
3416 "author": {
3417 "type": "string"
3418 },
3419 "dateCreated": {
3420 "type": "string"
3421 }
3422 }
3423 },
3424 "labordersSchema": {
3425 "properties": {
3426 "author": {
3427 "type": "string"
3428 },
3429 "healthcareFacilityId": {
3430 "type": "string"
3431 },
3432 "healthcareFacilityName": {
3433 "type": "string"
3434 },
3435 "code": {
3436 "type": "string"
3437 },
3438 "name": {
3439 "type": "string"
3440 },
3441 "terminology": {
3442 "type": "string"
3443 },
3444 "dateCreated": {
3445 "type": "string"
3446 }
3447 }
3448 },
3449 "labresultsSummaryResponse": {
3450 "properties": {
3451 "source": {
3452 "description": "Source OpenEHR System",
3453 "type": "string"
3454 },
3455 "sourceId": {
3456 "description": "Source OpenEHR Composition Id",
3457 "type": "string"
3458 },
3459 "testName": {
3460 "type": "string"
3461 },
3462 "sampleTaken": {
3463 "type": "string"
3464 },
3465 "dateCreated": {
3466 "type": "string"
3467 }
3468 }
3469 },
3470 "labresultsDetailResponse": {
3471 "properties": {
3472 "source": {
3473 "type": "string"
3474 },
3475 "sourceId": {
3476 "type": "string"
3477 },
3478 "testName": {
3479 "type": "string"
3480 },
3481 "sampleTaken": {
3482 "type": "string"
3483 },
3484 "status": {
3485 "type": "string"
3486 },
3487 "conclusion": {
3488 "type": "string"
3489 },
3490 "testResults": {
3491 "type": "string"
3492 },
3493 "author": {
3494 "type": "string"
3495 },
3496 "dateCreated": {
3497 "type": "string"
3498 }
3499 }
3500 },
3501 "proceduresSummaryResponse": {
3502 "properties": {
3503 "source": {
3504 "description": "Source OpenEHR System",
3505 "type": "string"
3506 },
3507 "sourceId": {
3508 "description": "Source OpenEHR Composition Id",
3509 "type": "string"
3510 },
3511 "name": {
3512 "type": "string"
3513 },
3514 "date": {
3515 "type": "string"
3516 },
3517 "time": {
3518 "type": "string"
3519 }
3520 }
3521 },
3522 "proceduresDetailResponse": {
3523 "properties": {
3524 "source": {
3525 "type": "string"
3526 },
3527 "sourceId": {
3528 "type": "string"
3529 },
3530 "name": {
3531 "type": "string"
3532 },
3533 "procedureName": {
3534 "type": "string"
3535 },
3536 "procedureCode": {
3537 "type": "string"
3538 },
3539 "date": {
3540 "type": "string"
3541 },
3542 "time": {
3543 "type": "string"
3544 },
3545 "procedureTerminology": {
3546 "type": "string"
3547 },
3548 "notes": {
3549 "type": "string"
3550 },
3551 "performer": {
3552 "type": "string"
3553 },
3554 "currentStatus": {
3555 "type": "string"
3556 },
3557 "author": {
3558 "type": "string"
3559 },
3560 "dateSubmitted": {
3561 "type": "string"
3562 },
3563 "originalComposition": {
3564 "type": "string"
3565 },
3566 "originalSource": {
3567 "type": "string"
3568 }
3569 }
3570 },
3571 "proceduresSchema": {
3572 "properties": {
3573 "author": {
3574 "type": "string"
3575 },
3576 "healthcareFacilityId": {
3577 "type": "string"
3578 },
3579 "healthcareFacilityName": {
3580 "type": "string"
3581 },
3582 "procedureName": {
3583 "type": "string"
3584 },
3585 "notes": {
3586 "type": "string"
3587 },
3588 "status": {
3589 "type": "string"
3590 },
3591 "procedureCode": {
3592 "type": "string"
3593 },
3594 "performer": {
3595 "type": "string"
3596 },
3597 "date": {
3598 "type": "string"
3599 },
3600 "originalComposition": {
3601 "type": "string"
3602 },
3603 "originalSource": {
3604 "type": "string"
3605 }
3606 }
3607 },
3608 "referralsSummaryResponse": {
3609 "properties": {
3610 "source": {
3611 "description": "Source OpenEHR System",
3612 "type": "string"
3613 },
3614 "sourceId": {
3615 "description": "Source OpenEHR Composition Id",
3616 "type": "string"
3617 },
3618 "dateOfReferral": {
3619 "type": "string"
3620 },
3621 "referralFrom": {
3622 "type": "string"
3623 },
3624 "referralTo": {
3625 "type": "string"
3626 }
3627 }
3628 },
3629 "referralsDetailResponse": {
3630 "properties": {
3631 "source": {
3632 "type": "string"
3633 },
3634 "sourceId": {
3635 "type": "string"
3636 },
3637 "referralType": {
3638 "type": "string"
3639 },
3640 "referralReason": {
3641 "type": "string"
3642 },
3643 "referralSummary": {
3644 "type": "string"
3645 },
3646 "referralFrom": {
3647 "type": "string"
3648 },
3649 "referralTo": {
3650 "type": "string"
3651 },
3652 "referralRef": {
3653 "type": "string"
3654 },
3655 "referralOutcome": {
3656 "type": "string"
3657 },
3658 "referralStateDate": {
3659 "type": "string"
3660 },
3661 "referralState": {
3662 "type": "string"
3663 },
3664 "referralStateCode": {
3665 "type": "string"
3666 },
3667 "referralCareFlow": {
3668 "type": "string"
3669 },
3670 "referralServiceName": {
3671 "type": "string"
3672 },
3673 "author": {
3674 "type": "string"
3675 },
3676 "dateOfReferral": {
3677 "type": "string"
3678 },
3679 "dateCreated": {
3680 "type": "string"
3681 }
3682 }
3683 },
3684 "referralsSchema": {
3685 "properties": {
3686 "author": {
3687 "type": "string"
3688 },
3689 "healthcareFacilityId": {
3690 "type": "string"
3691 },
3692 "healthcareFacilityName": {
3693 "type": "string"
3694 },
3695 "referralServiceName": {
3696 "type": "string"
3697 },
3698 "referralReason": {
3699 "type": "string"
3700 },
3701 "referralSummary": {
3702 "type": "string"
3703 },
3704 "referralStateDate": {
3705 "type": "string"
3706 },
3707 "referralFrom": {
3708 "type": "string"
3709 },
3710 "referralRef": {
3711 "type": "string"
3712 },
3713 "referralTo": {
3714 "type": "string"
3715 },
3716 "referralReason)": {
3717 "type": "string"
3718 }
3719 }
3720 },
3721 "appointmentsSummaryResponse": {
3722 "properties": {
3723 "source": {
3724 "description": "Source OpenEHR System",
3725 "type": "string"
3726 },
3727 "sourceId": {
3728 "description": "Source OpenEHR Composition Id",
3729 "type": "string"
3730 },
3731 "serviceTeam": {
3732 "type": "string"
3733 },
3734 "dateOfAppointment": {
3735 "type": "string"
3736 },
3737 "timeOfAppointment": {
3738 "type": "string"
3739 }
3740 }
3741 },
3742 "appointmentsDetailResponse": {
3743 "properties": {
3744 "source": {
3745 "type": "string"
3746 },
3747 "sourceId": {
3748 "type": "string"
3749 },
3750 "serviceTeam": {
3751 "type": "string"
3752 },
3753 "dateOfAppointment": {
3754 "type": "string"
3755 },
3756 "timeOfAppointment": {
3757 "type": "string"
3758 },
3759 "location": {
3760 "type": "string"
3761 },
3762 "status": {
3763 "type": "string"
3764 },
3765 "author": {
3766 "type": "string"
3767 },
3768 "dateCreated": {
3769 "type": "string"
3770 }
3771 }
3772 },
3773 "appointmentsSchema": {
3774 "properties": {
3775 "author": {
3776 "type": "string"
3777 },
3778 "healthcareFacilityId": {
3779 "type": "string"
3780 },
3781 "healthcareFacilityName": {
3782 "type": "string"
3783 },
3784 "serviceTeam": {
3785 "type": "string"
3786 },
3787 "dateOfAppointment": {
3788 "type": "string"
3789 },
3790 "location": {
3791 "type": "string"
3792 },
3793 "status": {
3794 "type": "string"
3795 },
3796 "dateCreated": {
3797 "type": "string"
3798 }
3799 }
3800 },
3801 "eolcareplansSummaryResponse": {
3802 "properties": {
3803 "source": {
3804 "description": "Source OpenEHR System",
3805 "type": "string"
3806 },
3807 "sourceId": {
3808 "description": "Source OpenEHR Composition Id",
3809 "type": "string"
3810 },
3811 "name": {
3812 "type": "string"
3813 },
3814 "type": {
3815 "type": "string"
3816 },
3817 "dateCreated": {
3818 "type": "string"
3819 }
3820 }
3821 },
3822 "eolcareplansDetailResponse": {
3823 "properties": {
3824 "source": {
3825 "type": "string"
3826 },
3827 "sourceId": {
3828 "type": "string"
3829 },
3830 "name": {
3831 "type": "string"
3832 },
3833 "type": {
3834 "type": "string"
3835 },
3836 "careDocument": {
3837 "type": "string"
3838 },
3839 "cprDecision": {
3840 "type": "string"
3841 },
3842 "prioritiesOfCare": {
3843 "type": "string"
3844 },
3845 "treatmentDecision": {
3846 "type": "string"
3847 },
3848 "author": {
3849 "type": "string"
3850 },
3851 "dateCreated": {
3852 "type": "string"
3853 }
3854 }
3855 },
3856 "eolcareplansSchema": {
3857 "properties": {
3858 "author": {
3859 "type": "string"
3860 },
3861 "healthcareFacilityId": {
3862 "type": "string"
3863 },
3864 "healthcareFacilityName": {
3865 "type": "string"
3866 },
3867 "prioritiesOfCare.placeOfCare": {
3868 "type": "string"
3869 },
3870 "prioritiesOfCare.placeOfDeath": {
3871 "type": "string"
3872 },
3873 "prioritiesOfCare.comment": {
3874 "type": "string"
3875 },
3876 "treatmentDecision.decisionToRefuseTreatment": {
3877 "type": "string"
3878 },
3879 "treatmentDecision.dateOfDecision)": {
3880 "type": "string"
3881 },
3882 "cprDecision.cprDecision": {
3883 "type": "string"
3884 },
3885 "cprDecision.dateOfDecision)": {
3886 "type": "string"
3887 },
3888 "cprDecision.comment": {
3889 "type": "string"
3890 }
3891 }
3892 },
3893 "mdtreportsSummaryResponse": {
3894 "properties": {
3895 "source": {
3896 "description": "Source OpenEHR System",
3897 "type": "string"
3898 },
3899 "sourceId": {
3900 "description": "Source OpenEHR Composition Id",
3901 "type": "string"
3902 },
3903 "serviceTeam": {
3904 "type": "string"
3905 },
3906 "dateOfRequest": {
3907 "type": "string"
3908 },
3909 "dateOfMeeting": {
3910 "type": "string"
3911 }
3912 }
3913 },
3914 "mdtreportsDetailResponse": {
3915 "properties": {
3916 "source": {
3917 "type": "string"
3918 },
3919 "sourceId": {
3920 "type": "string"
3921 },
3922 "serviceTeam": {
3923 "type": "string"
3924 },
3925 "dateOfRequest": {
3926 "type": "string"
3927 },
3928 "dateOfMeeting": {
3929 "type": "string"
3930 },
3931 "timeOfMeeting": {
3932 "type": "string"
3933 },
3934 "servicePageLink": {
3935 "type": "string"
3936 },
3937 "question": {
3938 "type": "string"
3939 },
3940 "notes": {
3941 "type": "string"
3942 }
3943 }
3944 },
3945 "personalnotesSummaryResponse": {
3946 "properties": {
3947 "source": {
3948 "description": "Source OpenEHR System",
3949 "type": "string"
3950 },
3951 "sourceId": {
3952 "description": "Source OpenEHR Composition Id",
3953 "type": "string"
3954 },
3955 "noteType": {
3956 "type": "string"
3957 },
3958 "author": {
3959 "type": "string"
3960 },
3961 "dateCreated": {
3962 "type": "string"
3963 }
3964 }
3965 },
3966 "personalnotesDetailResponse": {
3967 "properties": {
3968 "source": {
3969 "type": "string"
3970 },
3971 "sourceId": {
3972 "type": "string"
3973 },
3974 "noteType": {
3975 "type": "string"
3976 },
3977 "notes": {
3978 "type": "string"
3979 },
3980 "author": {
3981 "type": "string"
3982 },
3983 "dateCreated": {
3984 "type": "string"
3985 }
3986 }
3987 },
3988 "personalnotesSchema": {
3989 "properties": {
3990 "author": {
3991 "type": "string"
3992 },
3993 "healthcareFacilityId": {
3994 "type": "string"
3995 },
3996 "healthcareFacilityName": {
3997 "type": "string"
3998 },
3999 "noteType": {
4000 "type": "string"
4001 },
4002 "notes": {
4003 "type": "string"
4004 }
4005 }
4006 },
4007 "vaccinationsSummaryResponse": {
4008 "properties": {
4009 "source": {
4010 "description": "Source OpenEHR System",
4011 "type": "string"
4012 },
4013 "sourceId": {
4014 "description": "Source OpenEHR Composition Id",
4015 "type": "string"
4016 },
4017 "vaccinationName": {
4018 "type": "string"
4019 },
4020 "dateCreated": {
4021 "type": "string"
4022 }
4023 }
4024 },
4025 "vaccinationsDetailResponse": {
4026 "properties": {
4027 "source": {
4028 "type": "string"
4029 },
4030 "sourceId": {
4031 "type": "string"
4032 },
4033 "vaccinationName": {
4034 "type": "string"
4035 },
4036 "comment": {
4037 "type": "string"
4038 },
4039 "series": {
4040 "type": "string"
4041 },
4042 "vaccinationDateTime": {
4043 "type": "string"
4044 },
4045 "author": {
4046 "type": "string"
4047 },
4048 "dateCreated": {
4049 "type": "string"
4050 }
4051 }
4052 },
4053 "vaccinationsSchema": {
4054 "properties": {
4055 "author": {
4056 "type": "string"
4057 },
4058 "healthcareFacilityId": {
4059 "type": "string"
4060 },
4061 "healthcareFacilityName": {
4062 "type": "string"
4063 },
4064 "vaccinationName": {
4065 "type": "string"
4066 },
4067 "series": {
4068 "type": "string"
4069 },
4070 "comment": {
4071 "type": "string"
4072 },
4073 "vaccinationDateTime)": {
4074 "type": "string"
4075 }
4076 }
4077 },
4078 "vitalsignsSummaryResponse": {
4079 "properties": {
4080 "source": {
4081 "description": "Source OpenEHR System",
4082 "type": "string"
4083 },
4084 "sourceId": {
4085 "description": "Source OpenEHR Composition Id",
4086 "type": "string"
4087 },
4088 "author": {
4089 "type": "string"
4090 },
4091 "dateCreated": {
4092 "type": "string"
4093 },
4094 "newsScore": {
4095 "type": "string"
4096 },
4097 "respirationRate": {
4098 "type": "string"
4099 },
4100 "oxygenSupplemental": {
4101 "type": "string"
4102 },
4103 "heartRate": {
4104 "type": "string"
4105 },
4106 "temperature": {
4107 "type": "string"
4108 },
4109 "levelOfConsciousness": {
4110 "type": "string"
4111 },
4112 "systolicBP": {
4113 "type": "string"
4114 },
4115 "diastolicBP": {
4116 "type": "string"
4117 },
4118 "oxygenSaturation": {
4119 "type": "string"
4120 }
4121 }
4122 },
4123 "vitalsignsDetailResponse": {
4124 "properties": {
4125 "source": {
4126 "type": "string"
4127 },
4128 "sourceId": {
4129 "type": "string"
4130 },
4131 "respirationRate": {
4132 "type": "string"
4133 },
4134 "oxygenSupplemental": {
4135 "type": "string"
4136 },
4137 "heartRate": {
4138 "type": "string"
4139 },
4140 "temperature": {
4141 "type": "string"
4142 },
4143 "levelOfConsciousness": {
4144 "type": "string"
4145 },
4146 "systolicBP": {
4147 "type": "string"
4148 },
4149 "diastolicBP": {
4150 "type": "string"
4151 },
4152 "oxygenSaturation": {
4153 "type": "string"
4154 },
4155 "newsScore": {
4156 "type": "string"
4157 },
4158 "author": {
4159 "type": "string"
4160 },
4161 "dateCreated": {
4162 "type": "string"
4163 }
4164 }
4165 },
4166 "vitalsignsSchema": {
4167 "properties": {
4168 "author": {
4169 "type": "string"
4170 },
4171 "healthcareFacilityId": {
4172 "type": "string"
4173 },
4174 "healthcareFacilityName": {
4175 "type": "string"
4176 },
4177 "respirationRate": {
4178 "type": "string"
4179 },
4180 "oxygenSupplemental)": {
4181 "type": "string"
4182 },
4183 "heartRate": {
4184 "type": "string"
4185 },
4186 "temperature": {
4187 "type": "string"
4188 },
4189 "levelOfConsciousness)": {
4190 "type": "string"
4191 },
4192 "systolicBP": {
4193 "type": "string"
4194 },
4195 "diastolicBP": {
4196 "type": "string"
4197 },
4198 "oxygenSaturation": {
4199 "type": "string"
4200 },
4201 "newsScore": {
4202 "type": "string"
4203 }
4204 }
4205 },
4206 "clinicalnotesSummaryResponse": {
4207 "properties": {
4208 "source": {
4209 "description": "Source OpenEHR System",
4210 "type": "string"
4211 },
4212 "sourceId": {
4213 "description": "Source OpenEHR Composition Id",
4214 "type": "string"
4215 },
4216 "author": {
4217 "type": "string"
4218 },
4219 "dateCreated": {
4220 "type": "string"
4221 },
4222 "clinicalNotesType": {
4223 "type": "string"
4224 }
4225 }
4226 },
4227 "clinicalnotesDetailResponse": {
4228 "properties": {
4229 "source": {
4230 "type": "string"
4231 },
4232 "sourceId": {
4233 "type": "string"
4234 },
4235 "note": {
4236 "type": "string"
4237 },
4238 "clinicalNotesType": {
4239 "type": "string"
4240 },
4241 "author": {
4242 "type": "string"
4243 },
4244 "dateCreated": {
4245 "type": "string"
4246 }
4247 }
4248 },
4249 "clinicalnotesSchema": {
4250 "properties": {
4251 "author": {
4252 "type": "string"
4253 },
4254 "healthcareFacilityId": {
4255 "type": "string"
4256 },
4257 "healthcareFacilityName": {
4258 "type": "string"
4259 },
4260 "clinicalNotesType": {
4261 "type": "string"
4262 },
4263 "note": {
4264 "type": "string"
4265 }
4266 }
4267 },
4268 "eventsSummaryResponse": {
4269 "properties": {
4270 "source": {
4271 "description": "Source OpenEHR System",
4272 "type": "string"
4273 },
4274 "sourceId": {
4275 "description": "Source OpenEHR Composition Id",
4276 "type": "string"
4277 },
4278 "dateCreated": {
4279 "type": "string"
4280 },
4281 "type": {
4282 "type": "string"
4283 },
4284 "name": {
4285 "type": "string"
4286 },
4287 "description": {
4288 "type": "string"
4289 },
4290 "dateTime": {
4291 "type": "string"
4292 }
4293 }
4294 },
4295 "eventsDetailResponse": {
4296 "properties": {
4297 "source": {
4298 "type": "string"
4299 },
4300 "sourceId": {
4301 "type": "string"
4302 },
4303 "name": {
4304 "type": "string"
4305 },
4306 "type": {
4307 "type": "string"
4308 },
4309 "description": {
4310 "type": "string"
4311 },
4312 "dateTime": {
4313 "type": "string"
4314 },
4315 "author": {
4316 "type": "string"
4317 },
4318 "dateCreated": {
4319 "type": "string"
4320 }
4321 }
4322 },
4323 "eventsSchema": {
4324 "properties": {
4325 "author": {
4326 "type": "string"
4327 },
4328 "healthcareFacilityId": {
4329 "type": "string"
4330 },
4331 "healthcareFacilityName": {
4332 "type": "string"
4333 },
4334 "name": {
4335 "type": "string"
4336 },
4337 "type": {
4338 "type": "string"
4339 },
4340 "description": {
4341 "type": "string"
4342 },
4343 "dateTime": {
4344 "type": "string"
4345 }
4346 }
4347 }
4348 }
4349}