Skip to content

Commit 0891a56

Browse files
bramwesselobramwesselo
committed
added localization.openapi.json
1 parent 704fc9e commit 0891a56

File tree

2 files changed

+204
-1
lines changed

2 files changed

+204
-1
lines changed

‎input/images/localization.openapi.json‎

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
{
2+
"openapi": "3.0.2",
3+
"info": {
4+
"title": "Localization API",
5+
"version": "1.0.0"
6+
},
7+
"paths": {
8+
"/api": {
9+
"post": {
10+
"summary": "Create a new NVI resource",
11+
"requestBody": {
12+
"required": true,
13+
"content": {
14+
"application/json": {
15+
"schema": {
16+
"type": "object",
17+
"properties": {
18+
"pseudo-BSN": {
19+
"type": "string",
20+
"description": "Pseudo BSN identifier"
21+
},
22+
"zorgcontext": {
23+
"$ref": "#/components/schemas/ZorgcontextEnum",
24+
"description": "Zorgcontext code"
25+
},
26+
"URA": {
27+
"type": "string",
28+
"description": "URA identifier"
29+
},
30+
"Organization-type": {
31+
"$ref": "#/components/schemas/OrganisatieTypeEnum",
32+
"description": "Organization type"
33+
}
34+
},
35+
"required": [
36+
"pseudo-BSN",
37+
"zorgcontext",
38+
"URA",
39+
"Organization-type"
40+
]
41+
}
42+
}
43+
}
44+
},
45+
"responses": {
46+
"201": {
47+
"description": "Resource created"
48+
}
49+
}
50+
},
51+
"delete": {
52+
"summary": "Delete an NVI resource",
53+
"parameters": [
54+
{
55+
"name": "pseudo-BSN",
56+
"in": "query",
57+
"required": true,
58+
"schema": {
59+
"type": "string"
60+
},
61+
"description": "Pseudo BSN identifier"
62+
},
63+
{
64+
"name": "zorgcontext",
65+
"in": "query",
66+
"required": true,
67+
"schema": {
68+
"$ref": "#/components/schemas/ZorgcontextEnum"
69+
},
70+
"description": "Zorgcontext code"
71+
},
72+
{
73+
"name": "URA",
74+
"in": "query",
75+
"required": true,
76+
"schema": {
77+
"type": "string"
78+
},
79+
"description": "URA identifier"
80+
},
81+
{
82+
"name": "Organization-type",
83+
"in": "query",
84+
"required": true,
85+
"schema": {
86+
"$ref": "#/components/schemas/OrganisatieTypeEnum"
87+
},
88+
"description": "Organization type"
89+
}
90+
],
91+
"responses": {
92+
"204": {
93+
"description": "Resource deleted"
94+
}
95+
}
96+
},
97+
"get": {
98+
"summary": "Retrieve NVI resources",
99+
"parameters": [
100+
{
101+
"name": "pseudo-BSN",
102+
"in": "query",
103+
"required": true,
104+
"schema": {
105+
"type": "string"
106+
},
107+
"description": "Pseudo BSN identifier"
108+
},
109+
{
110+
"name": "zorgcontext",
111+
"in": "query",
112+
"required": true,
113+
"schema": {
114+
"$ref": "#/components/schemas/ZorgcontextEnum"
115+
},
116+
"description": "Zorgcontext code"
117+
},
118+
{
119+
"name": "Organization-type",
120+
"in": "query",
121+
"required": true,
122+
"schema": {
123+
"$ref": "#/components/schemas/OrganisatieTypeEnum"
124+
},
125+
"description": "Organization type"
126+
}
127+
],
128+
"responses": {
129+
"200": {
130+
"description": "Successful response",
131+
"content": {
132+
"application/json": {
133+
"schema": {
134+
"type": "object",
135+
"properties": {
136+
"datalocations": {
137+
"type": "array",
138+
"items": {
139+
"type": "object",
140+
"properties": {
141+
"created": {
142+
"type": "string",
143+
"format": "date-time",
144+
"description": "Creation datetime"
145+
},
146+
"pseudo-BSN": {
147+
"type": "string",
148+
"description": "Pseudo BSN identifier"
149+
},
150+
"zorgcontext": {
151+
"type": null,
152+
"$ref": "#/components/schemas/ZorgcontextEnum",
153+
"description": "Zorgcontext identifier"
154+
},
155+
"URA": {
156+
"type": "string",
157+
"description": "URA value"
158+
},
159+
"Organization-type": {
160+
"$ref": "#/components/schemas/OrganisatieTypeEnum",
161+
"description": "Organization type"
162+
}
163+
}
164+
}
165+
}
166+
}
167+
}
168+
}
169+
}
170+
}
171+
}
172+
}
173+
}
174+
},
175+
"components": {
176+
"schemas": {
177+
"OrganisatieTypeEnum": {
178+
"type": "string",
179+
"enum": [
180+
"2.16.840.1.113883.2.4.15.1060|H1",
181+
"2.16.840.1.113883.2.4.15.1060|V4",
182+
"2.16.840.1.113883.2.4.15.1060|A1",
183+
"2.16.840.1.113883.2.4.15.1060|X3",
184+
"2.16.840.1.113883.2.4.15.1060|L1",
185+
"2.16.840.1.113883.2.4.15.1060|G5",
186+
"2.16.840.1.113883.5.1008|OTH"
187+
],
188+
"description": "Enum for OrganisatieType codes<br><br> - 2.16.840.1.113883.2.4.15.1060|H1 (Huisartsinstelling)<br><br> - 2.16.840.1.113883.2.4.15.1060|V4 (Ziekenhuis)<br><br> - 2.16.840.1.113883.2.4.15.1060|A1 (Apotheekinstelling)<br><br> - 2.16.840.1.113883.2.4.15.1060|X3 (Verplegings- of verzorgingsinstelling)<br><br> - 2.16.840.1.113883.2.4.15.1060|L1 (Laboratorium)<br><br> - 2.16.840.1.113883.2.4.15.1060|G5 (Geestelijke Gezondheidszorg)<br><br> - 2.16.840.1.113883.5.1008|OTH (Overige)<br><br>"
189+
},
190+
"ZorgcontextEnum": {
191+
"type": "string",
192+
"enum": [
193+
"http://snomed.info/sct|721912009",
194+
"http://snomed.info/sct|371530004",
195+
"http://snomed.info/sct|77465005",
196+
"http://snomed.info/sct|721963009",
197+
"http://snomed.info/sct|782671000000103"
198+
],
199+
"description": "Enum for Zorgcontext codes<br><br> - http://snomed.info/sct|721912009 (Medication summary section)<br><br> - http://snomed.info/sct|371530004 (Imaging report)<br><br> - http://snomed.info/sct|77465005 (Patient summary document)<br><br> - http://snomed.info/sct|721963009 (Immunization summary document)<br><br> - http://snomed.info/sct|782671000000103 (Multidisciplinary care management)<br><br>"
200+
}
201+
}
202+
}
203+
}

‎input/pagecontent/localization.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ For implementing NVI (Network of Involved Care Providers - see [detailed descrip
77

88
#### API Specification
99

10-
The NVI API is defined using OpenAPI 3.0.2 specification (see [nvi_openapi.yaml](data/nvi_openapi.yaml)). The API provides a straightforward interface for managing the network of involved care providers using standard REST operations.
10+
The [NVI API](./localization.openapi.json) is defined using OpenAPI 3.0.2 specification (you may render this using [swagger.editor.html](https://editor.swagger.io/)). The API provides a straightforward interface for managing the network of involved care providers using standard REST operations.
1111

1212
##### Core Data Model
1313

0 commit comments

Comments
 (0)