├── LICENSE ├── README.md └── src ├── FHIR.json ├── FHIRAppointment.json ├── FHIRCarePlan.json ├── FHIRCondition.json ├── FHIRDevice.json ├── FHIREncounter.json ├── FHIRLocation.json ├── FHIRObservation.json ├── FHIROrganization.json ├── FHIRPatient.json ├── FHIRPractitioner.json └── FHIRProcedure.json /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Description 2 | This is a repository of Swagger documents representing the HL7 FHIR REST API Implementation. Provided is a swagger document that represents the HL7 FHIR REST API Implementation that gives you access to all the FHIR resources. Also provided is a Swagger Document for key individual resources to make the experiences of the non-techie FHIR API consumers better. 3 | 4 | ## API Management Version Compatibilty 5 | This artefact was successfully tested for the following versions: 6 | - v7.5.2 7 | 8 | 9 | ## Usage 10 | 11 | ### Import 12 | Import Swagger documents into Axway API Management 13 | 14 | ### Test FHIR Servers 15 | We are currently leveraging the HL7 Health Intersections FHIR server for testing. 16 | * http://fhir3.healthintersections.com.au/open 17 | 18 | You may use any FHIR server endpoint you wish. List of publicly available test FHIR server: 19 | 20 | * http://wiki.hl7.org/index.php?title=Publicly_Available_FHIR_Servers_for_testing 21 | 22 | ### Change FHIR Server Endpoint 23 | To change the FHIR server endpoint, open the Swagger file and change the "host" field as shown below. 24 | ``` 25 | { 26 | "swagger": "2.0", 27 | "host": "fhir3.healthintersections.com.au/open", 28 | "basePath": "/", 29 | "schemes": [ 30 | "http" 31 | ], 32 | .... 33 | ``` 34 | 35 | 36 | ## Bug and Caveats 37 | 38 | ``` 39 | The Swagger documents in this repository do not fully document the FHIR REST API specification. 40 | The Swagger documents only cover the more common scenarios. You may need to elaborate on the 41 | swagger documents if functionality or descriptive text is missing. 42 | See Contributing below for how to contribute back. 43 | ``` 44 | 45 | ## Contributing 46 | 47 | Please read [Contributing.md](https://github.com/Axway-API-Management-Plus/Common/blob/master/Contributing.md) for details on our code of conduct, and the process for submitting pull requests to us. 48 | 49 | 50 | ## Team 51 | 52 | ![alt text][Axwaylogo] Axway Team 53 | 54 | [Axwaylogo]: https://github.com/Axway-API-Management-Plus/Common/blob/master/img/AxwayLogoSmall.png "Axway logo" 55 | 56 | 57 | ## License 58 | [Apache License 2.0](/LICENSE) 59 | -------------------------------------------------------------------------------- /src/FHIRAppointment.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "host": "fhir3.healthintersections.com.au/open", 4 | "basePath": "/", 5 | "schemes": [ 6 | "http" 7 | ], 8 | "paths": { 9 | "/Appointment/{id}/_tags": { 10 | "get": { 11 | "description": "get a list of tags used for the nominated resource. This duplicates the HTTP header entries\n", 12 | "operationId": "GET /Appointment/{id}/_tags", 13 | "produces": [ 14 | "application/json+fhir", 15 | "application/xml+fhir" 16 | ], 17 | "parameters": [ 18 | { 19 | "required": true, 20 | "in": "path", 21 | "name": "id", 22 | "type": "string" 23 | } 24 | ], 25 | "responses": { 26 | "200": { 27 | "description": "Succesfully retrieved resource\n" 28 | } 29 | } 30 | }, 31 | "post": { 32 | "description": "Affix tags in the list to the nominated resource\n", 33 | "operationId": "POST /Appointment/{id}/_tags", 34 | "consumes": [ 35 | "application/json" 36 | ], 37 | "produces": [ 38 | "application/json+fhir", 39 | "application/xml+fhir" 40 | ], 41 | "parameters": [ 42 | { 43 | "required": true, 44 | "in": "path", 45 | "name": "id", 46 | "type": "string" 47 | } 48 | ], 49 | "responses": { 50 | "201": { 51 | "description": "Succesfully affix tags\n" 52 | } 53 | } 54 | } 55 | }, 56 | "/Appointment/{id}/_history/{vid}/_tags/_delete": { 57 | "post": { 58 | "description": "Removes all tags in the provided list of tags for the nominated version of the resource\n", 59 | "operationId": "POST /Appointment/{id}/_history/{vid}/_tags/_delete", 60 | "consumes": [ 61 | "application/json+fhir", 62 | "application/xml+fhir" 63 | ], 64 | "produces": [ 65 | "application/json+fhir", 66 | "application/xml+fhir" 67 | ], 68 | "parameters": [ 69 | { 70 | "required": true, 71 | "in": "path", 72 | "name": "vid", 73 | "type": "string" 74 | }, 75 | { 76 | "required": true, 77 | "in": "path", 78 | "name": "id", 79 | "type": "string" 80 | } 81 | ], 82 | "responses": { 83 | "204": { 84 | "description": "Successful deletion of tags" 85 | } 86 | } 87 | } 88 | }, 89 | "/Appointment/{id}/_tags/_delete": { 90 | "post": { 91 | "description": "Removes all tags in the provided list of tags for the nominated resource\n", 92 | "operationId": "POST /Appointment/{id}/_tags/_delete", 93 | "consumes": [ 94 | "application/json+fhir", 95 | "application/xml+fhir" 96 | ], 97 | "produces": [ 98 | "application/json+fhir", 99 | "application/xml+fhir" 100 | ], 101 | "parameters": [ 102 | { 103 | "required": true, 104 | "in": "path", 105 | "name": "id", 106 | "type": "string" 107 | } 108 | ], 109 | "responses": { 110 | "204": { 111 | "description": "Status 204" 112 | } 113 | } 114 | } 115 | }, 116 | "/metadata": { 117 | "get": { 118 | "description": "Retrieve resource\n", 119 | "operationId": "GET /metadata", 120 | "produces": [ 121 | "application/json+fhir", 122 | "application/xml+fhir" 123 | ], 124 | "responses": { 125 | "200": { 126 | "description": "Succesfully retrieved resource\n" 127 | } 128 | } 129 | } 130 | }, 131 | "/Appointment/$meta": { 132 | "get": { 133 | "description": "", 134 | "operationId": "GET /Appointment/$meta", 135 | "responses": { 136 | "200": { 137 | "description": "Successfully retrieved resource(s)\n" 138 | } 139 | } 140 | } 141 | }, 142 | "/Appointment/{id}/$validate": { 143 | "get": { 144 | "description": "", 145 | "operationId": "GET /Appointment/{id}/$validate", 146 | "produces": [ 147 | "application/json+fhir", 148 | "application/xml+fhir" 149 | ], 150 | "parameters": [ 151 | { 152 | "required": true, 153 | "in": "path", 154 | "name": "id", 155 | "type": "string" 156 | } 157 | ], 158 | "responses": { 159 | "200": { 160 | "description": "Status 200" 161 | } 162 | } 163 | } 164 | }, 165 | "/Appointment/{id}/_history/{vid}": { 166 | "get": { 167 | "description": "", 168 | "operationId": "GET /Appointment/{id}/_history/{vid}", 169 | "produces": [ 170 | "application/json+fhir", 171 | "application/xml+fhir" 172 | ], 173 | "parameters": [ 174 | { 175 | "required": true, 176 | "in": "path", 177 | "name": "vid", 178 | "type": "string" 179 | }, 180 | { 181 | "required": true, 182 | "in": "path", 183 | "name": "id", 184 | "type": "string" 185 | } 186 | ], 187 | "responses": { 188 | "200": { 189 | "description": "Status 200" 190 | } 191 | } 192 | } 193 | }, 194 | "/Appointment/{id}": { 195 | "get": { 196 | "description": "", 197 | "operationId": "GET /Appointment/{id}", 198 | "produces": [ 199 | "application/json+fhir", 200 | "application/xml+fhir" 201 | ], 202 | "parameters": [ 203 | { 204 | "required": true, 205 | "in": "path", 206 | "name": "id", 207 | "type": "string" 208 | } 209 | ], 210 | "responses": { 211 | "200": { 212 | "description": "Status 200" 213 | }, 214 | "404": { 215 | "description": "Tried to get an unknown resource\n" 216 | }, 217 | "410": { 218 | "description": "Tried to get a deleted resource\n" 219 | }, 220 | "422": { 221 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 222 | } 223 | } 224 | }, 225 | "put": { 226 | "description": "Update an existing instance\n", 227 | "operationId": "PUT /Appointment/{id}", 228 | "consumes": [ 229 | "application/json+fhir", 230 | "application/xml+fhir" 231 | ], 232 | "produces": [ 233 | "application/json+fhir", 234 | "application/xml+fhir" 235 | ], 236 | "parameters": [ 237 | { 238 | "required": true, 239 | "in": "path", 240 | "name": "id", 241 | "type": "string" 242 | } 243 | ], 244 | "responses": { 245 | "200": { 246 | "description": "Succesfully updated the instance \n" 247 | }, 248 | "201": { 249 | "description": "Succesfully created the instance \n" 250 | }, 251 | "400": { 252 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 253 | }, 254 | "404": { 255 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 256 | }, 257 | "405": { 258 | "description": "Method Not allowed - the resource did not exist prior to the update, and the server does not allow client defined ids\n" 259 | }, 260 | "409": { 261 | "description": "Version conflict management\n" 262 | }, 263 | "412": { 264 | "description": "Version conflict management\n" 265 | }, 266 | "422": { 267 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 268 | } 269 | } 270 | }, 271 | "delete": { 272 | "description": "Delete resource\n", 273 | "operationId": "DELETE /Appointment/{id}", 274 | "produces": [ 275 | "application/json+fhir", 276 | "application/xml+fhir" 277 | ], 278 | "parameters": [ 279 | { 280 | "required": true, 281 | "in": "path", 282 | "name": "id", 283 | "type": "string" 284 | } 285 | ], 286 | "responses": { 287 | "204": { 288 | "description": "Succesfully deleted resource\n" 289 | }, 290 | "404": { 291 | "description": "Not Found - resource was not found\n" 292 | }, 293 | "405": { 294 | "description": "Method Not allowed - delete is not allowed\n" 295 | } 296 | } 297 | } 298 | }, 299 | "/Appointment/_search": { 300 | "get": { 301 | "description": "", 302 | "operationId": "GET /Appointment/_search", 303 | "produces": [ 304 | "application/atom+xml", 305 | "application/json+fhir" 306 | ], 307 | "responses": { 308 | "200": { 309 | "description": "Status 200" 310 | } 311 | } 312 | } 313 | }, 314 | "/Appointment/{id}/_history/{vid}/_tags": { 315 | "get": { 316 | "description": "get a list of tags used for the nominated version of the resource. This duplicates the HTTP header entries.\n", 317 | "operationId": "GET /Appointment/{id}/_history/{vid}/_tags", 318 | "produces": [ 319 | "application/json+fhir", 320 | "application/xml+fhir" 321 | ], 322 | "parameters": [ 323 | { 324 | "required": true, 325 | "in": "path", 326 | "name": "vid", 327 | "type": "string" 328 | }, 329 | { 330 | "required": true, 331 | "in": "path", 332 | "name": "id", 333 | "type": "string" 334 | } 335 | ], 336 | "responses": { 337 | "200": { 338 | "description": "Succesfully retrieved resource\n" 339 | } 340 | } 341 | }, 342 | "post": { 343 | "description": "Affix tags in the list to the nominated verion of the resource\n", 344 | "operationId": "POST /Appointment/{id}/_history/{vid}/_tags", 345 | "consumes": [ 346 | "application/json+fhir", 347 | "application/xml+fhir" 348 | ], 349 | "produces": [ 350 | "application/json+fhir", 351 | "application/xml+fhir" 352 | ], 353 | "parameters": [ 354 | { 355 | "required": true, 356 | "in": "path", 357 | "name": "vid", 358 | "type": "string" 359 | }, 360 | { 361 | "required": true, 362 | "in": "path", 363 | "name": "id", 364 | "type": "string" 365 | } 366 | ], 367 | "responses": { 368 | "201": { 369 | "description": "Succesfully affix tags\n" 370 | } 371 | } 372 | } 373 | }, 374 | "/_tags": { 375 | "get": { 376 | "description": "get a list of all tags\n", 377 | "operationId": "GET /_tags", 378 | "produces": [ 379 | "application/json+fhir", 380 | "application/xml+fhir" 381 | ], 382 | "responses": { 383 | "200": { 384 | "description": "Succesfully retrieved resource\n" 385 | } 386 | } 387 | } 388 | }, 389 | "/": { 390 | "get": { 391 | "description": "Retrieve resource\n", 392 | "operationId": "GET /", 393 | "produces": [ 394 | "application/json+fhir", 395 | "application/xml+fhir" 396 | ], 397 | "responses": { 398 | "200": { 399 | "description": "Succesfully retrieved resource\n" 400 | } 401 | } 402 | }, 403 | "post": { 404 | "description": "Create a new resource\n", 405 | "operationId": "POST /", 406 | "consumes": [ 407 | "application/json" 408 | ], 409 | "produces": [ 410 | "application/json+fhir", 411 | "application/xml+fhir" 412 | ], 413 | "responses": { 414 | "201": { 415 | "description": "Succesfully created a new resource\n" 416 | } 417 | } 418 | } 419 | }, 420 | "/Appointment/_validate/{id}": { 421 | "post": { 422 | "description": "Create a new resource\n", 423 | "operationId": "POST /Appointment/_validate/{id}", 424 | "consumes": [ 425 | "application/json+fhir", 426 | "application/xml+fhir" 427 | ], 428 | "produces": [ 429 | "application/json+fhir", 430 | "application/xml+fhir" 431 | ], 432 | "parameters": [ 433 | { 434 | "required": true, 435 | "in": "path", 436 | "name": "id", 437 | "type": "string" 438 | } 439 | ], 440 | "responses": { 441 | "201": { 442 | "description": "Validates a type\n" 443 | } 444 | } 445 | } 446 | }, 447 | "/Appointment": { 448 | "get": { 449 | "description": "Get Appointment", 450 | "operationId": "GET /Appointment", 451 | "produces": [ 452 | "application/json+fhir", 453 | "application/xml+fhir" 454 | ], 455 | "responses": { 456 | "200": { 457 | "description": "Status 200" 458 | } 459 | } 460 | }, 461 | "post": { 462 | "description": "Create a new type\n", 463 | "operationId": "POST /Appointment", 464 | "consumes": [ 465 | "application/json+fhir", 466 | "application/xml+fhir" 467 | ], 468 | "produces": [ 469 | "application/json+fhir", 470 | "application/xml+fhir" 471 | ], 472 | "responses": { 473 | "201": { 474 | "description": "Succesfully created a new type\n" 475 | }, 476 | "400": { 477 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 478 | }, 479 | "404": { 480 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 481 | } 482 | } 483 | } 484 | }, 485 | "/Appointment/_tags": { 486 | "get": { 487 | "description": "get a list of tags used for the nominated resource type\n", 488 | "operationId": "GET /Appointment/_tags", 489 | "produces": [ 490 | "application/json+fhir", 491 | "application/xml+fhir" 492 | ], 493 | "responses": { 494 | "200": { 495 | "description": "Succesfully retrieved resource\n" 496 | } 497 | } 498 | } 499 | }, 500 | "/$meta": { 501 | "get": { 502 | "description": "", 503 | "operationId": "GET /$meta", 504 | "responses": { 505 | "200": { 506 | "description": "Successfully retrieved resource(s)\n" 507 | } 508 | } 509 | } 510 | }, 511 | "/_history": { 512 | "get": { 513 | "description": "Whole System History\n", 514 | "operationId": "GET /_history", 515 | "produces": [ 516 | "application/json+fhir", 517 | "application/xml+fhir" 518 | ], 519 | "responses": { 520 | "200": { 521 | "description": "Succesfully retrieved resource\n" 522 | } 523 | } 524 | } 525 | }, 526 | "/Appointment/$validate": { 527 | "get": { 528 | "description": "", 529 | "operationId": "GET /Appointment/$validate", 530 | "produces": [ 531 | "application/json+fhir", 532 | "application/xml+fhir" 533 | ], 534 | "responses": { 535 | "200": { 536 | "description": "Status 200" 537 | } 538 | } 539 | } 540 | }, 541 | "/Appointment/{id}/$everything": { 542 | "get": { 543 | "description": "", 544 | "operationId": "GET /Appointment/{id}/$everything", 545 | "produces": [ 546 | "application/json+fhir", 547 | "application/xml+fhir" 548 | ], 549 | "parameters": [ 550 | { 551 | "required": true, 552 | "in": "path", 553 | "name": "id", 554 | "type": "string" 555 | } 556 | ], 557 | "responses": { 558 | "200": { 559 | "description": "Status 200" 560 | } 561 | } 562 | } 563 | }, 564 | "/Appointment/_history": { 565 | "get": { 566 | "description": "", 567 | "operationId": "GET /Appointment/_history", 568 | "produces": [ 569 | "application/atom+xml", 570 | "application/json+fhir" 571 | ], 572 | "responses": { 573 | "200": { 574 | "description": "Status 200" 575 | } 576 | } 577 | } 578 | }, 579 | "/Appointment/{id}/_history": { 580 | "get": { 581 | "description": "", 582 | "operationId": "GET /Appointment/{id}/_history", 583 | "produces": [ 584 | "application/json+fhir", 585 | "application/xml+fhir" 586 | ], 587 | "parameters": [ 588 | { 589 | "required": true, 590 | "in": "path", 591 | "name": "id", 592 | "type": "string" 593 | } 594 | ], 595 | "responses": { 596 | "200": { 597 | "description": "Status 200" 598 | } 599 | } 600 | } 601 | } 602 | }, 603 | "info": { 604 | "title": "FHIR Appointment", 605 | "description" : "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). For more information: https://www.hl7.org/fhir/appointment.html", 606 | "version" : "2" 607 | }, 608 | "x-axway": { 609 | "corsEnabled": true, 610 | "basePaths": [ 611 | "" 612 | ], 613 | "serviceType": "rest", 614 | "deprecated": false, 615 | "tags" : { 616 | "Group" : [ "FHIR", " Workflow", " Scheduling" ] 617 | } 618 | } 619 | } -------------------------------------------------------------------------------- /src/FHIRCarePlan.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "host": "fhir3.healthintersections.com.au/open", 4 | "basePath": "/", 5 | "schemes": [ 6 | "http" 7 | ], 8 | "paths": { 9 | "/CarePlan/{id}/_tags": { 10 | "get": { 11 | "description": "get a list of tags used for the nominated resource. This duplicates the HTTP header entries\n", 12 | "operationId": "GET /CarePlan/{id}/_tags", 13 | "produces": [ 14 | "application/json+fhir", 15 | "application/xml+fhir" 16 | ], 17 | "parameters": [ 18 | { 19 | "required": true, 20 | "in": "path", 21 | "name": "id", 22 | "type": "string" 23 | } 24 | ], 25 | "responses": { 26 | "200": { 27 | "description": "Succesfully retrieved resource\n" 28 | } 29 | } 30 | }, 31 | "post": { 32 | "description": "Affix tags in the list to the nominated resource\n", 33 | "operationId": "POST /CarePlan/{id}/_tags", 34 | "consumes": [ 35 | "application/json" 36 | ], 37 | "produces": [ 38 | "application/json+fhir", 39 | "application/xml+fhir" 40 | ], 41 | "parameters": [ 42 | { 43 | "required": true, 44 | "in": "path", 45 | "name": "id", 46 | "type": "string" 47 | } 48 | ], 49 | "responses": { 50 | "201": { 51 | "description": "Succesfully affix tags\n" 52 | } 53 | } 54 | } 55 | }, 56 | "/CarePlan/{id}/_history/{vid}/_tags/_delete": { 57 | "post": { 58 | "description": "Removes all tags in the provided list of tags for the nominated version of the resource\n", 59 | "operationId": "POST /CarePlan/{id}/_history/{vid}/_tags/_delete", 60 | "consumes": [ 61 | "application/json+fhir", 62 | "application/xml+fhir" 63 | ], 64 | "produces": [ 65 | "application/json+fhir", 66 | "application/xml+fhir" 67 | ], 68 | "parameters": [ 69 | { 70 | "required": true, 71 | "in": "path", 72 | "name": "vid", 73 | "type": "string" 74 | }, 75 | { 76 | "required": true, 77 | "in": "path", 78 | "name": "id", 79 | "type": "string" 80 | } 81 | ], 82 | "responses": { 83 | "204": { 84 | "description": "Successful deletion of tags" 85 | } 86 | } 87 | } 88 | }, 89 | "/CarePlan/{id}/_tags/_delete": { 90 | "post": { 91 | "description": "Removes all tags in the provided list of tags for the nominated resource\n", 92 | "operationId": "POST /CarePlan/{id}/_tags/_delete", 93 | "consumes": [ 94 | "application/json+fhir", 95 | "application/xml+fhir" 96 | ], 97 | "produces": [ 98 | "application/json+fhir", 99 | "application/xml+fhir" 100 | ], 101 | "parameters": [ 102 | { 103 | "required": true, 104 | "in": "path", 105 | "name": "id", 106 | "type": "string" 107 | } 108 | ], 109 | "responses": { 110 | "204": { 111 | "description": "Status 204" 112 | } 113 | } 114 | } 115 | }, 116 | "/metadata": { 117 | "get": { 118 | "description": "Retrieve resource\n", 119 | "operationId": "GET /metadata", 120 | "produces": [ 121 | "application/json+fhir", 122 | "application/xml+fhir" 123 | ], 124 | "responses": { 125 | "200": { 126 | "description": "Succesfully retrieved resource\n" 127 | } 128 | } 129 | } 130 | }, 131 | "/CarePlan/$meta": { 132 | "get": { 133 | "description": "", 134 | "operationId": "GET /CarePlan/$meta", 135 | "responses": { 136 | "200": { 137 | "description": "Successfully retrieved resource(s)\n" 138 | } 139 | } 140 | } 141 | }, 142 | "/CarePlan/{id}/$validate": { 143 | "get": { 144 | "description": "", 145 | "operationId": "GET /CarePlan/{id}/$validate", 146 | "produces": [ 147 | "application/json+fhir", 148 | "application/xml+fhir" 149 | ], 150 | "parameters": [ 151 | { 152 | "required": true, 153 | "in": "path", 154 | "name": "id", 155 | "type": "string" 156 | } 157 | ], 158 | "responses": { 159 | "200": { 160 | "description": "Status 200" 161 | } 162 | } 163 | } 164 | }, 165 | "/CarePlan/{id}/_history/{vid}": { 166 | "get": { 167 | "description": "", 168 | "operationId": "GET /CarePlan/{id}/_history/{vid}", 169 | "produces": [ 170 | "application/json+fhir", 171 | "application/xml+fhir" 172 | ], 173 | "parameters": [ 174 | { 175 | "required": true, 176 | "in": "path", 177 | "name": "vid", 178 | "type": "string" 179 | }, 180 | { 181 | "required": true, 182 | "in": "path", 183 | "name": "id", 184 | "type": "string" 185 | } 186 | ], 187 | "responses": { 188 | "200": { 189 | "description": "Status 200" 190 | } 191 | } 192 | } 193 | }, 194 | "/CarePlan/{id}": { 195 | "get": { 196 | "description": "", 197 | "operationId": "GET /CarePlan/{id}", 198 | "produces": [ 199 | "application/json+fhir", 200 | "application/xml+fhir" 201 | ], 202 | "parameters": [ 203 | { 204 | "required": true, 205 | "in": "path", 206 | "name": "id", 207 | "type": "string" 208 | } 209 | ], 210 | "responses": { 211 | "200": { 212 | "description": "Status 200" 213 | }, 214 | "404": { 215 | "description": "Tried to get an unknown resource\n" 216 | }, 217 | "410": { 218 | "description": "Tried to get a deleted resource\n" 219 | }, 220 | "422": { 221 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 222 | } 223 | } 224 | }, 225 | "put": { 226 | "description": "Update an existing instance\n", 227 | "operationId": "PUT /CarePlan/{id}", 228 | "consumes": [ 229 | "application/json+fhir", 230 | "application/xml+fhir" 231 | ], 232 | "produces": [ 233 | "application/json+fhir", 234 | "application/xml+fhir" 235 | ], 236 | "parameters": [ 237 | { 238 | "required": true, 239 | "in": "path", 240 | "name": "id", 241 | "type": "string" 242 | } 243 | ], 244 | "responses": { 245 | "200": { 246 | "description": "Succesfully updated the instance \n" 247 | }, 248 | "201": { 249 | "description": "Succesfully created the instance \n" 250 | }, 251 | "400": { 252 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 253 | }, 254 | "404": { 255 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 256 | }, 257 | "405": { 258 | "description": "Method Not allowed - the resource did not exist prior to the update, and the server does not allow client defined ids\n" 259 | }, 260 | "409": { 261 | "description": "Version conflict management\n" 262 | }, 263 | "412": { 264 | "description": "Version conflict management\n" 265 | }, 266 | "422": { 267 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 268 | } 269 | } 270 | }, 271 | "delete": { 272 | "description": "Delete resource\n", 273 | "operationId": "DELETE /CarePlan/{id}", 274 | "produces": [ 275 | "application/json+fhir", 276 | "application/xml+fhir" 277 | ], 278 | "parameters": [ 279 | { 280 | "required": true, 281 | "in": "path", 282 | "name": "id", 283 | "type": "string" 284 | } 285 | ], 286 | "responses": { 287 | "204": { 288 | "description": "Succesfully deleted resource\n" 289 | }, 290 | "404": { 291 | "description": "Not Found - resource was not found\n" 292 | }, 293 | "405": { 294 | "description": "Method Not allowed - delete is not allowed\n" 295 | } 296 | } 297 | } 298 | }, 299 | "/CarePlan/_search": { 300 | "get": { 301 | "description": "", 302 | "operationId": "GET /CarePlan/_search", 303 | "produces": [ 304 | "application/atom+xml", 305 | "application/json+fhir" 306 | ], 307 | "responses": { 308 | "200": { 309 | "description": "Status 200" 310 | } 311 | } 312 | } 313 | }, 314 | "/CarePlan/{id}/_history/{vid}/_tags": { 315 | "get": { 316 | "description": "get a list of tags used for the nominated version of the resource. This duplicates the HTTP header entries.\n", 317 | "operationId": "GET /CarePlan/{id}/_history/{vid}/_tags", 318 | "produces": [ 319 | "application/json+fhir", 320 | "application/xml+fhir" 321 | ], 322 | "parameters": [ 323 | { 324 | "required": true, 325 | "in": "path", 326 | "name": "vid", 327 | "type": "string" 328 | }, 329 | { 330 | "required": true, 331 | "in": "path", 332 | "name": "id", 333 | "type": "string" 334 | } 335 | ], 336 | "responses": { 337 | "200": { 338 | "description": "Succesfully retrieved resource\n" 339 | } 340 | } 341 | }, 342 | "post": { 343 | "description": "Affix tags in the list to the nominated verion of the resource\n", 344 | "operationId": "POST /CarePlan/{id}/_history/{vid}/_tags", 345 | "consumes": [ 346 | "application/json+fhir", 347 | "application/xml+fhir" 348 | ], 349 | "produces": [ 350 | "application/json+fhir", 351 | "application/xml+fhir" 352 | ], 353 | "parameters": [ 354 | { 355 | "required": true, 356 | "in": "path", 357 | "name": "vid", 358 | "type": "string" 359 | }, 360 | { 361 | "required": true, 362 | "in": "path", 363 | "name": "id", 364 | "type": "string" 365 | } 366 | ], 367 | "responses": { 368 | "201": { 369 | "description": "Succesfully affix tags\n" 370 | } 371 | } 372 | } 373 | }, 374 | "/_tags": { 375 | "get": { 376 | "description": "get a list of all tags\n", 377 | "operationId": "GET /_tags", 378 | "produces": [ 379 | "application/json+fhir", 380 | "application/xml+fhir" 381 | ], 382 | "responses": { 383 | "200": { 384 | "description": "Succesfully retrieved resource\n" 385 | } 386 | } 387 | } 388 | }, 389 | "/": { 390 | "get": { 391 | "description": "Retrieve resource\n", 392 | "operationId": "GET /", 393 | "produces": [ 394 | "application/json+fhir", 395 | "application/xml+fhir" 396 | ], 397 | "responses": { 398 | "200": { 399 | "description": "Succesfully retrieved resource\n" 400 | } 401 | } 402 | }, 403 | "post": { 404 | "description": "Create a new resource\n", 405 | "operationId": "POST /", 406 | "consumes": [ 407 | "application/json" 408 | ], 409 | "produces": [ 410 | "application/json+fhir", 411 | "application/xml+fhir" 412 | ], 413 | "responses": { 414 | "201": { 415 | "description": "Succesfully created a new resource\n" 416 | } 417 | } 418 | } 419 | }, 420 | "/CarePlan/_validate/{id}": { 421 | "post": { 422 | "description": "Create a new resource\n", 423 | "operationId": "POST /CarePlan/_validate/{id}", 424 | "consumes": [ 425 | "application/json+fhir", 426 | "application/xml+fhir" 427 | ], 428 | "produces": [ 429 | "application/json+fhir", 430 | "application/xml+fhir" 431 | ], 432 | "parameters": [ 433 | { 434 | "required": true, 435 | "in": "path", 436 | "name": "id", 437 | "type": "string" 438 | } 439 | ], 440 | "responses": { 441 | "201": { 442 | "description": "Validates a type\n" 443 | } 444 | } 445 | } 446 | }, 447 | "/CarePlan": { 448 | "get": { 449 | "description": "Get CarePlan", 450 | "operationId": "GET /CarePlan", 451 | "produces": [ 452 | "application/json+fhir", 453 | "application/xml+fhir" 454 | ], 455 | "responses": { 456 | "200": { 457 | "description": "Status 200" 458 | } 459 | } 460 | }, 461 | "post": { 462 | "description": "Create a new type\n", 463 | "operationId": "POST /CarePlan", 464 | "consumes": [ 465 | "application/json+fhir", 466 | "application/xml+fhir" 467 | ], 468 | "produces": [ 469 | "application/json+fhir", 470 | "application/xml+fhir" 471 | ], 472 | "responses": { 473 | "201": { 474 | "description": "Succesfully created a new type\n" 475 | }, 476 | "400": { 477 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 478 | }, 479 | "404": { 480 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 481 | } 482 | } 483 | } 484 | }, 485 | "/CarePlan/_tags": { 486 | "get": { 487 | "description": "get a list of tags used for the nominated resource type\n", 488 | "operationId": "GET /CarePlan/_tags", 489 | "produces": [ 490 | "application/json+fhir", 491 | "application/xml+fhir" 492 | ], 493 | "responses": { 494 | "200": { 495 | "description": "Succesfully retrieved resource\n" 496 | } 497 | } 498 | } 499 | }, 500 | "/$meta": { 501 | "get": { 502 | "description": "", 503 | "operationId": "GET /$meta", 504 | "responses": { 505 | "200": { 506 | "description": "Successfully retrieved resource(s)\n" 507 | } 508 | } 509 | } 510 | }, 511 | "/_history": { 512 | "get": { 513 | "description": "Whole System History\n", 514 | "operationId": "GET /_history", 515 | "produces": [ 516 | "application/json+fhir", 517 | "application/xml+fhir" 518 | ], 519 | "responses": { 520 | "200": { 521 | "description": "Succesfully retrieved resource\n" 522 | } 523 | } 524 | } 525 | }, 526 | "/CarePlan/$validate": { 527 | "get": { 528 | "description": "", 529 | "operationId": "GET /CarePlan/$validate", 530 | "produces": [ 531 | "application/json+fhir", 532 | "application/xml+fhir" 533 | ], 534 | "responses": { 535 | "200": { 536 | "description": "Status 200" 537 | } 538 | } 539 | } 540 | }, 541 | "/CarePlan/{id}/$everything": { 542 | "get": { 543 | "description": "", 544 | "operationId": "GET /CarePlan/{id}/$everything", 545 | "produces": [ 546 | "application/json+fhir", 547 | "application/xml+fhir" 548 | ], 549 | "parameters": [ 550 | { 551 | "required": true, 552 | "in": "path", 553 | "name": "id", 554 | "type": "string" 555 | } 556 | ], 557 | "responses": { 558 | "200": { 559 | "description": "Status 200" 560 | } 561 | } 562 | } 563 | }, 564 | "/CarePlan/_history": { 565 | "get": { 566 | "description": "", 567 | "operationId": "GET /CarePlan/_history", 568 | "produces": [ 569 | "application/atom+xml", 570 | "application/json+fhir" 571 | ], 572 | "responses": { 573 | "200": { 574 | "description": "Status 200" 575 | } 576 | } 577 | } 578 | }, 579 | "/CarePlan/{id}/_history": { 580 | "get": { 581 | "description": "", 582 | "operationId": "GET /CarePlan/{id}/_history", 583 | "produces": [ 584 | "application/json+fhir", 585 | "application/xml+fhir" 586 | ], 587 | "parameters": [ 588 | { 589 | "required": true, 590 | "in": "path", 591 | "name": "id", 592 | "type": "string" 593 | } 594 | ], 595 | "responses": { 596 | "200": { 597 | "description": "Status 200" 598 | } 599 | } 600 | } 601 | } 602 | }, 603 | "info": { 604 | "title": "FHIR CarePlan", 605 | "description" : "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions. For more information: https://www.hl7.org/fhir/careplan.html", 606 | "version" : "2" 607 | }, 608 | "x-axway": { 609 | "corsEnabled": true, 610 | "basePaths": [ 611 | "" 612 | ], 613 | "serviceType": "rest", 614 | "deprecated": false, 615 | "tags" : { 616 | "Group" : [ "FHIR", " Clinical", " Care Provision" ] 617 | } 618 | } 619 | } -------------------------------------------------------------------------------- /src/FHIRCondition.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "host": "fhir3.healthintersections.com.au/open", 4 | "basePath": "/", 5 | "schemes": [ 6 | "http" 7 | ], 8 | "paths": { 9 | "/Condition/{id}/_tags": { 10 | "get": { 11 | "description": "get a list of tags used for the nominated resource. This duplicates the HTTP header entries\n", 12 | "operationId": "GET /Condition/{id}/_tags", 13 | "produces": [ 14 | "application/json+fhir", 15 | "application/xml+fhir" 16 | ], 17 | "parameters": [ 18 | { 19 | "required": true, 20 | "in": "path", 21 | "name": "id", 22 | "type": "string" 23 | } 24 | ], 25 | "responses": { 26 | "200": { 27 | "description": "Succesfully retrieved resource\n" 28 | } 29 | } 30 | }, 31 | "post": { 32 | "description": "Affix tags in the list to the nominated resource\n", 33 | "operationId": "POST /Condition/{id}/_tags", 34 | "consumes": [ 35 | "application/json" 36 | ], 37 | "produces": [ 38 | "application/json+fhir", 39 | "application/xml+fhir" 40 | ], 41 | "parameters": [ 42 | { 43 | "required": true, 44 | "in": "path", 45 | "name": "id", 46 | "type": "string" 47 | } 48 | ], 49 | "responses": { 50 | "201": { 51 | "description": "Succesfully affix tags\n" 52 | } 53 | } 54 | } 55 | }, 56 | "/Condition/{id}/_history/{vid}/_tags/_delete": { 57 | "post": { 58 | "description": "Removes all tags in the provided list of tags for the nominated version of the resource\n", 59 | "operationId": "POST /Condition/{id}/_history/{vid}/_tags/_delete", 60 | "consumes": [ 61 | "application/json+fhir", 62 | "application/xml+fhir" 63 | ], 64 | "produces": [ 65 | "application/json+fhir", 66 | "application/xml+fhir" 67 | ], 68 | "parameters": [ 69 | { 70 | "required": true, 71 | "in": "path", 72 | "name": "vid", 73 | "type": "string" 74 | }, 75 | { 76 | "required": true, 77 | "in": "path", 78 | "name": "id", 79 | "type": "string" 80 | } 81 | ], 82 | "responses": { 83 | "204": { 84 | "description": "Successful deletion of tags" 85 | } 86 | } 87 | } 88 | }, 89 | "/Condition/{id}/_tags/_delete": { 90 | "post": { 91 | "description": "Removes all tags in the provided list of tags for the nominated resource\n", 92 | "operationId": "POST /Condition/{id}/_tags/_delete", 93 | "consumes": [ 94 | "application/json+fhir", 95 | "application/xml+fhir" 96 | ], 97 | "produces": [ 98 | "application/json+fhir", 99 | "application/xml+fhir" 100 | ], 101 | "parameters": [ 102 | { 103 | "required": true, 104 | "in": "path", 105 | "name": "id", 106 | "type": "string" 107 | } 108 | ], 109 | "responses": { 110 | "204": { 111 | "description": "Status 204" 112 | } 113 | } 114 | } 115 | }, 116 | "/metadata": { 117 | "get": { 118 | "description": "Retrieve resource\n", 119 | "operationId": "GET /metadata", 120 | "produces": [ 121 | "application/json+fhir", 122 | "application/xml+fhir" 123 | ], 124 | "responses": { 125 | "200": { 126 | "description": "Succesfully retrieved resource\n" 127 | } 128 | } 129 | } 130 | }, 131 | "/Condition/$meta": { 132 | "get": { 133 | "description": "", 134 | "operationId": "GET /Condition/$meta", 135 | "responses": { 136 | "200": { 137 | "description": "Successfully retrieved resource(s)\n" 138 | } 139 | } 140 | } 141 | }, 142 | "/Condition/{id}/$validate": { 143 | "get": { 144 | "description": "", 145 | "operationId": "GET /Condition/{id}/$validate", 146 | "produces": [ 147 | "application/json+fhir", 148 | "application/xml+fhir" 149 | ], 150 | "parameters": [ 151 | { 152 | "required": true, 153 | "in": "path", 154 | "name": "id", 155 | "type": "string" 156 | } 157 | ], 158 | "responses": { 159 | "200": { 160 | "description": "Status 200" 161 | } 162 | } 163 | } 164 | }, 165 | "/Condition/{id}/_history/{vid}": { 166 | "get": { 167 | "description": "", 168 | "operationId": "GET /Condition/{id}/_history/{vid}", 169 | "produces": [ 170 | "application/json+fhir", 171 | "application/xml+fhir" 172 | ], 173 | "parameters": [ 174 | { 175 | "required": true, 176 | "in": "path", 177 | "name": "vid", 178 | "type": "string" 179 | }, 180 | { 181 | "required": true, 182 | "in": "path", 183 | "name": "id", 184 | "type": "string" 185 | } 186 | ], 187 | "responses": { 188 | "200": { 189 | "description": "Status 200" 190 | } 191 | } 192 | } 193 | }, 194 | "/Condition/{id}": { 195 | "get": { 196 | "description": "", 197 | "operationId": "GET /Condition/{id}", 198 | "produces": [ 199 | "application/json+fhir", 200 | "application/xml+fhir" 201 | ], 202 | "parameters": [ 203 | { 204 | "required": true, 205 | "in": "path", 206 | "name": "id", 207 | "type": "string" 208 | } 209 | ], 210 | "responses": { 211 | "200": { 212 | "description": "Status 200" 213 | }, 214 | "404": { 215 | "description": "Tried to get an unknown resource\n" 216 | }, 217 | "410": { 218 | "description": "Tried to get a deleted resource\n" 219 | }, 220 | "422": { 221 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 222 | } 223 | } 224 | }, 225 | "put": { 226 | "description": "Update an existing instance\n", 227 | "operationId": "PUT /Condition/{id}", 228 | "consumes": [ 229 | "application/json+fhir", 230 | "application/xml+fhir" 231 | ], 232 | "produces": [ 233 | "application/json+fhir", 234 | "application/xml+fhir" 235 | ], 236 | "parameters": [ 237 | { 238 | "required": true, 239 | "in": "path", 240 | "name": "id", 241 | "type": "string" 242 | } 243 | ], 244 | "responses": { 245 | "200": { 246 | "description": "Succesfully updated the instance \n" 247 | }, 248 | "201": { 249 | "description": "Succesfully created the instance \n" 250 | }, 251 | "400": { 252 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 253 | }, 254 | "404": { 255 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 256 | }, 257 | "405": { 258 | "description": "Method Not allowed - the resource did not exist prior to the update, and the server does not allow client defined ids\n" 259 | }, 260 | "409": { 261 | "description": "Version conflict management\n" 262 | }, 263 | "412": { 264 | "description": "Version conflict management\n" 265 | }, 266 | "422": { 267 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 268 | } 269 | } 270 | }, 271 | "delete": { 272 | "description": "Delete resource\n", 273 | "operationId": "DELETE /Condition/{id}", 274 | "produces": [ 275 | "application/json+fhir", 276 | "application/xml+fhir" 277 | ], 278 | "parameters": [ 279 | { 280 | "required": true, 281 | "in": "path", 282 | "name": "id", 283 | "type": "string" 284 | } 285 | ], 286 | "responses": { 287 | "204": { 288 | "description": "Succesfully deleted resource\n" 289 | }, 290 | "404": { 291 | "description": "Not Found - resource was not found\n" 292 | }, 293 | "405": { 294 | "description": "Method Not allowed - delete is not allowed\n" 295 | } 296 | } 297 | } 298 | }, 299 | "/Condition/_search": { 300 | "get": { 301 | "description": "", 302 | "operationId": "GET /Condition/_search", 303 | "produces": [ 304 | "application/atom+xml", 305 | "application/json+fhir" 306 | ], 307 | "responses": { 308 | "200": { 309 | "description": "Status 200" 310 | } 311 | } 312 | } 313 | }, 314 | "/Condition/{id}/_history/{vid}/_tags": { 315 | "get": { 316 | "description": "get a list of tags used for the nominated version of the resource. This duplicates the HTTP header entries.\n", 317 | "operationId": "GET /Condition/{id}/_history/{vid}/_tags", 318 | "produces": [ 319 | "application/json+fhir", 320 | "application/xml+fhir" 321 | ], 322 | "parameters": [ 323 | { 324 | "required": true, 325 | "in": "path", 326 | "name": "vid", 327 | "type": "string" 328 | }, 329 | { 330 | "required": true, 331 | "in": "path", 332 | "name": "id", 333 | "type": "string" 334 | } 335 | ], 336 | "responses": { 337 | "200": { 338 | "description": "Succesfully retrieved resource\n" 339 | } 340 | } 341 | }, 342 | "post": { 343 | "description": "Affix tags in the list to the nominated verion of the resource\n", 344 | "operationId": "POST /Condition/{id}/_history/{vid}/_tags", 345 | "consumes": [ 346 | "application/json+fhir", 347 | "application/xml+fhir" 348 | ], 349 | "produces": [ 350 | "application/json+fhir", 351 | "application/xml+fhir" 352 | ], 353 | "parameters": [ 354 | { 355 | "required": true, 356 | "in": "path", 357 | "name": "vid", 358 | "type": "string" 359 | }, 360 | { 361 | "required": true, 362 | "in": "path", 363 | "name": "id", 364 | "type": "string" 365 | } 366 | ], 367 | "responses": { 368 | "201": { 369 | "description": "Succesfully affix tags\n" 370 | } 371 | } 372 | } 373 | }, 374 | "/_tags": { 375 | "get": { 376 | "description": "get a list of all tags\n", 377 | "operationId": "GET /_tags", 378 | "produces": [ 379 | "application/json+fhir", 380 | "application/xml+fhir" 381 | ], 382 | "responses": { 383 | "200": { 384 | "description": "Succesfully retrieved resource\n" 385 | } 386 | } 387 | } 388 | }, 389 | "/": { 390 | "get": { 391 | "description": "Retrieve resource\n", 392 | "operationId": "GET /", 393 | "produces": [ 394 | "application/json+fhir", 395 | "application/xml+fhir" 396 | ], 397 | "responses": { 398 | "200": { 399 | "description": "Succesfully retrieved resource\n" 400 | } 401 | } 402 | }, 403 | "post": { 404 | "description": "Create a new resource\n", 405 | "operationId": "POST /", 406 | "consumes": [ 407 | "application/json" 408 | ], 409 | "produces": [ 410 | "application/json+fhir", 411 | "application/xml+fhir" 412 | ], 413 | "responses": { 414 | "201": { 415 | "description": "Succesfully created a new resource\n" 416 | } 417 | } 418 | } 419 | }, 420 | "/Condition/_validate/{id}": { 421 | "post": { 422 | "description": "Create a new resource\n", 423 | "operationId": "POST /Condition/_validate/{id}", 424 | "consumes": [ 425 | "application/json+fhir", 426 | "application/xml+fhir" 427 | ], 428 | "produces": [ 429 | "application/json+fhir", 430 | "application/xml+fhir" 431 | ], 432 | "parameters": [ 433 | { 434 | "required": true, 435 | "in": "path", 436 | "name": "id", 437 | "type": "string" 438 | } 439 | ], 440 | "responses": { 441 | "201": { 442 | "description": "Validates a type\n" 443 | } 444 | } 445 | } 446 | }, 447 | "/Condition": { 448 | "get": { 449 | "description": "Get Condition", 450 | "operationId": "GET /Condition", 451 | "produces": [ 452 | "application/json+fhir", 453 | "application/xml+fhir" 454 | ], 455 | "responses": { 456 | "200": { 457 | "description": "Status 200" 458 | } 459 | } 460 | }, 461 | "post": { 462 | "description": "Create a new type\n", 463 | "operationId": "POST /Condition", 464 | "consumes": [ 465 | "application/json+fhir", 466 | "application/xml+fhir" 467 | ], 468 | "produces": [ 469 | "application/json+fhir", 470 | "application/xml+fhir" 471 | ], 472 | "responses": { 473 | "201": { 474 | "description": "Succesfully created a new type\n" 475 | }, 476 | "400": { 477 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 478 | }, 479 | "404": { 480 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 481 | } 482 | } 483 | } 484 | }, 485 | "/Condition/_tags": { 486 | "get": { 487 | "description": "get a list of tags used for the nominated resource type\n", 488 | "operationId": "GET /Condition/_tags", 489 | "produces": [ 490 | "application/json+fhir", 491 | "application/xml+fhir" 492 | ], 493 | "responses": { 494 | "200": { 495 | "description": "Succesfully retrieved resource\n" 496 | } 497 | } 498 | } 499 | }, 500 | "/$meta": { 501 | "get": { 502 | "description": "", 503 | "operationId": "GET /$meta", 504 | "responses": { 505 | "200": { 506 | "description": "Successfully retrieved resource(s)\n" 507 | } 508 | } 509 | } 510 | }, 511 | "/_history": { 512 | "get": { 513 | "description": "Whole System History\n", 514 | "operationId": "GET /_history", 515 | "produces": [ 516 | "application/json+fhir", 517 | "application/xml+fhir" 518 | ], 519 | "responses": { 520 | "200": { 521 | "description": "Succesfully retrieved resource\n" 522 | } 523 | } 524 | } 525 | }, 526 | "/Condition/$validate": { 527 | "get": { 528 | "description": "", 529 | "operationId": "GET /Condition/$validate", 530 | "produces": [ 531 | "application/json+fhir", 532 | "application/xml+fhir" 533 | ], 534 | "responses": { 535 | "200": { 536 | "description": "Status 200" 537 | } 538 | } 539 | } 540 | }, 541 | "/Condition/{id}/$everything": { 542 | "get": { 543 | "description": "", 544 | "operationId": "GET /Condition/{id}/$everything", 545 | "produces": [ 546 | "application/json+fhir", 547 | "application/xml+fhir" 548 | ], 549 | "parameters": [ 550 | { 551 | "required": true, 552 | "in": "path", 553 | "name": "id", 554 | "type": "string" 555 | } 556 | ], 557 | "responses": { 558 | "200": { 559 | "description": "Status 200" 560 | } 561 | } 562 | } 563 | }, 564 | "/Condition/_history": { 565 | "get": { 566 | "description": "", 567 | "operationId": "GET /Condition/_history", 568 | "produces": [ 569 | "application/atom+xml", 570 | "application/json+fhir" 571 | ], 572 | "responses": { 573 | "200": { 574 | "description": "Status 200" 575 | } 576 | } 577 | } 578 | }, 579 | "/Condition/{id}/_history": { 580 | "get": { 581 | "description": "", 582 | "operationId": "GET /Condition/{id}/_history", 583 | "produces": [ 584 | "application/json+fhir", 585 | "application/xml+fhir" 586 | ], 587 | "parameters": [ 588 | { 589 | "required": true, 590 | "in": "path", 591 | "name": "id", 592 | "type": "string" 593 | } 594 | ], 595 | "responses": { 596 | "200": { 597 | "description": "Status 200" 598 | } 599 | } 600 | } 601 | } 602 | }, 603 | "info": { 604 | "title": "FHIR Condition", 605 | "description": "Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a diagnosis during an encounter; populating a problem list or a summary statement, such as a discharge summary. For more information: https://www.hl7.org/fhir/condition.html", 606 | "version" : "2" 607 | }, 608 | "x-axway": { 609 | "corsEnabled": true, 610 | "basePaths": [ 611 | "" 612 | ], 613 | "serviceType": "rest", 614 | "deprecated": false, 615 | "tags" : { 616 | "Group" : [ "FHIR", " Clinical", " General" ] 617 | } 618 | } 619 | } -------------------------------------------------------------------------------- /src/FHIREncounter.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "host": "fhir3.healthintersections.com.au/open", 4 | "basePath": "/", 5 | "schemes": [ 6 | "http" 7 | ], 8 | "paths": { 9 | "/Encounter/{id}/_tags": { 10 | "get": { 11 | "description": "get a list of tags used for the nominated resource. This duplicates the HTTP header entries\n", 12 | "operationId": "GET /Encounter/{id}/_tags", 13 | "produces": [ 14 | "application/json+fhir", 15 | "application/xml+fhir" 16 | ], 17 | "parameters": [ 18 | { 19 | "required": true, 20 | "in": "path", 21 | "name": "id", 22 | "type": "string" 23 | } 24 | ], 25 | "responses": { 26 | "200": { 27 | "description": "Succesfully retrieved resource\n" 28 | } 29 | } 30 | }, 31 | "post": { 32 | "description": "Affix tags in the list to the nominated resource\n", 33 | "operationId": "POST /Encounter/{id}/_tags", 34 | "consumes": [ 35 | "application/json" 36 | ], 37 | "produces": [ 38 | "application/json+fhir", 39 | "application/xml+fhir" 40 | ], 41 | "parameters": [ 42 | { 43 | "required": true, 44 | "in": "path", 45 | "name": "id", 46 | "type": "string" 47 | } 48 | ], 49 | "responses": { 50 | "201": { 51 | "description": "Succesfully affix tags\n" 52 | } 53 | } 54 | } 55 | }, 56 | "/Encounter/{id}/_history/{vid}/_tags/_delete": { 57 | "post": { 58 | "description": "Removes all tags in the provided list of tags for the nominated version of the resource\n", 59 | "operationId": "POST /Encounter/{id}/_history/{vid}/_tags/_delete", 60 | "consumes": [ 61 | "application/json+fhir", 62 | "application/xml+fhir" 63 | ], 64 | "produces": [ 65 | "application/json+fhir", 66 | "application/xml+fhir" 67 | ], 68 | "parameters": [ 69 | { 70 | "required": true, 71 | "in": "path", 72 | "name": "vid", 73 | "type": "string" 74 | }, 75 | { 76 | "required": true, 77 | "in": "path", 78 | "name": "id", 79 | "type": "string" 80 | } 81 | ], 82 | "responses": { 83 | "204": { 84 | "description": "Successful deletion of tags" 85 | } 86 | } 87 | } 88 | }, 89 | "/Encounter/{id}/_tags/_delete": { 90 | "post": { 91 | "description": "Removes all tags in the provided list of tags for the nominated resource\n", 92 | "operationId": "POST /Encounter/{id}/_tags/_delete", 93 | "consumes": [ 94 | "application/json+fhir", 95 | "application/xml+fhir" 96 | ], 97 | "produces": [ 98 | "application/json+fhir", 99 | "application/xml+fhir" 100 | ], 101 | "parameters": [ 102 | { 103 | "required": true, 104 | "in": "path", 105 | "name": "id", 106 | "type": "string" 107 | } 108 | ], 109 | "responses": { 110 | "204": { 111 | "description": "Status 204" 112 | } 113 | } 114 | } 115 | }, 116 | "/metadata": { 117 | "get": { 118 | "description": "Retrieve resource\n", 119 | "operationId": "GET /metadata", 120 | "produces": [ 121 | "application/json+fhir", 122 | "application/xml+fhir" 123 | ], 124 | "responses": { 125 | "200": { 126 | "description": "Succesfully retrieved resource\n" 127 | } 128 | } 129 | } 130 | }, 131 | "/Encounter/$meta": { 132 | "get": { 133 | "description": "", 134 | "operationId": "GET /Encounter/$meta", 135 | "responses": { 136 | "200": { 137 | "description": "Successfully retrieved resource(s)\n" 138 | } 139 | } 140 | } 141 | }, 142 | "/Encounter/{id}/$validate": { 143 | "get": { 144 | "description": "", 145 | "operationId": "GET /Encounter/{id}/$validate", 146 | "produces": [ 147 | "application/json+fhir", 148 | "application/xml+fhir" 149 | ], 150 | "parameters": [ 151 | { 152 | "required": true, 153 | "in": "path", 154 | "name": "id", 155 | "type": "string" 156 | } 157 | ], 158 | "responses": { 159 | "200": { 160 | "description": "Status 200" 161 | } 162 | } 163 | } 164 | }, 165 | "/Encounter/{id}/_history/{vid}": { 166 | "get": { 167 | "description": "", 168 | "operationId": "GET /Encounter/{id}/_history/{vid}", 169 | "produces": [ 170 | "application/json+fhir", 171 | "application/xml+fhir" 172 | ], 173 | "parameters": [ 174 | { 175 | "required": true, 176 | "in": "path", 177 | "name": "vid", 178 | "type": "string" 179 | }, 180 | { 181 | "required": true, 182 | "in": "path", 183 | "name": "id", 184 | "type": "string" 185 | } 186 | ], 187 | "responses": { 188 | "200": { 189 | "description": "Status 200" 190 | } 191 | } 192 | } 193 | }, 194 | "/Encounter/{id}": { 195 | "get": { 196 | "description": "", 197 | "operationId": "GET /Encounter/{id}", 198 | "produces": [ 199 | "application/json+fhir", 200 | "application/xml+fhir" 201 | ], 202 | "parameters": [ 203 | { 204 | "required": true, 205 | "in": "path", 206 | "name": "id", 207 | "type": "string" 208 | } 209 | ], 210 | "responses": { 211 | "200": { 212 | "description": "Status 200" 213 | }, 214 | "404": { 215 | "description": "Tried to get an unknown resource\n" 216 | }, 217 | "410": { 218 | "description": "Tried to get a deleted resource\n" 219 | }, 220 | "422": { 221 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 222 | } 223 | } 224 | }, 225 | "put": { 226 | "description": "Update an existing instance\n", 227 | "operationId": "PUT /Encounter/{id}", 228 | "consumes": [ 229 | "application/json+fhir", 230 | "application/xml+fhir" 231 | ], 232 | "produces": [ 233 | "application/json+fhir", 234 | "application/xml+fhir" 235 | ], 236 | "parameters": [ 237 | { 238 | "required": true, 239 | "in": "path", 240 | "name": "id", 241 | "type": "string" 242 | } 243 | ], 244 | "responses": { 245 | "200": { 246 | "description": "Succesfully updated the instance \n" 247 | }, 248 | "201": { 249 | "description": "Succesfully created the instance \n" 250 | }, 251 | "400": { 252 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 253 | }, 254 | "404": { 255 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 256 | }, 257 | "405": { 258 | "description": "Method Not allowed - the resource did not exist prior to the update, and the server does not allow client defined ids\n" 259 | }, 260 | "409": { 261 | "description": "Version conflict management\n" 262 | }, 263 | "412": { 264 | "description": "Version conflict management\n" 265 | }, 266 | "422": { 267 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 268 | } 269 | } 270 | }, 271 | "delete": { 272 | "description": "Delete resource\n", 273 | "operationId": "DELETE /Encounter/{id}", 274 | "produces": [ 275 | "application/json+fhir", 276 | "application/xml+fhir" 277 | ], 278 | "parameters": [ 279 | { 280 | "required": true, 281 | "in": "path", 282 | "name": "id", 283 | "type": "string" 284 | } 285 | ], 286 | "responses": { 287 | "204": { 288 | "description": "Succesfully deleted resource\n" 289 | }, 290 | "404": { 291 | "description": "Not Found - resource was not found\n" 292 | }, 293 | "405": { 294 | "description": "Method Not allowed - delete is not allowed\n" 295 | } 296 | } 297 | } 298 | }, 299 | "/Encounter/_search": { 300 | "get": { 301 | "description": "", 302 | "operationId": "GET /Encounter/_search", 303 | "produces": [ 304 | "application/atom+xml", 305 | "application/json+fhir" 306 | ], 307 | "responses": { 308 | "200": { 309 | "description": "Status 200" 310 | } 311 | } 312 | } 313 | }, 314 | "/Encounter/{id}/_history/{vid}/_tags": { 315 | "get": { 316 | "description": "get a list of tags used for the nominated version of the resource. This duplicates the HTTP header entries.\n", 317 | "operationId": "GET /Encounter/{id}/_history/{vid}/_tags", 318 | "produces": [ 319 | "application/json+fhir", 320 | "application/xml+fhir" 321 | ], 322 | "parameters": [ 323 | { 324 | "required": true, 325 | "in": "path", 326 | "name": "vid", 327 | "type": "string" 328 | }, 329 | { 330 | "required": true, 331 | "in": "path", 332 | "name": "id", 333 | "type": "string" 334 | } 335 | ], 336 | "responses": { 337 | "200": { 338 | "description": "Succesfully retrieved resource\n" 339 | } 340 | } 341 | }, 342 | "post": { 343 | "description": "Affix tags in the list to the nominated verion of the resource\n", 344 | "operationId": "POST /Encounter/{id}/_history/{vid}/_tags", 345 | "consumes": [ 346 | "application/json+fhir", 347 | "application/xml+fhir" 348 | ], 349 | "produces": [ 350 | "application/json+fhir", 351 | "application/xml+fhir" 352 | ], 353 | "parameters": [ 354 | { 355 | "required": true, 356 | "in": "path", 357 | "name": "vid", 358 | "type": "string" 359 | }, 360 | { 361 | "required": true, 362 | "in": "path", 363 | "name": "id", 364 | "type": "string" 365 | } 366 | ], 367 | "responses": { 368 | "201": { 369 | "description": "Succesfully affix tags\n" 370 | } 371 | } 372 | } 373 | }, 374 | "/_tags": { 375 | "get": { 376 | "description": "get a list of all tags\n", 377 | "operationId": "GET /_tags", 378 | "produces": [ 379 | "application/json+fhir", 380 | "application/xml+fhir" 381 | ], 382 | "responses": { 383 | "200": { 384 | "description": "Succesfully retrieved resource\n" 385 | } 386 | } 387 | } 388 | }, 389 | "/": { 390 | "get": { 391 | "description": "Retrieve resource\n", 392 | "operationId": "GET /", 393 | "produces": [ 394 | "application/json+fhir", 395 | "application/xml+fhir" 396 | ], 397 | "responses": { 398 | "200": { 399 | "description": "Succesfully retrieved resource\n" 400 | } 401 | } 402 | }, 403 | "post": { 404 | "description": "Create a new resource\n", 405 | "operationId": "POST /", 406 | "consumes": [ 407 | "application/json" 408 | ], 409 | "produces": [ 410 | "application/json+fhir", 411 | "application/xml+fhir" 412 | ], 413 | "responses": { 414 | "201": { 415 | "description": "Succesfully created a new resource\n" 416 | } 417 | } 418 | } 419 | }, 420 | "/Encounter/_validate/{id}": { 421 | "post": { 422 | "description": "Create a new resource\n", 423 | "operationId": "POST /Encounter/_validate/{id}", 424 | "consumes": [ 425 | "application/json+fhir", 426 | "application/xml+fhir" 427 | ], 428 | "produces": [ 429 | "application/json+fhir", 430 | "application/xml+fhir" 431 | ], 432 | "parameters": [ 433 | { 434 | "required": true, 435 | "in": "path", 436 | "name": "id", 437 | "type": "string" 438 | } 439 | ], 440 | "responses": { 441 | "201": { 442 | "description": "Validates a type\n" 443 | } 444 | } 445 | } 446 | }, 447 | "/Encounter": { 448 | "get": { 449 | "description": "Get Encounter", 450 | "operationId": "GET /Encounter", 451 | "produces": [ 452 | "application/json+fhir", 453 | "application/xml+fhir" 454 | ], 455 | "responses": { 456 | "200": { 457 | "description": "Status 200" 458 | } 459 | } 460 | }, 461 | "post": { 462 | "description": "Create a new type\n", 463 | "operationId": "POST /Encounter", 464 | "consumes": [ 465 | "application/json+fhir", 466 | "application/xml+fhir" 467 | ], 468 | "produces": [ 469 | "application/json+fhir", 470 | "application/xml+fhir" 471 | ], 472 | "responses": { 473 | "201": { 474 | "description": "Succesfully created a new type\n" 475 | }, 476 | "400": { 477 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 478 | }, 479 | "404": { 480 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 481 | } 482 | } 483 | } 484 | }, 485 | "/Encounter/_tags": { 486 | "get": { 487 | "description": "get a list of tags used for the nominated resource type\n", 488 | "operationId": "GET /Encounter/_tags", 489 | "produces": [ 490 | "application/json+fhir", 491 | "application/xml+fhir" 492 | ], 493 | "responses": { 494 | "200": { 495 | "description": "Succesfully retrieved resource\n" 496 | } 497 | } 498 | } 499 | }, 500 | "/$meta": { 501 | "get": { 502 | "description": "", 503 | "operationId": "GET /$meta", 504 | "responses": { 505 | "200": { 506 | "description": "Successfully retrieved resource(s)\n" 507 | } 508 | } 509 | } 510 | }, 511 | "/_history": { 512 | "get": { 513 | "description": "Whole System History\n", 514 | "operationId": "GET /_history", 515 | "produces": [ 516 | "application/json+fhir", 517 | "application/xml+fhir" 518 | ], 519 | "responses": { 520 | "200": { 521 | "description": "Succesfully retrieved resource\n" 522 | } 523 | } 524 | } 525 | }, 526 | "/Encounter/$validate": { 527 | "get": { 528 | "description": "", 529 | "operationId": "GET /Encounter/$validate", 530 | "produces": [ 531 | "application/json+fhir", 532 | "application/xml+fhir" 533 | ], 534 | "responses": { 535 | "200": { 536 | "description": "Status 200" 537 | } 538 | } 539 | } 540 | }, 541 | "/Encounter/{id}/$everything": { 542 | "get": { 543 | "description": "", 544 | "operationId": "GET /Encounter/{id}/$everything", 545 | "produces": [ 546 | "application/json+fhir", 547 | "application/xml+fhir" 548 | ], 549 | "parameters": [ 550 | { 551 | "required": true, 552 | "in": "path", 553 | "name": "id", 554 | "type": "string" 555 | } 556 | ], 557 | "responses": { 558 | "200": { 559 | "description": "Status 200" 560 | } 561 | } 562 | } 563 | }, 564 | "/Encounter/_history": { 565 | "get": { 566 | "description": "", 567 | "operationId": "GET /Encounter/_history", 568 | "produces": [ 569 | "application/atom+xml", 570 | "application/json+fhir" 571 | ], 572 | "responses": { 573 | "200": { 574 | "description": "Status 200" 575 | } 576 | } 577 | } 578 | }, 579 | "/Encounter/{id}/_history": { 580 | "get": { 581 | "description": "", 582 | "operationId": "GET /Encounter/{id}/_history", 583 | "produces": [ 584 | "application/json+fhir", 585 | "application/xml+fhir" 586 | ], 587 | "parameters": [ 588 | { 589 | "required": true, 590 | "in": "path", 591 | "name": "id", 592 | "type": "string" 593 | } 594 | ], 595 | "responses": { 596 | "200": { 597 | "description": "Status 200" 598 | } 599 | } 600 | } 601 | } 602 | }, 603 | "info": { 604 | "title": "FHIR Encounter", 605 | "description": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. For more information: https://www.hl7.org/fhir/encounter.html", 606 | "version": "2" 607 | }, 608 | "x-axway": { 609 | "corsEnabled": true, 610 | "basePaths": [ 611 | "" 612 | ], 613 | "serviceType": "rest", 614 | "deprecated": false, 615 | "tags" : { 616 | "Group" : [ "FHIR", " Workflow", " Patient Management" ] 617 | } 618 | } 619 | } -------------------------------------------------------------------------------- /src/FHIRLocation.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "host": "fhir3.healthintersections.com.au/open", 4 | "basePath": "/", 5 | "schemes": [ 6 | "http" 7 | ], 8 | "paths": { 9 | "/Location/{id}/_tags": { 10 | "get": { 11 | "description": "get a list of tags used for the nominated resource. This duplicates the HTTP header entries\n", 12 | "operationId": "GET /Location/{id}/_tags", 13 | "produces": [ 14 | "application/json+fhir", 15 | "application/xml+fhir" 16 | ], 17 | "parameters": [ 18 | { 19 | "required": true, 20 | "in": "path", 21 | "name": "id", 22 | "type": "string" 23 | } 24 | ], 25 | "responses": { 26 | "200": { 27 | "description": "Succesfully retrieved resource\n" 28 | } 29 | } 30 | }, 31 | "post": { 32 | "description": "Affix tags in the list to the nominated resource\n", 33 | "operationId": "POST /Location/{id}/_tags", 34 | "consumes": [ 35 | "application/json" 36 | ], 37 | "produces": [ 38 | "application/json+fhir", 39 | "application/xml+fhir" 40 | ], 41 | "parameters": [ 42 | { 43 | "required": true, 44 | "in": "path", 45 | "name": "id", 46 | "type": "string" 47 | } 48 | ], 49 | "responses": { 50 | "201": { 51 | "description": "Succesfully affix tags\n" 52 | } 53 | } 54 | } 55 | }, 56 | "/Location/{id}/_history/{vid}/_tags/_delete": { 57 | "post": { 58 | "description": "Removes all tags in the provided list of tags for the nominated version of the resource\n", 59 | "operationId": "POST /Location/{id}/_history/{vid}/_tags/_delete", 60 | "consumes": [ 61 | "application/json+fhir", 62 | "application/xml+fhir" 63 | ], 64 | "produces": [ 65 | "application/json+fhir", 66 | "application/xml+fhir" 67 | ], 68 | "parameters": [ 69 | { 70 | "required": true, 71 | "in": "path", 72 | "name": "vid", 73 | "type": "string" 74 | }, 75 | { 76 | "required": true, 77 | "in": "path", 78 | "name": "id", 79 | "type": "string" 80 | } 81 | ], 82 | "responses": { 83 | "204": { 84 | "description": "Successful deletion of tags" 85 | } 86 | } 87 | } 88 | }, 89 | "/Location/{id}/_tags/_delete": { 90 | "post": { 91 | "description": "Removes all tags in the provided list of tags for the nominated resource\n", 92 | "operationId": "POST /Location/{id}/_tags/_delete", 93 | "consumes": [ 94 | "application/json+fhir", 95 | "application/xml+fhir" 96 | ], 97 | "produces": [ 98 | "application/json+fhir", 99 | "application/xml+fhir" 100 | ], 101 | "parameters": [ 102 | { 103 | "required": true, 104 | "in": "path", 105 | "name": "id", 106 | "type": "string" 107 | } 108 | ], 109 | "responses": { 110 | "204": { 111 | "description": "Status 204" 112 | } 113 | } 114 | } 115 | }, 116 | "/metadata": { 117 | "get": { 118 | "description": "Retrieve resource\n", 119 | "operationId": "GET /metadata", 120 | "produces": [ 121 | "application/json+fhir", 122 | "application/xml+fhir" 123 | ], 124 | "responses": { 125 | "200": { 126 | "description": "Succesfully retrieved resource\n" 127 | } 128 | } 129 | } 130 | }, 131 | "/Location/$meta": { 132 | "get": { 133 | "description": "", 134 | "operationId": "GET /Location/$meta", 135 | "responses": { 136 | "200": { 137 | "description": "Successfully retrieved resource(s)\n" 138 | } 139 | } 140 | } 141 | }, 142 | "/Location/{id}/$validate": { 143 | "get": { 144 | "description": "", 145 | "operationId": "GET /Location/{id}/$validate", 146 | "produces": [ 147 | "application/json+fhir", 148 | "application/xml+fhir" 149 | ], 150 | "parameters": [ 151 | { 152 | "required": true, 153 | "in": "path", 154 | "name": "id", 155 | "type": "string" 156 | } 157 | ], 158 | "responses": { 159 | "200": { 160 | "description": "Status 200" 161 | } 162 | } 163 | } 164 | }, 165 | "/Location/{id}/_history/{vid}": { 166 | "get": { 167 | "description": "", 168 | "operationId": "GET /Location/{id}/_history/{vid}", 169 | "produces": [ 170 | "application/json+fhir", 171 | "application/xml+fhir" 172 | ], 173 | "parameters": [ 174 | { 175 | "required": true, 176 | "in": "path", 177 | "name": "vid", 178 | "type": "string" 179 | }, 180 | { 181 | "required": true, 182 | "in": "path", 183 | "name": "id", 184 | "type": "string" 185 | } 186 | ], 187 | "responses": { 188 | "200": { 189 | "description": "Status 200" 190 | } 191 | } 192 | } 193 | }, 194 | "/Location/{id}": { 195 | "get": { 196 | "description": "", 197 | "operationId": "GET /Location/{id}", 198 | "produces": [ 199 | "application/json+fhir", 200 | "application/xml+fhir" 201 | ], 202 | "parameters": [ 203 | { 204 | "required": true, 205 | "in": "path", 206 | "name": "id", 207 | "type": "string" 208 | } 209 | ], 210 | "responses": { 211 | "200": { 212 | "description": "Status 200" 213 | }, 214 | "404": { 215 | "description": "Tried to get an unknown resource\n" 216 | }, 217 | "410": { 218 | "description": "Tried to get a deleted resource\n" 219 | }, 220 | "422": { 221 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 222 | } 223 | } 224 | }, 225 | "put": { 226 | "description": "Update an existing instance\n", 227 | "operationId": "PUT /Location/{id}", 228 | "consumes": [ 229 | "application/json+fhir", 230 | "application/xml+fhir" 231 | ], 232 | "produces": [ 233 | "application/json+fhir", 234 | "application/xml+fhir" 235 | ], 236 | "parameters": [ 237 | { 238 | "required": true, 239 | "in": "path", 240 | "name": "id", 241 | "type": "string" 242 | } 243 | ], 244 | "responses": { 245 | "200": { 246 | "description": "Succesfully updated the instance \n" 247 | }, 248 | "201": { 249 | "description": "Succesfully created the instance \n" 250 | }, 251 | "400": { 252 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 253 | }, 254 | "404": { 255 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 256 | }, 257 | "405": { 258 | "description": "Method Not allowed - the resource did not exist prior to the update, and the server does not allow client defined ids\n" 259 | }, 260 | "409": { 261 | "description": "Version conflict management\n" 262 | }, 263 | "412": { 264 | "description": "Version conflict management\n" 265 | }, 266 | "422": { 267 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 268 | } 269 | } 270 | }, 271 | "delete": { 272 | "description": "Delete resource\n", 273 | "operationId": "DELETE /Location/{id}", 274 | "produces": [ 275 | "application/json+fhir", 276 | "application/xml+fhir" 277 | ], 278 | "parameters": [ 279 | { 280 | "required": true, 281 | "in": "path", 282 | "name": "id", 283 | "type": "string" 284 | } 285 | ], 286 | "responses": { 287 | "204": { 288 | "description": "Succesfully deleted resource\n" 289 | }, 290 | "404": { 291 | "description": "Not Found - resource was not found\n" 292 | }, 293 | "405": { 294 | "description": "Method Not allowed - delete is not allowed\n" 295 | } 296 | } 297 | } 298 | }, 299 | "/Location/_search": { 300 | "get": { 301 | "description": "", 302 | "operationId": "GET /Location/_search", 303 | "produces": [ 304 | "application/atom+xml", 305 | "application/json+fhir" 306 | ], 307 | "responses": { 308 | "200": { 309 | "description": "Status 200" 310 | } 311 | } 312 | } 313 | }, 314 | "/Location/{id}/_history/{vid}/_tags": { 315 | "get": { 316 | "description": "get a list of tags used for the nominated version of the resource. This duplicates the HTTP header entries.\n", 317 | "operationId": "GET /Location/{id}/_history/{vid}/_tags", 318 | "produces": [ 319 | "application/json+fhir", 320 | "application/xml+fhir" 321 | ], 322 | "parameters": [ 323 | { 324 | "required": true, 325 | "in": "path", 326 | "name": "vid", 327 | "type": "string" 328 | }, 329 | { 330 | "required": true, 331 | "in": "path", 332 | "name": "id", 333 | "type": "string" 334 | } 335 | ], 336 | "responses": { 337 | "200": { 338 | "description": "Succesfully retrieved resource\n" 339 | } 340 | } 341 | }, 342 | "post": { 343 | "description": "Affix tags in the list to the nominated verion of the resource\n", 344 | "operationId": "POST /Location/{id}/_history/{vid}/_tags", 345 | "consumes": [ 346 | "application/json+fhir", 347 | "application/xml+fhir" 348 | ], 349 | "produces": [ 350 | "application/json+fhir", 351 | "application/xml+fhir" 352 | ], 353 | "parameters": [ 354 | { 355 | "required": true, 356 | "in": "path", 357 | "name": "vid", 358 | "type": "string" 359 | }, 360 | { 361 | "required": true, 362 | "in": "path", 363 | "name": "id", 364 | "type": "string" 365 | } 366 | ], 367 | "responses": { 368 | "201": { 369 | "description": "Succesfully affix tags\n" 370 | } 371 | } 372 | } 373 | }, 374 | "/_tags": { 375 | "get": { 376 | "description": "get a list of all tags\n", 377 | "operationId": "GET /_tags", 378 | "produces": [ 379 | "application/json+fhir", 380 | "application/xml+fhir" 381 | ], 382 | "responses": { 383 | "200": { 384 | "description": "Succesfully retrieved resource\n" 385 | } 386 | } 387 | } 388 | }, 389 | "/": { 390 | "get": { 391 | "description": "Retrieve resource\n", 392 | "operationId": "GET /", 393 | "produces": [ 394 | "application/json+fhir", 395 | "application/xml+fhir" 396 | ], 397 | "responses": { 398 | "200": { 399 | "description": "Succesfully retrieved resource\n" 400 | } 401 | } 402 | }, 403 | "post": { 404 | "description": "Create a new resource\n", 405 | "operationId": "POST /", 406 | "consumes": [ 407 | "application/json" 408 | ], 409 | "produces": [ 410 | "application/json+fhir", 411 | "application/xml+fhir" 412 | ], 413 | "responses": { 414 | "201": { 415 | "description": "Succesfully created a new resource\n" 416 | } 417 | } 418 | } 419 | }, 420 | "/Location/_validate/{id}": { 421 | "post": { 422 | "description": "Create a new resource\n", 423 | "operationId": "POST /Location/_validate/{id}", 424 | "consumes": [ 425 | "application/json+fhir", 426 | "application/xml+fhir" 427 | ], 428 | "produces": [ 429 | "application/json+fhir", 430 | "application/xml+fhir" 431 | ], 432 | "parameters": [ 433 | { 434 | "required": true, 435 | "in": "path", 436 | "name": "id", 437 | "type": "string" 438 | } 439 | ], 440 | "responses": { 441 | "201": { 442 | "description": "Validates a type\n" 443 | } 444 | } 445 | } 446 | }, 447 | "/Location": { 448 | "get": { 449 | "description": "Get Location", 450 | "operationId": "GET /Location", 451 | "produces": [ 452 | "application/json+fhir", 453 | "application/xml+fhir" 454 | ], 455 | "responses": { 456 | "200": { 457 | "description": "Status 200" 458 | } 459 | } 460 | }, 461 | "post": { 462 | "description": "Create a new type\n", 463 | "operationId": "POST /Location", 464 | "consumes": [ 465 | "application/json+fhir", 466 | "application/xml+fhir" 467 | ], 468 | "produces": [ 469 | "application/json+fhir", 470 | "application/xml+fhir" 471 | ], 472 | "responses": { 473 | "201": { 474 | "description": "Succesfully created a new type\n" 475 | }, 476 | "400": { 477 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 478 | }, 479 | "404": { 480 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 481 | } 482 | } 483 | } 484 | }, 485 | "/Location/_tags": { 486 | "get": { 487 | "description": "get a list of tags used for the nominated resource type\n", 488 | "operationId": "GET /Location/_tags", 489 | "produces": [ 490 | "application/json+fhir", 491 | "application/xml+fhir" 492 | ], 493 | "responses": { 494 | "200": { 495 | "description": "Succesfully retrieved resource\n" 496 | } 497 | } 498 | } 499 | }, 500 | "/$meta": { 501 | "get": { 502 | "description": "", 503 | "operationId": "GET /$meta", 504 | "responses": { 505 | "200": { 506 | "description": "Successfully retrieved resource(s)\n" 507 | } 508 | } 509 | } 510 | }, 511 | "/_history": { 512 | "get": { 513 | "description": "Whole System History\n", 514 | "operationId": "GET /_history", 515 | "produces": [ 516 | "application/json+fhir", 517 | "application/xml+fhir" 518 | ], 519 | "responses": { 520 | "200": { 521 | "description": "Succesfully retrieved resource\n" 522 | } 523 | } 524 | } 525 | }, 526 | "/Location/$validate": { 527 | "get": { 528 | "description": "", 529 | "operationId": "GET /Location/$validate", 530 | "produces": [ 531 | "application/json+fhir", 532 | "application/xml+fhir" 533 | ], 534 | "responses": { 535 | "200": { 536 | "description": "Status 200" 537 | } 538 | } 539 | } 540 | }, 541 | "/Location/{id}/$everything": { 542 | "get": { 543 | "description": "", 544 | "operationId": "GET /Location/{id}/$everything", 545 | "produces": [ 546 | "application/json+fhir", 547 | "application/xml+fhir" 548 | ], 549 | "parameters": [ 550 | { 551 | "required": true, 552 | "in": "path", 553 | "name": "id", 554 | "type": "string" 555 | } 556 | ], 557 | "responses": { 558 | "200": { 559 | "description": "Status 200" 560 | } 561 | } 562 | } 563 | }, 564 | "/Location/_history": { 565 | "get": { 566 | "description": "", 567 | "operationId": "GET /Location/_history", 568 | "produces": [ 569 | "application/atom+xml", 570 | "application/json+fhir" 571 | ], 572 | "responses": { 573 | "200": { 574 | "description": "Status 200" 575 | } 576 | } 577 | } 578 | }, 579 | "/Location/{id}/_history": { 580 | "get": { 581 | "description": "", 582 | "operationId": "GET /Location/{id}/_history", 583 | "produces": [ 584 | "application/json+fhir", 585 | "application/xml+fhir" 586 | ], 587 | "parameters": [ 588 | { 589 | "required": true, 590 | "in": "path", 591 | "name": "id", 592 | "type": "string" 593 | } 594 | ], 595 | "responses": { 596 | "200": { 597 | "description": "Status 200" 598 | } 599 | } 600 | } 601 | } 602 | }, 603 | "info": { 604 | "title": "FHIR Location", 605 | "description": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated. For more information: https://www.hl7.org/fhir/location.html", 606 | "version": "2" 607 | }, 608 | "x-axway": { 609 | "corsEnabled": true, 610 | "basePaths": [ 611 | "" 612 | ], 613 | "serviceType": "rest", 614 | "deprecated": false, 615 | "tags" : { 616 | "Group" : [ "FHIR", " Identification", " Entities" ] 617 | } 618 | } 619 | } -------------------------------------------------------------------------------- /src/FHIRObservation.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "host": "fhir3.healthintersections.com.au/open", 4 | "basePath": "", 5 | "schemes": [ 6 | "http" 7 | ], 8 | "paths": { 9 | "/Observation/{id}/_tags": { 10 | "get": { 11 | "description": "get a list of tags used for the nominated resource. This duplicates the HTTP header entries\n", 12 | "operationId": "GET /Observation/{id}/_tags", 13 | "produces": [ 14 | "application/json+fhir", 15 | "application/xml+fhir" 16 | ], 17 | "parameters": [ 18 | { 19 | "required": true, 20 | "in": "path", 21 | "name": "id", 22 | "type": "string" 23 | } 24 | ], 25 | "responses": { 26 | "200": { 27 | "description": "Succesfully retrieved resource\n" 28 | } 29 | } 30 | }, 31 | "post": { 32 | "description": "Affix tags in the list to the nominated resource\n", 33 | "operationId": "POST /Observation/{id}/_tags", 34 | "consumes": [ 35 | "application/json" 36 | ], 37 | "produces": [ 38 | "application/json+fhir", 39 | "application/xml+fhir" 40 | ], 41 | "parameters": [ 42 | { 43 | "required": true, 44 | "in": "path", 45 | "name": "id", 46 | "type": "string" 47 | } 48 | ], 49 | "responses": { 50 | "201": { 51 | "description": "Succesfully affix tags\n" 52 | } 53 | } 54 | } 55 | }, 56 | "/Observation/{id}/_history/{vid}/_tags/_delete": { 57 | "post": { 58 | "description": "Removes all tags in the provided list of tags for the nominated version of the resource\n", 59 | "operationId": "POST /Observation/{id}/_history/{vid}/_tags/_delete", 60 | "consumes": [ 61 | "application/json+fhir", 62 | "application/xml+fhir" 63 | ], 64 | "produces": [ 65 | "application/json+fhir", 66 | "application/xml+fhir" 67 | ], 68 | "parameters": [ 69 | { 70 | "required": true, 71 | "in": "path", 72 | "name": "vid", 73 | "type": "string" 74 | }, 75 | { 76 | "required": true, 77 | "in": "path", 78 | "name": "id", 79 | "type": "string" 80 | } 81 | ], 82 | "responses": { 83 | "204": { 84 | "description": "Successful deletion of tags" 85 | } 86 | } 87 | } 88 | }, 89 | "/Observation/{id}/_tags/_delete": { 90 | "post": { 91 | "description": "Removes all tags in the provided list of tags for the nominated resource\n", 92 | "operationId": "POST /Observation/{id}/_tags/_delete", 93 | "consumes": [ 94 | "application/json+fhir", 95 | "application/xml+fhir" 96 | ], 97 | "produces": [ 98 | "application/json+fhir", 99 | "application/xml+fhir" 100 | ], 101 | "parameters": [ 102 | { 103 | "required": true, 104 | "in": "path", 105 | "name": "id", 106 | "type": "string" 107 | } 108 | ], 109 | "responses": { 110 | "204": { 111 | "description": "Status 204" 112 | } 113 | } 114 | } 115 | }, 116 | "/metadata": { 117 | "get": { 118 | "description": "Retrieve resource\n", 119 | "operationId": "GET /metadata", 120 | "produces": [ 121 | "application/json+fhir", 122 | "application/xml+fhir" 123 | ], 124 | "responses": { 125 | "200": { 126 | "description": "Succesfully retrieved resource\n" 127 | } 128 | } 129 | } 130 | }, 131 | "/Observation/$meta": { 132 | "get": { 133 | "description": "", 134 | "operationId": "GET /Observation/$meta", 135 | "responses": { 136 | "200": { 137 | "description": "Successfully retrieved resource(s)\n" 138 | } 139 | } 140 | } 141 | }, 142 | "/Observation/{id}/$validate": { 143 | "get": { 144 | "description": "", 145 | "operationId": "GET /Observation/{id}/$validate", 146 | "produces": [ 147 | "application/json+fhir", 148 | "application/xml+fhir" 149 | ], 150 | "parameters": [ 151 | { 152 | "required": true, 153 | "in": "path", 154 | "name": "id", 155 | "type": "string" 156 | } 157 | ], 158 | "responses": { 159 | "200": { 160 | "description": "Status 200" 161 | } 162 | } 163 | } 164 | }, 165 | "/Observation/{id}/_history/{vid}": { 166 | "get": { 167 | "description": "", 168 | "operationId": "GET /Observation/{id}/_history/{vid}", 169 | "produces": [ 170 | "application/json+fhir", 171 | "application/xml+fhir" 172 | ], 173 | "parameters": [ 174 | { 175 | "required": true, 176 | "in": "path", 177 | "name": "vid", 178 | "type": "string" 179 | }, 180 | { 181 | "required": true, 182 | "in": "path", 183 | "name": "id", 184 | "type": "string" 185 | } 186 | ], 187 | "responses": { 188 | "200": { 189 | "description": "Status 200" 190 | } 191 | } 192 | } 193 | }, 194 | "/Observation/{id}": { 195 | "get": { 196 | "description": "", 197 | "operationId": "GET /Observation/{id}", 198 | "produces": [ 199 | "application/json+fhir", 200 | "application/xml+fhir" 201 | ], 202 | "parameters": [ 203 | { 204 | "required": true, 205 | "in": "path", 206 | "name": "id", 207 | "type": "string" 208 | } 209 | ], 210 | "responses": { 211 | "200": { 212 | "description": "Status 200" 213 | }, 214 | "404": { 215 | "description": "Tried to get an unknown resource\n" 216 | }, 217 | "410": { 218 | "description": "Tried to get a deleted resource\n" 219 | }, 220 | "422": { 221 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 222 | } 223 | } 224 | }, 225 | "put": { 226 | "description": "Update an existing instance\n", 227 | "operationId": "PUT /Observation/{id}", 228 | "consumes": [ 229 | "application/json+fhir", 230 | "application/xml+fhir" 231 | ], 232 | "produces": [ 233 | "application/json+fhir", 234 | "application/xml+fhir" 235 | ], 236 | "parameters": [ 237 | { 238 | "required": true, 239 | "in": "path", 240 | "name": "id", 241 | "type": "string" 242 | } 243 | ], 244 | "responses": { 245 | "200": { 246 | "description": "Succesfully updated the instance \n" 247 | }, 248 | "201": { 249 | "description": "Succesfully created the instance \n" 250 | }, 251 | "400": { 252 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 253 | }, 254 | "404": { 255 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 256 | }, 257 | "405": { 258 | "description": "Method Not allowed - the resource did not exist prior to the update, and the server does not allow client defined ids\n" 259 | }, 260 | "409": { 261 | "description": "Version conflict management\n" 262 | }, 263 | "412": { 264 | "description": "Version conflict management\n" 265 | }, 266 | "422": { 267 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 268 | } 269 | } 270 | }, 271 | "delete": { 272 | "description": "Delete resource\n", 273 | "operationId": "DELETE /Observation/{id}", 274 | "produces": [ 275 | "application/json+fhir", 276 | "application/xml+fhir" 277 | ], 278 | "parameters": [ 279 | { 280 | "required": true, 281 | "in": "path", 282 | "name": "id", 283 | "type": "string" 284 | } 285 | ], 286 | "responses": { 287 | "204": { 288 | "description": "Succesfully deleted resource\n" 289 | }, 290 | "404": { 291 | "description": "Not Found - resource was not found\n" 292 | }, 293 | "405": { 294 | "description": "Method Not allowed - delete is not allowed\n" 295 | } 296 | } 297 | } 298 | }, 299 | "/Observation/_search": { 300 | "get": { 301 | "description": "", 302 | "operationId": "GET /Observation/_search", 303 | "produces": [ 304 | "application/atom+xml", 305 | "application/json+fhir" 306 | ], 307 | "responses": { 308 | "200": { 309 | "description": "Status 200" 310 | } 311 | } 312 | } 313 | }, 314 | "/Observation/{id}/_history/{vid}/_tags": { 315 | "get": { 316 | "description": "get a list of tags used for the nominated version of the resource. This duplicates the HTTP header entries.\n", 317 | "operationId": "GET /Observation/{id}/_history/{vid}/_tags", 318 | "produces": [ 319 | "application/json+fhir", 320 | "application/xml+fhir" 321 | ], 322 | "parameters": [ 323 | { 324 | "required": true, 325 | "in": "path", 326 | "name": "vid", 327 | "type": "string" 328 | }, 329 | { 330 | "required": true, 331 | "in": "path", 332 | "name": "id", 333 | "type": "string" 334 | } 335 | ], 336 | "responses": { 337 | "200": { 338 | "description": "Succesfully retrieved resource\n" 339 | } 340 | } 341 | }, 342 | "post": { 343 | "description": "Affix tags in the list to the nominated verion of the resource\n", 344 | "operationId": "POST /Observation/{id}/_history/{vid}/_tags", 345 | "consumes": [ 346 | "application/json+fhir", 347 | "application/xml+fhir" 348 | ], 349 | "produces": [ 350 | "application/json+fhir", 351 | "application/xml+fhir" 352 | ], 353 | "parameters": [ 354 | { 355 | "required": true, 356 | "in": "path", 357 | "name": "vid", 358 | "type": "string" 359 | }, 360 | { 361 | "required": true, 362 | "in": "path", 363 | "name": "id", 364 | "type": "string" 365 | } 366 | ], 367 | "responses": { 368 | "201": { 369 | "description": "Succesfully affix tags\n" 370 | } 371 | } 372 | } 373 | }, 374 | "/_tags": { 375 | "get": { 376 | "description": "get a list of all tags\n", 377 | "operationId": "GET /_tags", 378 | "produces": [ 379 | "application/json+fhir", 380 | "application/xml+fhir" 381 | ], 382 | "responses": { 383 | "200": { 384 | "description": "Succesfully retrieved resource\n" 385 | } 386 | } 387 | } 388 | }, 389 | "/": { 390 | "get": { 391 | "description": "Retrieve resource\n", 392 | "operationId": "GET /", 393 | "produces": [ 394 | "application/json+fhir", 395 | "application/xml+fhir" 396 | ], 397 | "responses": { 398 | "200": { 399 | "description": "Succesfully retrieved resource\n" 400 | } 401 | } 402 | }, 403 | "post": { 404 | "description": "Create a new resource\n", 405 | "operationId": "POST /", 406 | "consumes": [ 407 | "application/json" 408 | ], 409 | "produces": [ 410 | "application/json+fhir", 411 | "application/xml+fhir" 412 | ], 413 | "responses": { 414 | "201": { 415 | "description": "Succesfully created a new resource\n" 416 | } 417 | } 418 | } 419 | }, 420 | "/Observation/_validate/{id}": { 421 | "post": { 422 | "description": "Create a new resource\n", 423 | "operationId": "POST /Observation/_validate/{id}", 424 | "consumes": [ 425 | "application/json+fhir", 426 | "application/xml+fhir" 427 | ], 428 | "produces": [ 429 | "application/json+fhir", 430 | "application/xml+fhir" 431 | ], 432 | "parameters": [ 433 | { 434 | "required": true, 435 | "in": "path", 436 | "name": "id", 437 | "type": "string" 438 | } 439 | ], 440 | "responses": { 441 | "201": { 442 | "description": "Validates a type\n" 443 | } 444 | } 445 | } 446 | }, 447 | "/Observation": { 448 | "get": { 449 | "description": "Get Observation", 450 | "operationId": "GET /Observation", 451 | "produces": [ 452 | "application/json+fhir", 453 | "application/xml+fhir" 454 | ], 455 | "responses": { 456 | "200": { 457 | "description": "Status 200" 458 | } 459 | } 460 | }, 461 | "post": { 462 | "description": "Create a new type\n", 463 | "operationId": "POST /Observation", 464 | "consumes": [ 465 | "application/json+fhir", 466 | "application/xml+fhir" 467 | ], 468 | "produces": [ 469 | "application/json+fhir", 470 | "application/xml+fhir" 471 | ], 472 | "responses": { 473 | "201": { 474 | "description": "Succesfully created a new type\n" 475 | }, 476 | "400": { 477 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 478 | }, 479 | "404": { 480 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 481 | } 482 | } 483 | } 484 | }, 485 | "/Observation/_tags": { 486 | "get": { 487 | "description": "get a list of tags used for the nominated resource type\n", 488 | "operationId": "GET /Observation/_tags", 489 | "produces": [ 490 | "application/json+fhir", 491 | "application/xml+fhir" 492 | ], 493 | "responses": { 494 | "200": { 495 | "description": "Succesfully retrieved resource\n" 496 | } 497 | } 498 | } 499 | }, 500 | "/$meta": { 501 | "get": { 502 | "description": "", 503 | "operationId": "GET /$meta", 504 | "responses": { 505 | "200": { 506 | "description": "Successfully retrieved resource(s)\n" 507 | } 508 | } 509 | } 510 | }, 511 | "/_history": { 512 | "get": { 513 | "description": "Whole System History\n", 514 | "operationId": "GET /_history", 515 | "produces": [ 516 | "application/json+fhir", 517 | "application/xml+fhir" 518 | ], 519 | "responses": { 520 | "200": { 521 | "description": "Succesfully retrieved resource\n" 522 | } 523 | } 524 | } 525 | }, 526 | "/Observation/$validate": { 527 | "get": { 528 | "description": "", 529 | "operationId": "GET /Observation/$validate", 530 | "produces": [ 531 | "application/json+fhir", 532 | "application/xml+fhir" 533 | ], 534 | "responses": { 535 | "200": { 536 | "description": "Status 200" 537 | } 538 | } 539 | } 540 | }, 541 | "/Observation/{id}/$everything": { 542 | "get": { 543 | "description": "", 544 | "operationId": "GET /Observation/{id}/$everything", 545 | "produces": [ 546 | "application/json+fhir", 547 | "application/xml+fhir" 548 | ], 549 | "parameters": [ 550 | { 551 | "required": true, 552 | "in": "path", 553 | "name": "id", 554 | "type": "string" 555 | } 556 | ], 557 | "responses": { 558 | "200": { 559 | "description": "Status 200" 560 | } 561 | } 562 | } 563 | }, 564 | "/Observation/_history": { 565 | "get": { 566 | "description": "", 567 | "operationId": "GET /Observation/_history", 568 | "produces": [ 569 | "application/atom+xml", 570 | "application/json+fhir" 571 | ], 572 | "responses": { 573 | "200": { 574 | "description": "Status 200" 575 | } 576 | } 577 | } 578 | }, 579 | "/Observation/{id}/_history": { 580 | "get": { 581 | "description": "", 582 | "operationId": "GET /Observation/{id}/_history", 583 | "produces": [ 584 | "application/json+fhir", 585 | "application/xml+fhir" 586 | ], 587 | "parameters": [ 588 | { 589 | "required": true, 590 | "in": "path", 591 | "name": "id", 592 | "type": "string" 593 | } 594 | ], 595 | "responses": { 596 | "200": { 597 | "description": "Status 200" 598 | } 599 | } 600 | } 601 | } 602 | }, 603 | "info": { 604 | "title": "FHIR Observation", 605 | "description": "Measurements and simple assertions made about a patient, device or other subject. For more information: https://www.hl7.org/fhir/observation.html", 606 | "version": "2" 607 | }, 608 | "x-axway": { 609 | "corsEnabled": true, 610 | "basePaths": [ 611 | "" 612 | ], 613 | "serviceType": "rest", 614 | "deprecated": false, 615 | "tags" : { 616 | "Group" : [ "FHIR", " Clinical", " Diagnostics" ] 617 | } 618 | } 619 | } -------------------------------------------------------------------------------- /src/FHIRPatient.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "host": "fhir3.healthintersections.com.au/open", 4 | "basePath": "/", 5 | "schemes": [ 6 | "http" 7 | ], 8 | "paths": { 9 | "/Patient/{id}/_tags": { 10 | "get": { 11 | "description": "get a list of tags used for the nominated resource. This duplicates the HTTP header entries\n", 12 | "operationId": "GET /Patient/{id}/_tags", 13 | "produces": [ 14 | "application/json+fhir", 15 | "application/xml+fhir" 16 | ], 17 | "parameters": [ 18 | { 19 | "required": true, 20 | "in": "path", 21 | "name": "id", 22 | "type": "string" 23 | } 24 | ], 25 | "responses": { 26 | "200": { 27 | "description": "Succesfully retrieved resource\n" 28 | } 29 | } 30 | }, 31 | "post": { 32 | "description": "Affix tags in the list to the nominated resource\n", 33 | "operationId": "POST /Patient/{id}/_tags", 34 | "consumes": [ 35 | "application/json" 36 | ], 37 | "produces": [ 38 | "application/json+fhir", 39 | "application/xml+fhir" 40 | ], 41 | "parameters": [ 42 | { 43 | "required": true, 44 | "in": "path", 45 | "name": "id", 46 | "type": "string" 47 | } 48 | ], 49 | "responses": { 50 | "201": { 51 | "description": "Succesfully affix tags\n" 52 | } 53 | } 54 | } 55 | }, 56 | "/Patient/{id}/_history/{vid}/_tags/_delete": { 57 | "post": { 58 | "description": "Removes all tags in the provided list of tags for the nominated version of the resource\n", 59 | "operationId": "POST /Patient/{id}/_history/{vid}/_tags/_delete", 60 | "consumes": [ 61 | "application/json+fhir", 62 | "application/xml+fhir" 63 | ], 64 | "produces": [ 65 | "application/json+fhir", 66 | "application/xml+fhir" 67 | ], 68 | "parameters": [ 69 | { 70 | "required": true, 71 | "in": "path", 72 | "name": "vid", 73 | "type": "string" 74 | }, 75 | { 76 | "required": true, 77 | "in": "path", 78 | "name": "id", 79 | "type": "string" 80 | } 81 | ], 82 | "responses": { 83 | "204": { 84 | "description": "Successful deletion of tags" 85 | } 86 | } 87 | } 88 | }, 89 | "/Patient/{id}/_tags/_delete": { 90 | "post": { 91 | "description": "Removes all tags in the provided list of tags for the nominated resource\n", 92 | "operationId": "POST /Patient/{id}/_tags/_delete", 93 | "consumes": [ 94 | "application/json+fhir", 95 | "application/xml+fhir" 96 | ], 97 | "produces": [ 98 | "application/json+fhir", 99 | "application/xml+fhir" 100 | ], 101 | "parameters": [ 102 | { 103 | "required": true, 104 | "in": "path", 105 | "name": "id", 106 | "type": "string" 107 | } 108 | ], 109 | "responses": { 110 | "204": { 111 | "description": "Status 204" 112 | } 113 | } 114 | } 115 | }, 116 | "/metadata": { 117 | "get": { 118 | "description": "Retrieve resource\n", 119 | "operationId": "GET /metadata", 120 | "produces": [ 121 | "application/json+fhir", 122 | "application/xml+fhir" 123 | ], 124 | "responses": { 125 | "200": { 126 | "description": "Succesfully retrieved resource\n" 127 | } 128 | } 129 | } 130 | }, 131 | "/Patient/$meta": { 132 | "get": { 133 | "description": "", 134 | "operationId": "GET /Patient/$meta", 135 | "responses": { 136 | "200": { 137 | "description": "Successfully retrieved resource(s)\n" 138 | } 139 | } 140 | } 141 | }, 142 | "/Patient/{id}/$validate": { 143 | "get": { 144 | "description": "", 145 | "operationId": "GET /Patient/{id}/$validate", 146 | "produces": [ 147 | "application/json+fhir", 148 | "application/xml+fhir" 149 | ], 150 | "parameters": [ 151 | { 152 | "required": true, 153 | "in": "path", 154 | "name": "id", 155 | "type": "string" 156 | } 157 | ], 158 | "responses": { 159 | "200": { 160 | "description": "Status 200" 161 | } 162 | } 163 | } 164 | }, 165 | "/Patient/{id}/_history/{vid}": { 166 | "get": { 167 | "description": "", 168 | "operationId": "GET /Patient/{id}/_history/{vid}", 169 | "produces": [ 170 | "application/json+fhir", 171 | "application/xml+fhir" 172 | ], 173 | "parameters": [ 174 | { 175 | "required": true, 176 | "in": "path", 177 | "name": "vid", 178 | "type": "string" 179 | }, 180 | { 181 | "required": true, 182 | "in": "path", 183 | "name": "id", 184 | "type": "string" 185 | } 186 | ], 187 | "responses": { 188 | "200": { 189 | "description": "Status 200" 190 | } 191 | } 192 | } 193 | }, 194 | "/Patient/{id}": { 195 | "get": { 196 | "description": "", 197 | "operationId": "GET /Patient/{id}", 198 | "produces": [ 199 | "application/json+fhir", 200 | "application/xml+fhir" 201 | ], 202 | "parameters": [ 203 | { 204 | "required": true, 205 | "in": "path", 206 | "name": "id", 207 | "type": "string" 208 | } 209 | ], 210 | "responses": { 211 | "200": { 212 | "description": "Status 200" 213 | }, 214 | "404": { 215 | "description": "Tried to get an unknown resource\n" 216 | }, 217 | "410": { 218 | "description": "Tried to get a deleted resource\n" 219 | }, 220 | "422": { 221 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 222 | } 223 | } 224 | }, 225 | "put": { 226 | "description": "Update an existing instance\n", 227 | "operationId": "PUT /Patient/{id}", 228 | "consumes": [ 229 | "application/json+fhir", 230 | "application/xml+fhir" 231 | ], 232 | "produces": [ 233 | "application/json+fhir", 234 | "application/xml+fhir" 235 | ], 236 | "parameters": [ 237 | { 238 | "required": true, 239 | "in": "path", 240 | "name": "id", 241 | "type": "string" 242 | } 243 | ], 244 | "responses": { 245 | "200": { 246 | "description": "Succesfully updated the instance \n" 247 | }, 248 | "201": { 249 | "description": "Succesfully created the instance \n" 250 | }, 251 | "400": { 252 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 253 | }, 254 | "404": { 255 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 256 | }, 257 | "405": { 258 | "description": "Method Not allowed - the resource did not exist prior to the update, and the server does not allow client defined ids\n" 259 | }, 260 | "409": { 261 | "description": "Version conflict management\n" 262 | }, 263 | "412": { 264 | "description": "Version conflict management\n" 265 | }, 266 | "422": { 267 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 268 | } 269 | } 270 | }, 271 | "delete": { 272 | "description": "Delete resource\n", 273 | "operationId": "DELETE /Patient/{id}", 274 | "produces": [ 275 | "application/json+fhir", 276 | "application/xml+fhir" 277 | ], 278 | "parameters": [ 279 | { 280 | "required": true, 281 | "in": "path", 282 | "name": "id", 283 | "type": "string" 284 | } 285 | ], 286 | "responses": { 287 | "204": { 288 | "description": "Succesfully deleted resource\n" 289 | }, 290 | "404": { 291 | "description": "Not Found - resource was not found\n" 292 | }, 293 | "405": { 294 | "description": "Method Not allowed - delete is not allowed\n" 295 | } 296 | } 297 | } 298 | }, 299 | "/Patient/_search": { 300 | "get": { 301 | "description": "", 302 | "operationId": "GET /Patient/_search", 303 | "produces": [ 304 | "application/atom+xml", 305 | "application/json+fhir" 306 | ], 307 | "responses": { 308 | "200": { 309 | "description": "Status 200" 310 | } 311 | } 312 | } 313 | }, 314 | "/Patient/{id}/_history/{vid}/_tags": { 315 | "get": { 316 | "description": "get a list of tags used for the nominated version of the resource. This duplicates the HTTP header entries.\n", 317 | "operationId": "GET /Patient/{id}/_history/{vid}/_tags", 318 | "produces": [ 319 | "application/json+fhir", 320 | "application/xml+fhir" 321 | ], 322 | "parameters": [ 323 | { 324 | "required": true, 325 | "in": "path", 326 | "name": "vid", 327 | "type": "string" 328 | }, 329 | { 330 | "required": true, 331 | "in": "path", 332 | "name": "id", 333 | "type": "string" 334 | } 335 | ], 336 | "responses": { 337 | "200": { 338 | "description": "Succesfully retrieved resource\n" 339 | } 340 | } 341 | }, 342 | "post": { 343 | "description": "Affix tags in the list to the nominated verion of the resource\n", 344 | "operationId": "POST /Patient/{id}/_history/{vid}/_tags", 345 | "consumes": [ 346 | "application/json+fhir", 347 | "application/xml+fhir" 348 | ], 349 | "produces": [ 350 | "application/json+fhir", 351 | "application/xml+fhir" 352 | ], 353 | "parameters": [ 354 | { 355 | "required": true, 356 | "in": "path", 357 | "name": "vid", 358 | "type": "string" 359 | }, 360 | { 361 | "required": true, 362 | "in": "path", 363 | "name": "id", 364 | "type": "string" 365 | } 366 | ], 367 | "responses": { 368 | "201": { 369 | "description": "Succesfully affix tags\n" 370 | } 371 | } 372 | } 373 | }, 374 | "/_tags": { 375 | "get": { 376 | "description": "get a list of all tags\n", 377 | "operationId": "GET /_tags", 378 | "produces": [ 379 | "application/json+fhir", 380 | "application/xml+fhir" 381 | ], 382 | "responses": { 383 | "200": { 384 | "description": "Succesfully retrieved resource\n" 385 | } 386 | } 387 | } 388 | }, 389 | "/": { 390 | "get": { 391 | "description": "Retrieve resource\n", 392 | "operationId": "GET /", 393 | "produces": [ 394 | "application/json+fhir", 395 | "application/xml+fhir" 396 | ], 397 | "responses": { 398 | "200": { 399 | "description": "Succesfully retrieved resource\n" 400 | } 401 | } 402 | }, 403 | "post": { 404 | "description": "Create a new resource\n", 405 | "operationId": "POST /", 406 | "consumes": [ 407 | "application/json" 408 | ], 409 | "produces": [ 410 | "application/json+fhir", 411 | "application/xml+fhir" 412 | ], 413 | "responses": { 414 | "201": { 415 | "description": "Succesfully created a new resource\n" 416 | } 417 | } 418 | } 419 | }, 420 | "/Patient/_validate/{id}": { 421 | "post": { 422 | "description": "Create a new resource\n", 423 | "operationId": "POST /Patient/_validate/{id}", 424 | "consumes": [ 425 | "application/json+fhir", 426 | "application/xml+fhir" 427 | ], 428 | "produces": [ 429 | "application/json+fhir", 430 | "application/xml+fhir" 431 | ], 432 | "parameters": [ 433 | { 434 | "required": true, 435 | "in": "path", 436 | "name": "id", 437 | "type": "string" 438 | } 439 | ], 440 | "responses": { 441 | "201": { 442 | "description": "Validates a type\n" 443 | } 444 | } 445 | } 446 | }, 447 | "/Patient": { 448 | "get": { 449 | "description": "Get Patient", 450 | "operationId": "GET /Patient", 451 | "produces": [ 452 | "application/json+fhir", 453 | "application/xml+fhir" 454 | ], 455 | "responses": { 456 | "200": { 457 | "description": "Status 200" 458 | } 459 | } 460 | }, 461 | "post": { 462 | "description": "Create a new type\n", 463 | "operationId": "POST /Patient", 464 | "consumes": [ 465 | "application/json+fhir", 466 | "application/xml+fhir" 467 | ], 468 | "produces": [ 469 | "application/json+fhir", 470 | "application/xml+fhir" 471 | ], 472 | "responses": { 473 | "201": { 474 | "description": "Succesfully created a new type\n" 475 | }, 476 | "400": { 477 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 478 | }, 479 | "404": { 480 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 481 | } 482 | } 483 | } 484 | }, 485 | "/Patient/_tags": { 486 | "get": { 487 | "description": "get a list of tags used for the nominated resource type\n", 488 | "operationId": "GET /Patient/_tags", 489 | "produces": [ 490 | "application/json+fhir", 491 | "application/xml+fhir" 492 | ], 493 | "responses": { 494 | "200": { 495 | "description": "Succesfully retrieved resource\n" 496 | } 497 | } 498 | } 499 | }, 500 | "/$meta": { 501 | "get": { 502 | "description": "", 503 | "operationId": "GET /$meta", 504 | "responses": { 505 | "200": { 506 | "description": "Successfully retrieved resource(s)\n" 507 | } 508 | } 509 | } 510 | }, 511 | "/_history": { 512 | "get": { 513 | "description": "Whole System History\n", 514 | "operationId": "GET /_history", 515 | "produces": [ 516 | "application/json+fhir", 517 | "application/xml+fhir" 518 | ], 519 | "responses": { 520 | "200": { 521 | "description": "Succesfully retrieved resource\n" 522 | } 523 | } 524 | } 525 | }, 526 | "/Patient/$validate": { 527 | "get": { 528 | "description": "", 529 | "operationId": "GET /Patient/$validate", 530 | "produces": [ 531 | "application/json+fhir", 532 | "application/xml+fhir" 533 | ], 534 | "responses": { 535 | "200": { 536 | "description": "Status 200" 537 | } 538 | } 539 | } 540 | }, 541 | "/Patient/{id}/$everything": { 542 | "get": { 543 | "description": "", 544 | "operationId": "GET /Patient/{id}/$everything", 545 | "produces": [ 546 | "application/json+fhir", 547 | "application/xml+fhir" 548 | ], 549 | "parameters": [ 550 | { 551 | "required": true, 552 | "in": "path", 553 | "name": "id", 554 | "type": "string" 555 | } 556 | ], 557 | "responses": { 558 | "200": { 559 | "description": "Status 200" 560 | } 561 | } 562 | } 563 | }, 564 | "/Patient/_history": { 565 | "get": { 566 | "description": "", 567 | "operationId": "GET /Patient/_history", 568 | "produces": [ 569 | "application/atom+xml", 570 | "application/json+fhir" 571 | ], 572 | "responses": { 573 | "200": { 574 | "description": "Status 200" 575 | } 576 | } 577 | } 578 | }, 579 | "/Patient/{id}/_history": { 580 | "get": { 581 | "description": "", 582 | "operationId": "GET /Patient/{id}/_history", 583 | "produces": [ 584 | "application/json+fhir", 585 | "application/xml+fhir" 586 | ], 587 | "parameters": [ 588 | { 589 | "required": true, 590 | "in": "path", 591 | "name": "id", 592 | "type": "string" 593 | } 594 | ], 595 | "responses": { 596 | "200": { 597 | "description": "Status 200" 598 | } 599 | } 600 | } 601 | } 602 | }, 603 | "info": { 604 | "title": "FHIR Patient", 605 | "description": "Demographics and other administrative information about an individual or animal receiving care or other health-related services. For more information: https://www.hl7.org/fhir/patient.html", 606 | "version": "2" 607 | }, 608 | "x-axway": { 609 | "corsEnabled": true, 610 | "basePaths": [ 611 | "" 612 | ], 613 | "serviceType": "rest", 614 | "deprecated": false, 615 | "tags" : { 616 | "Group" : [ "FHIR", " Identification", " Individuals" ] 617 | } 618 | } 619 | } -------------------------------------------------------------------------------- /src/FHIRPractitioner.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "host": "fhir3.healthintersections.com.au/open", 4 | "basePath": "/", 5 | "schemes": [ 6 | "http" 7 | ], 8 | "paths": { 9 | "/Practitioner/{id}/_tags": { 10 | "get": { 11 | "description": "get a list of tags used for the nominated resource. This duplicates the HTTP header entries\n", 12 | "operationId": "GET /Practitioner/{id}/_tags", 13 | "produces": [ 14 | "application/json+fhir", 15 | "application/xml+fhir" 16 | ], 17 | "parameters": [ 18 | { 19 | "required": true, 20 | "in": "path", 21 | "name": "id", 22 | "type": "string" 23 | } 24 | ], 25 | "responses": { 26 | "200": { 27 | "description": "Succesfully retrieved resource\n" 28 | } 29 | } 30 | }, 31 | "post": { 32 | "description": "Affix tags in the list to the nominated resource\n", 33 | "operationId": "POST /Practitioner/{id}/_tags", 34 | "consumes": [ 35 | "application/json" 36 | ], 37 | "produces": [ 38 | "application/json+fhir", 39 | "application/xml+fhir" 40 | ], 41 | "parameters": [ 42 | { 43 | "required": true, 44 | "in": "path", 45 | "name": "id", 46 | "type": "string" 47 | } 48 | ], 49 | "responses": { 50 | "201": { 51 | "description": "Succesfully affix tags\n" 52 | } 53 | } 54 | } 55 | }, 56 | "/Practitioner/{id}/_history/{vid}/_tags/_delete": { 57 | "post": { 58 | "description": "Removes all tags in the provided list of tags for the nominated version of the resource\n", 59 | "operationId": "POST /Practitioner/{id}/_history/{vid}/_tags/_delete", 60 | "consumes": [ 61 | "application/json+fhir", 62 | "application/xml+fhir" 63 | ], 64 | "produces": [ 65 | "application/json+fhir", 66 | "application/xml+fhir" 67 | ], 68 | "parameters": [ 69 | { 70 | "required": true, 71 | "in": "path", 72 | "name": "vid", 73 | "type": "string" 74 | }, 75 | { 76 | "required": true, 77 | "in": "path", 78 | "name": "id", 79 | "type": "string" 80 | } 81 | ], 82 | "responses": { 83 | "204": { 84 | "description": "Successful deletion of tags" 85 | } 86 | } 87 | } 88 | }, 89 | "/Practitioner/{id}/_tags/_delete": { 90 | "post": { 91 | "description": "Removes all tags in the provided list of tags for the nominated resource\n", 92 | "operationId": "POST /Practitioner/{id}/_tags/_delete", 93 | "consumes": [ 94 | "application/json+fhir", 95 | "application/xml+fhir" 96 | ], 97 | "produces": [ 98 | "application/json+fhir", 99 | "application/xml+fhir" 100 | ], 101 | "parameters": [ 102 | { 103 | "required": true, 104 | "in": "path", 105 | "name": "id", 106 | "type": "string" 107 | } 108 | ], 109 | "responses": { 110 | "204": { 111 | "description": "Status 204" 112 | } 113 | } 114 | } 115 | }, 116 | "/metadata": { 117 | "get": { 118 | "description": "Retrieve resource\n", 119 | "operationId": "GET /metadata", 120 | "produces": [ 121 | "application/json+fhir", 122 | "application/xml+fhir" 123 | ], 124 | "responses": { 125 | "200": { 126 | "description": "Succesfully retrieved resource\n" 127 | } 128 | } 129 | } 130 | }, 131 | "/Practitioner/$meta": { 132 | "get": { 133 | "description": "", 134 | "operationId": "GET /Practitioner/$meta", 135 | "responses": { 136 | "200": { 137 | "description": "Successfully retrieved resource(s)\n" 138 | } 139 | } 140 | } 141 | }, 142 | "/Practitioner/{id}/$validate": { 143 | "get": { 144 | "description": "", 145 | "operationId": "GET /Practitioner/{id}/$validate", 146 | "produces": [ 147 | "application/json+fhir", 148 | "application/xml+fhir" 149 | ], 150 | "parameters": [ 151 | { 152 | "required": true, 153 | "in": "path", 154 | "name": "id", 155 | "type": "string" 156 | } 157 | ], 158 | "responses": { 159 | "200": { 160 | "description": "Status 200" 161 | } 162 | } 163 | } 164 | }, 165 | "/Practitioner/{id}/_history/{vid}": { 166 | "get": { 167 | "description": "", 168 | "operationId": "GET /Practitioner/{id}/_history/{vid}", 169 | "produces": [ 170 | "application/json+fhir", 171 | "application/xml+fhir" 172 | ], 173 | "parameters": [ 174 | { 175 | "required": true, 176 | "in": "path", 177 | "name": "vid", 178 | "type": "string" 179 | }, 180 | { 181 | "required": true, 182 | "in": "path", 183 | "name": "id", 184 | "type": "string" 185 | } 186 | ], 187 | "responses": { 188 | "200": { 189 | "description": "Status 200" 190 | } 191 | } 192 | } 193 | }, 194 | "/Practitioner/{id}": { 195 | "get": { 196 | "description": "", 197 | "operationId": "GET /Practitioner/{id}", 198 | "produces": [ 199 | "application/json+fhir", 200 | "application/xml+fhir" 201 | ], 202 | "parameters": [ 203 | { 204 | "required": true, 205 | "in": "path", 206 | "name": "id", 207 | "type": "string" 208 | } 209 | ], 210 | "responses": { 211 | "200": { 212 | "description": "Status 200" 213 | }, 214 | "404": { 215 | "description": "Tried to get an unknown resource\n" 216 | }, 217 | "410": { 218 | "description": "Tried to get a deleted resource\n" 219 | }, 220 | "422": { 221 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 222 | } 223 | } 224 | }, 225 | "put": { 226 | "description": "Update an existing instance\n", 227 | "operationId": "PUT /Practitioner/{id}", 228 | "consumes": [ 229 | "application/json+fhir", 230 | "application/xml+fhir" 231 | ], 232 | "produces": [ 233 | "application/json+fhir", 234 | "application/xml+fhir" 235 | ], 236 | "parameters": [ 237 | { 238 | "required": true, 239 | "in": "path", 240 | "name": "id", 241 | "type": "string" 242 | } 243 | ], 244 | "responses": { 245 | "200": { 246 | "description": "Succesfully updated the instance \n" 247 | }, 248 | "201": { 249 | "description": "Succesfully created the instance \n" 250 | }, 251 | "400": { 252 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 253 | }, 254 | "404": { 255 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 256 | }, 257 | "405": { 258 | "description": "Method Not allowed - the resource did not exist prior to the update, and the server does not allow client defined ids\n" 259 | }, 260 | "409": { 261 | "description": "Version conflict management\n" 262 | }, 263 | "412": { 264 | "description": "Version conflict management\n" 265 | }, 266 | "422": { 267 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 268 | } 269 | } 270 | }, 271 | "delete": { 272 | "description": "Delete resource\n", 273 | "operationId": "DELETE /Practitioner/{id}", 274 | "produces": [ 275 | "application/json+fhir", 276 | "application/xml+fhir" 277 | ], 278 | "parameters": [ 279 | { 280 | "required": true, 281 | "in": "path", 282 | "name": "id", 283 | "type": "string" 284 | } 285 | ], 286 | "responses": { 287 | "204": { 288 | "description": "Succesfully deleted resource\n" 289 | }, 290 | "404": { 291 | "description": "Not Found - resource was not found\n" 292 | }, 293 | "405": { 294 | "description": "Method Not allowed - delete is not allowed\n" 295 | } 296 | } 297 | } 298 | }, 299 | "/Practitioner/_search": { 300 | "get": { 301 | "description": "", 302 | "operationId": "GET /Practitioner/_search", 303 | "produces": [ 304 | "application/atom+xml", 305 | "application/json+fhir" 306 | ], 307 | "responses": { 308 | "200": { 309 | "description": "Status 200" 310 | } 311 | } 312 | } 313 | }, 314 | "/Practitioner/{id}/_history/{vid}/_tags": { 315 | "get": { 316 | "description": "get a list of tags used for the nominated version of the resource. This duplicates the HTTP header entries.\n", 317 | "operationId": "GET /Practitioner/{id}/_history/{vid}/_tags", 318 | "produces": [ 319 | "application/json+fhir", 320 | "application/xml+fhir" 321 | ], 322 | "parameters": [ 323 | { 324 | "required": true, 325 | "in": "path", 326 | "name": "vid", 327 | "type": "string" 328 | }, 329 | { 330 | "required": true, 331 | "in": "path", 332 | "name": "id", 333 | "type": "string" 334 | } 335 | ], 336 | "responses": { 337 | "200": { 338 | "description": "Succesfully retrieved resource\n" 339 | } 340 | } 341 | }, 342 | "post": { 343 | "description": "Affix tags in the list to the nominated verion of the resource\n", 344 | "operationId": "POST /Practitioner/{id}/_history/{vid}/_tags", 345 | "consumes": [ 346 | "application/json+fhir", 347 | "application/xml+fhir" 348 | ], 349 | "produces": [ 350 | "application/json+fhir", 351 | "application/xml+fhir" 352 | ], 353 | "parameters": [ 354 | { 355 | "required": true, 356 | "in": "path", 357 | "name": "vid", 358 | "type": "string" 359 | }, 360 | { 361 | "required": true, 362 | "in": "path", 363 | "name": "id", 364 | "type": "string" 365 | } 366 | ], 367 | "responses": { 368 | "201": { 369 | "description": "Succesfully affix tags\n" 370 | } 371 | } 372 | } 373 | }, 374 | "/_tags": { 375 | "get": { 376 | "description": "get a list of all tags\n", 377 | "operationId": "GET /_tags", 378 | "produces": [ 379 | "application/json+fhir", 380 | "application/xml+fhir" 381 | ], 382 | "responses": { 383 | "200": { 384 | "description": "Succesfully retrieved resource\n" 385 | } 386 | } 387 | } 388 | }, 389 | "/": { 390 | "get": { 391 | "description": "Retrieve resource\n", 392 | "operationId": "GET /", 393 | "produces": [ 394 | "application/json+fhir", 395 | "application/xml+fhir" 396 | ], 397 | "responses": { 398 | "200": { 399 | "description": "Succesfully retrieved resource\n" 400 | } 401 | } 402 | }, 403 | "post": { 404 | "description": "Create a new resource\n", 405 | "operationId": "POST /", 406 | "consumes": [ 407 | "application/json" 408 | ], 409 | "produces": [ 410 | "application/json+fhir", 411 | "application/xml+fhir" 412 | ], 413 | "responses": { 414 | "201": { 415 | "description": "Succesfully created a new resource\n" 416 | } 417 | } 418 | } 419 | }, 420 | "/Practitioner/_validate/{id}": { 421 | "post": { 422 | "description": "Create a new resource\n", 423 | "operationId": "POST /Practitioner/_validate/{id}", 424 | "consumes": [ 425 | "application/json+fhir", 426 | "application/xml+fhir" 427 | ], 428 | "produces": [ 429 | "application/json+fhir", 430 | "application/xml+fhir" 431 | ], 432 | "parameters": [ 433 | { 434 | "required": true, 435 | "in": "path", 436 | "name": "id", 437 | "type": "string" 438 | } 439 | ], 440 | "responses": { 441 | "201": { 442 | "description": "Validates a type\n" 443 | } 444 | } 445 | } 446 | }, 447 | "/Practitioner": { 448 | "get": { 449 | "description": "Get Practitioner", 450 | "operationId": "GET /Practitioner", 451 | "produces": [ 452 | "application/json+fhir", 453 | "application/xml+fhir" 454 | ], 455 | "responses": { 456 | "200": { 457 | "description": "Status 200" 458 | } 459 | } 460 | }, 461 | "post": { 462 | "description": "Create a new type\n", 463 | "operationId": "POST /Practitioner", 464 | "consumes": [ 465 | "application/json+fhir", 466 | "application/xml+fhir" 467 | ], 468 | "produces": [ 469 | "application/json+fhir", 470 | "application/xml+fhir" 471 | ], 472 | "responses": { 473 | "201": { 474 | "description": "Succesfully created a new type\n" 475 | }, 476 | "400": { 477 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 478 | }, 479 | "404": { 480 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 481 | } 482 | } 483 | } 484 | }, 485 | "/Practitioner/_tags": { 486 | "get": { 487 | "description": "get a list of tags used for the nominated resource type\n", 488 | "operationId": "GET /Practitioner/_tags", 489 | "produces": [ 490 | "application/json+fhir", 491 | "application/xml+fhir" 492 | ], 493 | "responses": { 494 | "200": { 495 | "description": "Succesfully retrieved resource\n" 496 | } 497 | } 498 | } 499 | }, 500 | "/$meta": { 501 | "get": { 502 | "description": "", 503 | "operationId": "GET /$meta", 504 | "responses": { 505 | "200": { 506 | "description": "Successfully retrieved resource(s)\n" 507 | } 508 | } 509 | } 510 | }, 511 | "/_history": { 512 | "get": { 513 | "description": "Whole System History\n", 514 | "operationId": "GET /_history", 515 | "produces": [ 516 | "application/json+fhir", 517 | "application/xml+fhir" 518 | ], 519 | "responses": { 520 | "200": { 521 | "description": "Succesfully retrieved resource\n" 522 | } 523 | } 524 | } 525 | }, 526 | "/Practitioner/$validate": { 527 | "get": { 528 | "description": "", 529 | "operationId": "GET /Practitioner/$validate", 530 | "produces": [ 531 | "application/json+fhir", 532 | "application/xml+fhir" 533 | ], 534 | "responses": { 535 | "200": { 536 | "description": "Status 200" 537 | } 538 | } 539 | } 540 | }, 541 | "/Practitioner/{id}/$everything": { 542 | "get": { 543 | "description": "", 544 | "operationId": "GET /Practitioner/{id}/$everything", 545 | "produces": [ 546 | "application/json+fhir", 547 | "application/xml+fhir" 548 | ], 549 | "parameters": [ 550 | { 551 | "required": true, 552 | "in": "path", 553 | "name": "id", 554 | "type": "string" 555 | } 556 | ], 557 | "responses": { 558 | "200": { 559 | "description": "Status 200" 560 | } 561 | } 562 | } 563 | }, 564 | "/Practitioner/_history": { 565 | "get": { 566 | "description": "", 567 | "operationId": "GET /Practitioner/_history", 568 | "produces": [ 569 | "application/atom+xml", 570 | "application/json+fhir" 571 | ], 572 | "responses": { 573 | "200": { 574 | "description": "Status 200" 575 | } 576 | } 577 | } 578 | }, 579 | "/Practitioner/{id}/_history": { 580 | "get": { 581 | "description": "", 582 | "operationId": "GET /Practitioner/{id}/_history", 583 | "produces": [ 584 | "application/json+fhir", 585 | "application/xml+fhir" 586 | ], 587 | "parameters": [ 588 | { 589 | "required": true, 590 | "in": "path", 591 | "name": "id", 592 | "type": "string" 593 | } 594 | ], 595 | "responses": { 596 | "200": { 597 | "description": "Status 200" 598 | } 599 | } 600 | } 601 | } 602 | }, 603 | "info": { 604 | "title": "FHIR Practitioner", 605 | "description": "A person who is directly or indirectly involved in the provisioning of healthcare. For more information: https://www.hl7.org/fhir/practitioner.html", 606 | "version": "2" 607 | }, 608 | "x-axway": { 609 | "corsEnabled": true, 610 | "basePaths": [ 611 | "" 612 | ], 613 | "serviceType": "rest", 614 | "deprecated": false, 615 | "tags" : { 616 | "Group" : [ "FHIR", " Identification", " Individuals" ] 617 | } 618 | } 619 | } -------------------------------------------------------------------------------- /src/FHIRProcedure.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "host": "fhir3.healthintersections.com.au/open", 4 | "basePath": "/", 5 | "schemes": [ 6 | "http" 7 | ], 8 | "paths": { 9 | "/Procedure/{id}/_tags": { 10 | "get": { 11 | "description": "get a list of tags used for the nominated resource. This duplicates the HTTP header entries\n", 12 | "operationId": "GET /Procedure/{id}/_tags", 13 | "produces": [ 14 | "application/json+fhir", 15 | "application/xml+fhir" 16 | ], 17 | "parameters": [ 18 | { 19 | "required": true, 20 | "in": "path", 21 | "name": "id", 22 | "type": "string" 23 | } 24 | ], 25 | "responses": { 26 | "200": { 27 | "description": "Succesfully retrieved resource\n" 28 | } 29 | } 30 | }, 31 | "post": { 32 | "description": "Affix tags in the list to the nominated resource\n", 33 | "operationId": "POST /Procedure/{id}/_tags", 34 | "consumes": [ 35 | "application/json" 36 | ], 37 | "produces": [ 38 | "application/json+fhir", 39 | "application/xml+fhir" 40 | ], 41 | "parameters": [ 42 | { 43 | "required": true, 44 | "in": "path", 45 | "name": "id", 46 | "type": "string" 47 | } 48 | ], 49 | "responses": { 50 | "201": { 51 | "description": "Succesfully affix tags\n" 52 | } 53 | } 54 | } 55 | }, 56 | "/Procedure/{id}/_history/{vid}/_tags/_delete": { 57 | "post": { 58 | "description": "Removes all tags in the provided list of tags for the nominated version of the resource\n", 59 | "operationId": "POST /Procedure/{id}/_history/{vid}/_tags/_delete", 60 | "consumes": [ 61 | "application/json+fhir", 62 | "application/xml+fhir" 63 | ], 64 | "produces": [ 65 | "application/json+fhir", 66 | "application/xml+fhir" 67 | ], 68 | "parameters": [ 69 | { 70 | "required": true, 71 | "in": "path", 72 | "name": "vid", 73 | "type": "string" 74 | }, 75 | { 76 | "required": true, 77 | "in": "path", 78 | "name": "id", 79 | "type": "string" 80 | } 81 | ], 82 | "responses": { 83 | "204": { 84 | "description": "Successful deletion of tags" 85 | } 86 | } 87 | } 88 | }, 89 | "/Procedure/{id}/_tags/_delete": { 90 | "post": { 91 | "description": "Removes all tags in the provided list of tags for the nominated resource\n", 92 | "operationId": "POST /Procedure/{id}/_tags/_delete", 93 | "consumes": [ 94 | "application/json+fhir", 95 | "application/xml+fhir" 96 | ], 97 | "produces": [ 98 | "application/json+fhir", 99 | "application/xml+fhir" 100 | ], 101 | "parameters": [ 102 | { 103 | "required": true, 104 | "in": "path", 105 | "name": "id", 106 | "type": "string" 107 | } 108 | ], 109 | "responses": { 110 | "204": { 111 | "description": "Status 204" 112 | } 113 | } 114 | } 115 | }, 116 | "/metadata": { 117 | "get": { 118 | "description": "Retrieve resource\n", 119 | "operationId": "GET /metadata", 120 | "produces": [ 121 | "application/json+fhir", 122 | "application/xml+fhir" 123 | ], 124 | "responses": { 125 | "200": { 126 | "description": "Succesfully retrieved resource\n" 127 | } 128 | } 129 | } 130 | }, 131 | "/Procedure/$meta": { 132 | "get": { 133 | "description": "", 134 | "operationId": "GET /Procedure/$meta", 135 | "responses": { 136 | "200": { 137 | "description": "Successfully retrieved resource(s)\n" 138 | } 139 | } 140 | } 141 | }, 142 | "/Procedure/{id}/$validate": { 143 | "get": { 144 | "description": "", 145 | "operationId": "GET /Procedure/{id}/$validate", 146 | "produces": [ 147 | "application/json+fhir", 148 | "application/xml+fhir" 149 | ], 150 | "parameters": [ 151 | { 152 | "required": true, 153 | "in": "path", 154 | "name": "id", 155 | "type": "string" 156 | } 157 | ], 158 | "responses": { 159 | "200": { 160 | "description": "Status 200" 161 | } 162 | } 163 | } 164 | }, 165 | "/Procedure/{id}/_history/{vid}": { 166 | "get": { 167 | "description": "", 168 | "operationId": "GET /Procedure/{id}/_history/{vid}", 169 | "produces": [ 170 | "application/json+fhir", 171 | "application/xml+fhir" 172 | ], 173 | "parameters": [ 174 | { 175 | "required": true, 176 | "in": "path", 177 | "name": "vid", 178 | "type": "string" 179 | }, 180 | { 181 | "required": true, 182 | "in": "path", 183 | "name": "id", 184 | "type": "string" 185 | } 186 | ], 187 | "responses": { 188 | "200": { 189 | "description": "Status 200" 190 | } 191 | } 192 | } 193 | }, 194 | "/Procedure/{id}": { 195 | "get": { 196 | "description": "", 197 | "operationId": "GET /Procedure/{id}", 198 | "produces": [ 199 | "application/json+fhir", 200 | "application/xml+fhir" 201 | ], 202 | "parameters": [ 203 | { 204 | "required": true, 205 | "in": "path", 206 | "name": "id", 207 | "type": "string" 208 | } 209 | ], 210 | "responses": { 211 | "200": { 212 | "description": "Status 200" 213 | }, 214 | "404": { 215 | "description": "Tried to get an unknown resource\n" 216 | }, 217 | "410": { 218 | "description": "Tried to get a deleted resource\n" 219 | }, 220 | "422": { 221 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 222 | } 223 | } 224 | }, 225 | "put": { 226 | "description": "Update an existing instance\n", 227 | "operationId": "PUT /Procedure/{id}", 228 | "consumes": [ 229 | "application/json+fhir", 230 | "application/xml+fhir" 231 | ], 232 | "produces": [ 233 | "application/json+fhir", 234 | "application/xml+fhir" 235 | ], 236 | "parameters": [ 237 | { 238 | "required": true, 239 | "in": "path", 240 | "name": "id", 241 | "type": "string" 242 | } 243 | ], 244 | "responses": { 245 | "200": { 246 | "description": "Succesfully updated the instance \n" 247 | }, 248 | "201": { 249 | "description": "Succesfully created the instance \n" 250 | }, 251 | "400": { 252 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 253 | }, 254 | "404": { 255 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 256 | }, 257 | "405": { 258 | "description": "Method Not allowed - the resource did not exist prior to the update, and the server does not allow client defined ids\n" 259 | }, 260 | "409": { 261 | "description": "Version conflict management\n" 262 | }, 263 | "412": { 264 | "description": "Version conflict management\n" 265 | }, 266 | "422": { 267 | "description": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.\n" 268 | } 269 | } 270 | }, 271 | "delete": { 272 | "description": "Delete resource\n", 273 | "operationId": "DELETE /Procedure/{id}", 274 | "produces": [ 275 | "application/json+fhir", 276 | "application/xml+fhir" 277 | ], 278 | "parameters": [ 279 | { 280 | "required": true, 281 | "in": "path", 282 | "name": "id", 283 | "type": "string" 284 | } 285 | ], 286 | "responses": { 287 | "204": { 288 | "description": "Succesfully deleted resource\n" 289 | }, 290 | "404": { 291 | "description": "Not Found - resource was not found\n" 292 | }, 293 | "405": { 294 | "description": "Method Not allowed - delete is not allowed\n" 295 | } 296 | } 297 | } 298 | }, 299 | "/Procedure/_search": { 300 | "get": { 301 | "description": "", 302 | "operationId": "GET /Procedure/_search", 303 | "produces": [ 304 | "application/atom+xml", 305 | "application/json+fhir" 306 | ], 307 | "responses": { 308 | "200": { 309 | "description": "Status 200" 310 | } 311 | } 312 | } 313 | }, 314 | "/Procedure/{id}/_history/{vid}/_tags": { 315 | "get": { 316 | "description": "get a list of tags used for the nominated version of the resource. This duplicates the HTTP header entries.\n", 317 | "operationId": "GET /Procedure/{id}/_history/{vid}/_tags", 318 | "produces": [ 319 | "application/json+fhir", 320 | "application/xml+fhir" 321 | ], 322 | "parameters": [ 323 | { 324 | "required": true, 325 | "in": "path", 326 | "name": "vid", 327 | "type": "string" 328 | }, 329 | { 330 | "required": true, 331 | "in": "path", 332 | "name": "id", 333 | "type": "string" 334 | } 335 | ], 336 | "responses": { 337 | "200": { 338 | "description": "Succesfully retrieved resource\n" 339 | } 340 | } 341 | }, 342 | "post": { 343 | "description": "Affix tags in the list to the nominated verion of the resource\n", 344 | "operationId": "POST /Procedure/{id}/_history/{vid}/_tags", 345 | "consumes": [ 346 | "application/json+fhir", 347 | "application/xml+fhir" 348 | ], 349 | "produces": [ 350 | "application/json+fhir", 351 | "application/xml+fhir" 352 | ], 353 | "parameters": [ 354 | { 355 | "required": true, 356 | "in": "path", 357 | "name": "vid", 358 | "type": "string" 359 | }, 360 | { 361 | "required": true, 362 | "in": "path", 363 | "name": "id", 364 | "type": "string" 365 | } 366 | ], 367 | "responses": { 368 | "201": { 369 | "description": "Succesfully affix tags\n" 370 | } 371 | } 372 | } 373 | }, 374 | "/_tags": { 375 | "get": { 376 | "description": "get a list of all tags\n", 377 | "operationId": "GET /_tags", 378 | "produces": [ 379 | "application/json+fhir", 380 | "application/xml+fhir" 381 | ], 382 | "responses": { 383 | "200": { 384 | "description": "Succesfully retrieved resource\n" 385 | } 386 | } 387 | } 388 | }, 389 | "/": { 390 | "get": { 391 | "description": "Retrieve resource\n", 392 | "operationId": "GET /", 393 | "produces": [ 394 | "application/json+fhir", 395 | "application/xml+fhir" 396 | ], 397 | "responses": { 398 | "200": { 399 | "description": "Succesfully retrieved resource\n" 400 | } 401 | } 402 | }, 403 | "post": { 404 | "description": "Create a new resource\n", 405 | "operationId": "POST /", 406 | "consumes": [ 407 | "application/json" 408 | ], 409 | "produces": [ 410 | "application/json+fhir", 411 | "application/xml+fhir" 412 | ], 413 | "responses": { 414 | "201": { 415 | "description": "Succesfully created a new resource\n" 416 | } 417 | } 418 | } 419 | }, 420 | "/Procedure/_validate/{id}": { 421 | "post": { 422 | "description": "Create a new resource\n", 423 | "operationId": "POST /Procedure/_validate/{id}", 424 | "consumes": [ 425 | "application/json+fhir", 426 | "application/xml+fhir" 427 | ], 428 | "produces": [ 429 | "application/json+fhir", 430 | "application/xml+fhir" 431 | ], 432 | "parameters": [ 433 | { 434 | "required": true, 435 | "in": "path", 436 | "name": "id", 437 | "type": "string" 438 | } 439 | ], 440 | "responses": { 441 | "201": { 442 | "description": "Validates a type\n" 443 | } 444 | } 445 | } 446 | }, 447 | "/Procedure": { 448 | "get": { 449 | "description": "Get Procedure", 450 | "operationId": "GET /Procedure", 451 | "produces": [ 452 | "application/json+fhir", 453 | "application/xml+fhir" 454 | ], 455 | "responses": { 456 | "200": { 457 | "description": "Status 200" 458 | } 459 | } 460 | }, 461 | "post": { 462 | "description": "Create a new type\n", 463 | "operationId": "POST /Procedure", 464 | "consumes": [ 465 | "application/json+fhir", 466 | "application/xml+fhir" 467 | ], 468 | "produces": [ 469 | "application/json+fhir", 470 | "application/xml+fhir" 471 | ], 472 | "responses": { 473 | "201": { 474 | "description": "Succesfully created a new type\n" 475 | }, 476 | "400": { 477 | "description": "Bad Request - Resource cound not be parsed or failed basic FHIR validation rules\n" 478 | }, 479 | "404": { 480 | "description": "Not Found - resource type not support, or not a FHIR validation rules\n" 481 | } 482 | } 483 | } 484 | }, 485 | "/Procedure/_tags": { 486 | "get": { 487 | "description": "get a list of tags used for the nominated resource type\n", 488 | "operationId": "GET /Procedure/_tags", 489 | "produces": [ 490 | "application/json+fhir", 491 | "application/xml+fhir" 492 | ], 493 | "responses": { 494 | "200": { 495 | "description": "Succesfully retrieved resource\n" 496 | } 497 | } 498 | } 499 | }, 500 | "/$meta": { 501 | "get": { 502 | "description": "", 503 | "operationId": "GET /$meta", 504 | "responses": { 505 | "200": { 506 | "description": "Successfully retrieved resource(s)\n" 507 | } 508 | } 509 | } 510 | }, 511 | "/_history": { 512 | "get": { 513 | "description": "Whole System History\n", 514 | "operationId": "GET /_history", 515 | "produces": [ 516 | "application/json+fhir", 517 | "application/xml+fhir" 518 | ], 519 | "responses": { 520 | "200": { 521 | "description": "Succesfully retrieved resource\n" 522 | } 523 | } 524 | } 525 | }, 526 | "/Procedure/$validate": { 527 | "get": { 528 | "description": "", 529 | "operationId": "GET /Procedure/$validate", 530 | "produces": [ 531 | "application/json+fhir", 532 | "application/xml+fhir" 533 | ], 534 | "responses": { 535 | "200": { 536 | "description": "Status 200" 537 | } 538 | } 539 | } 540 | }, 541 | "/Procedure/{id}/$everything": { 542 | "get": { 543 | "description": "", 544 | "operationId": "GET /Procedure/{id}/$everything", 545 | "produces": [ 546 | "application/json+fhir", 547 | "application/xml+fhir" 548 | ], 549 | "parameters": [ 550 | { 551 | "required": true, 552 | "in": "path", 553 | "name": "id", 554 | "type": "string" 555 | } 556 | ], 557 | "responses": { 558 | "200": { 559 | "description": "Status 200" 560 | } 561 | } 562 | } 563 | }, 564 | "/Procedure/_history": { 565 | "get": { 566 | "description": "", 567 | "operationId": "GET /Procedure/_history", 568 | "produces": [ 569 | "application/atom+xml", 570 | "application/json+fhir" 571 | ], 572 | "responses": { 573 | "200": { 574 | "description": "Status 200" 575 | } 576 | } 577 | } 578 | }, 579 | "/Procedure/{id}/_history": { 580 | "get": { 581 | "description": "", 582 | "operationId": "GET /Procedure/{id}/_history", 583 | "produces": [ 584 | "application/json+fhir", 585 | "application/xml+fhir" 586 | ], 587 | "parameters": [ 588 | { 589 | "required": true, 590 | "in": "path", 591 | "name": "id", 592 | "type": "string" 593 | } 594 | ], 595 | "responses": { 596 | "200": { 597 | "description": "Status 200" 598 | } 599 | } 600 | } 601 | } 602 | }, 603 | "info": { 604 | "title": "FHIR Procedure", 605 | "description": "An action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy. For more information: https://www.hl7.org/fhir/procedure.html", 606 | "version": "2" 607 | }, 608 | "x-axway": { 609 | "corsEnabled": true, 610 | "basePaths": [ 611 | "" 612 | ], 613 | "serviceType": "rest", 614 | "deprecated": false, 615 | "tags" : { 616 | "Group" : [ "FHIR", " Clinical", " General" ] 617 | } 618 | } 619 | } --------------------------------------------------------------------------------