Skip to content

Commit 26e7214

Browse files
ORybak5ORybak5
committed
addressing PR comments
1 parent b6b1f22 commit 26e7214

File tree

1 file changed

+15
-183
lines changed

1 file changed

+15
-183
lines changed

‎gp2gp_adaptor_response_docs.yaml‎

Lines changed: 15 additions & 183 deletions
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,6 @@ paths:
8585
responses:
8686
'202':
8787
description: Successfull Ehr Extract resend request
88-
content:
89-
application/json:
90-
schema:
91-
type: string
9288
'404':
9389
description: Not Found
9490
content:
@@ -116,7 +112,7 @@ paths:
116112
'200':
117113
description: OK
118114
content:
119-
'*/*':
115+
application/json:
120116
schema:
121117
$ref: '#/components/schemas/EhrStatus'
122118
examples:
@@ -196,6 +192,15 @@ paths:
196192
originalRequestDate: "2023-07-24T10:42:05.757Z"
197193
fromAsid: "918999198738"
198194
toAsid: "200000000359"
195+
example-4:
196+
summary: Failed by adaptor, due to a PATIENT_NOT_FOUND error from the GP Connect provider's migrate structured endpoint
197+
value:
198+
- attachmentStatus: []
199+
migrationLog: []
200+
migrationStatus: "FAILED_NME"
201+
originalRequestDate: "2023-07-24T09:38:50.947Z"
202+
fromAsid: "918999198738"
203+
toAsid: "200000000359"
199204
components:
200205
schemas:
201206
AckHistory:
@@ -205,140 +210,6 @@ components:
205210
type: array
206211
items:
207212
$ref: '#/components/schemas/EhrReceivedAcknowledgement'
208-
AckPending:
209-
type: object
210-
properties:
211-
taskId:
212-
type: string
213-
messageId:
214-
type: string
215-
typeCode:
216-
type: string
217-
updatedAt:
218-
type: string
219-
AckToRequester:
220-
type: object
221-
properties:
222-
taskId:
223-
type: string
224-
messageId:
225-
type: string
226-
typeCode:
227-
type: string
228-
reasonCode:
229-
type: string
230-
detail:
231-
type: string
232-
EhrContinue:
233-
type: object
234-
properties:
235-
received:
236-
type: string
237-
format: date-time
238-
EhrExtractCore:
239-
type: object
240-
properties:
241-
sentAt:
242-
type: string
243-
format: date-time
244-
taskId:
245-
type: string
246-
EhrExtractCorePending:
247-
type: object
248-
properties:
249-
sentAt:
250-
type: string
251-
format: date-time
252-
taskId:
253-
type: string
254-
EhrRequest:
255-
type: object
256-
properties:
257-
requestId:
258-
type: string
259-
nhsNumber:
260-
type: string
261-
fromPartyId:
262-
type: string
263-
toPartyId:
264-
type: string
265-
fromAsid:
266-
type: string
267-
toAsid:
268-
type: string
269-
fromOdsCode:
270-
type: string
271-
toOdsCode:
272-
type: string
273-
messageId:
274-
type: string
275-
GpcAccessStructured:
276-
type: object
277-
properties:
278-
objectName:
279-
type: string
280-
accessedAt:
281-
type: string
282-
format: date-time
283-
taskId:
284-
type: string
285-
attachment:
286-
$ref: '#/components/schemas/GpcDocument'
287-
GpcDocument:
288-
type: object
289-
properties:
290-
documentId:
291-
type: string
292-
accessDocumentUrl:
293-
type: string
294-
contentLength:
295-
type: integer
296-
format: int32
297-
objectName:
298-
type: string
299-
accessedAt:
300-
type: string
301-
format: date-time
302-
fileName:
303-
type: string
304-
contentType:
305-
type: string
306-
taskId:
307-
type: string
308-
messageId:
309-
type: string
310-
sentToMhs:
311-
$ref: '#/components/schemas/SentToMhs'
312-
identifier:
313-
type: array
314-
items:
315-
$ref: '#/components/schemas/Identifier'
316-
originalDescription:
317-
type: string
318-
gpConnectErrorMessage:
319-
type: string
320-
skeleton:
321-
type: boolean
322-
SentToMhs:
323-
type: object
324-
properties:
325-
messageId:
326-
type: array
327-
items:
328-
type: string
329-
sentAt:
330-
type: string
331-
taskId:
332-
type: string
333-
GpcAccessDocument:
334-
type: object
335-
properties:
336-
documents:
337-
type: array
338-
items:
339-
$ref: '#/components/schemas/GpcDocument'
340-
patientId:
341-
type: string
342213
Error:
343214
type: object
344215
properties:
@@ -355,47 +226,6 @@ components:
355226
description: 'The GP2GP response text from the negative response'
356227
taskType:
357228
type: string
358-
EhrExtractStatus:
359-
type: object
360-
properties:
361-
id:
362-
type: string
363-
created:
364-
type: string
365-
format: date-time
366-
updatedAt:
367-
type: string
368-
format: date-time
369-
conversationId:
370-
type: string
371-
ehrRequest:
372-
$ref: '#/components/schemas/EhrRequest'
373-
gpcAccessStructured:
374-
$ref: '#/components/schemas/GpcAccessStructured'
375-
gpcAccessDocument:
376-
$ref: '#/components/schemas/GpcAccessDocument'
377-
ehrExtractCore:
378-
$ref: '#/components/schemas/EhrExtractCore'
379-
ehrExtractCorePending:
380-
$ref: '#/components/schemas/EhrExtractCorePending'
381-
ehrContinue:
382-
$ref: '#/components/schemas/EhrContinue'
383-
ackToRequester:
384-
$ref: '#/components/schemas/AckToRequester'
385-
ackPending:
386-
$ref: '#/components/schemas/AckPending'
387-
ehrReceivedAcknowledgement:
388-
$ref: '#/components/schemas/EhrReceivedAcknowledgement'
389-
error:
390-
$ref: '#/components/schemas/Error'
391-
messageTimestamp:
392-
type: string
393-
format: date-time
394-
ehrExtractMessageId:
395-
type: string
396-
ackHistory:
397-
$ref: '#/components/schemas/AckHistory'
398-
description: Details about EhrExtractStatus
399229
EhrStatusRequestQuery:
400230
type: object
401231
properties:
@@ -479,9 +309,7 @@ components:
479309
originalDescription:
480310
type: string
481311
nullable: True
482-
description: 'The description of the file as given by the description element of the GP Connect DocumentReference resource.
483-
484-
This is inserted into the GP2GP placeholder document as the original filename and suffix. So should be of the form filename.suffix, e.g. referral.txt'
312+
description: 'The description of the file as given by the description element of the GP Connect DocumentReference resource. This is inserted into the GP2GP placeholder document as the original filename and suffix. So should be of the form filename.suffix, e.g. referral.txt'
485313
EhrReceivedAcknowledgement:
486314
type: object
487315
properties:
@@ -542,8 +370,12 @@ components:
542370
properties:
543371
code:
544372
type: string
373+
nullable: False
374+
description: 'The code of the error'
545375
display:
546376
type: string
377+
nullable: False
378+
description: 'The human-readable description of the error'
547379
Identifier:
548380
type: object
549381
properties:

0 commit comments

Comments
 (0)