Skip to content

Commit f764081

Browse files
ORybak5ORybak5
committed
adding examples of request-response interactions
1 parent 9b873fc commit f764081

File tree

1 file changed

+114
-0
lines changed

1 file changed

+114
-0
lines changed

‎gp2gp_adaptor_response_docs.yaml‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,16 @@ paths:
2222
application/json:
2323
schema:
2424
$ref: '#/components/schemas/EhrStatusRequestQuery'
25+
examples:
26+
request-example:
27+
summary: Example Request for EHR Status
28+
value:
29+
fromDateTime: "2020-10-31T01:30:00.000Z"
30+
toDateTime: "2030-10-31T01:30:00.000Z"
31+
fromAsid: "918999198738"
32+
toAsid: "200000000359"
33+
fromOdsCode: "P883302"
34+
toOdsCode: "P113302"
2535
required: true
2636
responses:
2737
'200':
@@ -32,6 +42,33 @@ paths:
3242
type: array
3343
items:
3444
$ref: '#/components/schemas/EhrStatusRequest'
45+
46+
examples:
47+
successful-migration:
48+
summary: Successful Migration scenario
49+
value:
50+
- initialRequestTimestamp: "2023-09-20T11:47:58.966Z"
51+
actionCompletedTimestamp: "2023-09-20T11:54:19.552Z"
52+
nhsNumber: "9729734925"
53+
conversationId: "59B118DB-70C3-4883-8A60-5E725981F003"
54+
migrationStatus: "COMPLETE"
55+
fromAsid: "858000001001"
56+
toAsid: "200000001908"
57+
fromOdsCode: "C88046"
58+
toOdsCode: "B84012"
59+
failed-migration:
60+
summary: Failed Migration scenario
61+
value:
62+
- initialRequestTimestamp: "2023-09-20T12:18:10.364Z"
63+
actionCompletedTimestamp: "2023-09-20T12:18:13.923Z"
64+
nhsNumber: "9729735336"
65+
conversationId: "C2A59970-57AF-11EE-AFE6-CD607DC58E3B"
66+
migrationStatus: "FAILED_INCUMBENT"
67+
fromAsid: "200000000169"
68+
toAsid: "200000001908"
69+
fromOdsCode: "P84009"
70+
toOdsCode: "B84012"
71+
3572
/ehr-resend/{conversationId}:
3673
post:
3774
tags:
@@ -82,6 +119,83 @@ paths:
82119
'*/*':
83120
schema:
84121
$ref: '#/components/schemas/EhrStatus'
122+
examples:
123+
example-1:
124+
summary: Successful EHR Status Response
125+
value:
126+
- attachmentStatus: []
127+
migrationLog:
128+
- received: "2023-07-24T09:39:09.377Z"
129+
conversationClosed: "2023-07-24T09:39:09.377Z"
130+
errors: null
131+
messageRef: "0BEBCA12-8BE4-44B4-BDC0-016A4FE3D107"
132+
migrationStatus: "COMPLETE"
133+
originalRequestDate: "2023-07-24T09:38:50.947Z"
134+
fromAsid: "918999198738"
135+
toAsid: "200000000359"
136+
example-2:
137+
summary: Failed by requester, with single negative acknowledgement of EHR Extract (conversation closed and error)
138+
value:
139+
- attachmentStatus: []
140+
migrationLog:
141+
- received: "2023-07-24T09:39:09.377Z"
142+
conversationClosed: "2023-07-24T09:39:09.377Z"
143+
errors: [
144+
{
145+
"code": "11",
146+
"display": "Failed to successfully integrate EHR Extract"
147+
}
148+
]
149+
messageRef: "0BEBCA12-8BE4-44B4-BDC0-016A4FE3D107"
150+
migrationStatus: "FAILED_INCUMBENT"
151+
originalRequestDate: "2023-07-24T09:38:50.947Z"
152+
fromAsid: "918999198738"
153+
toAsid: "200000000359"
154+
example-3:
155+
summary: Failed by requester, with multiple positive acknowledgements for COPC messages (without conversation closed) and one negative acknowledgement for EHR Extract (conversation closed and error)
156+
value:
157+
- attachmentStatus:
158+
- identifier:
159+
- system: "https://EMISWeb/A82038"
160+
value: "ad174c84-51d1-4744-89e3-7918a31248d1"
161+
fileStatus: "ORIGINAL_FILE"
162+
fileName: "54E94A29-B0CC-4CD6-86B0-B21C9C0CA894.doc"
163+
originalDescription: "Referral for further care (22-Dec-2020)"
164+
- identifier:
165+
- system: "https://EMISWeb/A82038"
166+
value: "D7AF52BA-79BA-4AF8-9010-F0C2DF916CEC"
167+
fileStatus: "ORIGINAL_FILE"
168+
fileName: "629BF3F7-C71F-49D7-8FCD-AEE16C11AFBD.doc"
169+
originalDescription: "Referral for further care (22-Dec-2020)"
170+
- identifier:
171+
- system: "https://EMISWeb/A82038"
172+
value: "D7AF52BA-79BA-4AF8-9010-F0C2DF916CEC"
173+
fileStatus: "ORIGINAL_FILE"
174+
fileName: "2F73A243-0F94-4683-B3F9-727CE7780815.doc"
175+
originalDescription: "Referral for further care (22-Dec-2020)"
176+
migrationLog:
177+
- received: "2023-07-24T10:42:18.591Z"
178+
conversationClosed: null
179+
errors: null
180+
messageRef: "ED2FB0DD-52AE-4EBC-B596-3BCA9CF5B272"
181+
- received: "2023-07-24T10:42:19.176Z"
182+
conversationClosed: null
183+
errors: null
184+
messageRef: "5068BAE1-7228-4E59-B3AD-92FA5CBDE4AC"
185+
- received: "2023-07-24T10:42:19.467Z"
186+
conversationClosed: null
187+
errors: null
188+
messageRef: "A9E37B68-07F4-43A5-889E-645D6681CE68"
189+
- received: "2023-07-24T10:42:22.611Z"
190+
conversationClosed: "2023-07-24T10:42:22.611Z"
191+
errors:
192+
- code: "99"
193+
display: "Unexpected condition."
194+
messageRef: "E600D1D4-D5BE-4D0D-8080-F7F6188B0548"
195+
migrationStatus: "FAILED_INCUMBENT"
196+
originalRequestDate: "2023-07-24T10:42:05.757Z"
197+
fromAsid: "918999198738"
198+
toAsid: "200000000359"
85199
components:
86200
schemas:
87201
AckHistory:

0 commit comments

Comments
 (0)