-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathopenapi.yaml
More file actions
288 lines (288 loc) · 10.2 KB
/
openapi.yaml
File metadata and controls
288 lines (288 loc) · 10.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
openapi: 3.0.3
info:
title: Gateway API
description: Clinical Data Gateway API
version: 0.1.0
contact:
name: API Support
servers:
- url: http://localhost:5000
description: Local development server
components:
securitySchemes:
nhs-cis2-aal3:
$ref: https://proxygen.ptl.api.platform.nhs.uk/components/securitySchemes/nhs-cis2-aal3
paths:
/patient/$gpc.getstructuredrecord:
post:
summary: Get structured record
description: Returns a FHIR Bundle containing patient structured record
security:
- nhs-cis2-aal3: []
operationId: getStructuredRecord
parameters:
- in: header
name: Content-Type
schema:
type: string
example: "application/fhir+json"
enum: [application/fhir+json]
required: true
- in: header
name: Ods-from
required: true
schema:
type: string
example: "A12345"
minLength: 1
- in: header
name: Ssp-TraceID
required: true
schema:
type: string
example: "trace-1234"
minLength: 1
requestBody:
required: true
content:
application/fhir+json:
schema:
type: object
required:
- resourceType
- parameter
properties:
resourceType:
type: string
enum: ["Parameters"]
example: "Parameters"
meta:
type: object
properties:
lastUpdated:
type: string
format: date-time
example: "2026-01-12T10:00:00Z"
versionId:
type: string
example: "1"
parameter:
type: array
minItems: 1
items:
type: object
required:
- name
- valueIdentifier
properties:
name:
type: string
enum: ["patientNHSNumber"]
example: "patientNHSNumber"
valueIdentifier:
type: object
required:
- system
- value
properties:
system:
type: string
enum: ["https://fhir.nhs.uk/Id/nhs-number"]
example: "https://fhir.nhs.uk/Id/nhs-number"
value:
type: string
pattern: "^[0-9]{10}$"
example: "9999999999"
responses:
'200':
description: Successful response
parameters:
- in: header
name: Content-Type
schema:
type: string
enum: [application/fhir+json]
required: true
content:
application/fhir+json:
schema:
type: object
properties:
statusCode:
type: integer
description: Status code of the interaction
example: 200
headers:
type: object
properties:
Content-Type:
type: string
example: "application/fhir+json"
body:
type: object
description: FHIR Bundle containing patient data
properties:
resourceType:
type: string
example: "Bundle"
id:
type: string
example: "example-patient-bundle"
type:
type: string
example: "collection"
timestamp:
type: string
format: date-time
example: "2026-01-12T10:00:00Z"
entry:
type: array
items:
type: object
properties:
fullUrl:
type: string
example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
resource:
type: object
properties:
resourceType:
type: string
example: "Patient"
id:
type: string
example: "9999999999"
identifier:
type: array
items:
type: object
properties:
system:
type: string
example: "https://fhir.nhs.uk/Id/nhs-number"
value:
type: string
example: "9999999999"
name:
type: array
items:
type: object
properties:
use:
type: string
example: "official"
family:
type: string
example: "Doe"
given:
type: array
items:
type: string
example: ["John"]
gender:
type: string
example: "male"
birthDate:
type: string
format: date
example: "1985-04-12"
'400':
description: Bad request - invalid input parameters
content:
application/fhir+json:
schema:
type: object
properties:
resourceType:
type: string
example: "OperationOutcome"
issue:
type: array
items:
type: object
properties:
severity:
type: string
example: "error"
code:
type: string
example: "invalid"
diagnostics:
type: string
example: "Invalid NHS number format"
'401':
description: Unauthorized - authentication token is missing or invalid
'403':
description: Forbidden - insufficient privileges to access this resource
'404':
description: Patient not found
content:
application/fhir+json:
schema:
type: object
properties:
resourceType:
type: string
example: "OperationOutcome"
issue:
type: array
items:
type: object
properties:
severity:
type: string
example: "error"
code:
type: string
example: "not-found"
diagnostics:
type: string
example: "Patient not found"
'500':
description: Internal server error
content:
application/fhir+json:
schema:
type: object
properties:
resourceType:
type: string
example: "OperationOutcome"
issue:
type: array
items:
type: object
properties:
severity:
type: string
example: "error"
code:
type: string
example: "exception"
diagnostics:
type: string
example: "Internal server error"
'502':
description: Received an error response from a downstream server
content:
application/fhir+json:
schema:
type: object
properties:
resourceType:
type: string
example: "OperationOutcome"
issue:
type: array
items:
type: object
properties:
severity:
type: string
example: "error"
code:
type: string
example: "exception"
diagnostics:
type: string
example: "PDS FHIR API request failed: Bad Gateway"