ZorgOpOrde
/
zoo-api
2
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[build] `npm run bundle` now works properly.

Browse Source
EH/population-statistics-authorisation
Reinier Zwitserloot 3 years ago
parent f09e1fc75d
commit fe0023c56a
No known key found for this signature in database
GPG Key ID: DADEDCAA42950296
9 changed files with 54 additions and 62 deletions
Show Stats Download Patch File Download Diff File

1
.gitignore vendored
Unescape Escape View File

@ -1 +1,2 @@
/zoo-api.html /zoo-api.html
/zoo-api-bundle.yaml

2
package.json
Unescape Escape View File

@ -7,7 +7,7 @@
"private": true, "private": true,
"scripts": { "scripts": {
"start": "npx @redocly/cli@^1.0.0-beta build-docs -o zoo-api.html", "start": "npx @redocly/cli@^1.0.0-beta build-docs -o zoo-api.html",
"bundle": "npx @redocly/cli@^1.0.0-beta bundle -o dist.yaml", "bundle": "npx @redocly/cli@^1.0.0-beta bundle -o zoo-api-bundle.yaml",
"test": "npx @redocly/cli@^1.0.0-beta lint" "test": "npx @redocly/cli@^1.0.0-beta lint"
} }
} }

34
paths/patient_base.yaml
Unescape Escape View File

@ -11,7 +11,7 @@ get:
schema: schema:
type: string type: string
example: 123456789 example: 123456789
- $ref: '#/components/parameters/Authorization' - $ref: '../zoo-api.yaml#/components/parameters/Authorization'
responses: responses:
'200': '200':
description: Basic personal information for the patient is returned. description: Basic personal information for the patient is returned.
@ -30,38 +30,38 @@ get:
- start_date - start_date
properties: properties:
bsn: bsn:
$ref: 'schemas/PatIdentity.yaml#/bsn' $ref: '../schemas/PatIdentity.yaml#/bsn'
name: name:
$ref: 'schemas/PatIdentity.yaml#/name' $ref: '../schemas/PatIdentity.yaml#/name'
gender: gender:
$ref: 'schemas/PatIdentity.yaml#/gender' $ref: '../schemas/PatIdentity.yaml#/gender'
dob: dob:
$ref: 'schemas/PatIdentity.yaml#/dob' $ref: '../schemas/PatIdentity.yaml#/dob'
category: category:
$ref: 'schemas/PatIdentity.yaml#/category' $ref: '../schemas/PatIdentity.yaml#/category'
doctor: doctor:
$ref: 'schemas/PatIdentity.yaml#/doctor' $ref: '../schemas/PatIdentity.yaml#/doctor'
address: address:
$ref: 'schemas/PatIdentity.yaml#/address' $ref: '../schemas/PatIdentity.yaml#/address'
contact: contact:
$ref: 'schemas/PatIdentity.yaml#/contact' $ref: '../schemas/PatIdentity.yaml#/contact'
insurance: insurance:
$ref: 'schemas/PatIdentity.yaml#/insurance' $ref: '../schemas/PatIdentity.yaml#/insurance'
patid: patid:
$ref: 'schemas/PatIdentity.yaml#/patid' $ref: '../schemas/PatIdentity.yaml#/patid'
pat_unid: pat_unid:
$ref: 'schemas/PatIdentity.yaml#/pat_unid' $ref: '../schemas/PatIdentity.yaml#/pat_unid'
start_date: start_date:
$ref: 'schemas/PatIdentity.yaml#/start_date' $ref: '../schemas/PatIdentity.yaml#/start_date'
end_date: end_date:
$ref: 'schemas/PatIdentity.yaml#/end_date' $ref: '../schemas/PatIdentity.yaml#/end_date'
end_reason: end_reason:
$ref: 'schemas/PatIdentity.yaml#/end_reason' $ref: '../schemas/PatIdentity.yaml#/end_reason'
'400': '400':
description: The request is invalid; for example, it doesn't contain the required `BSN` parameter. description: The request is invalid; for example, it doesn't contain the required `BSN` parameter.
'401': '401':
$ref: '#/components/responses/JwtFailure' $ref: '../zoo-api.yaml#/components/responses/JwtFailure'
'403': '403':
description: Indicated practice is known but has not authorized ZOO to share this information with signer. description: Indicated practice is known but has not authorized ZOO to share this information with signer.
'404': '404':
$ref: '#/components/responses/PatNotFound' $ref: '../zoo-api.yaml#/components/responses/PatNotFound'

48
paths/patient_dossier.yaml
Unescape Escape View File

@ -53,16 +53,16 @@ get:
example: diet-dm2 example: diet-dm2
responses: responses:
'400': '400':
$ref: '#/components/responses/ReqFailure' $ref: '../zoo-api.yaml#/components/responses/ReqFailure'
'401': '401':
$ref: '#/components/responses/JwtFailure' $ref: '../zoo-api.yaml#/components/responses/JwtFailure'
'403': '403':
description: |- description: |-
Practice associated with the JWT is known but has not authorized ZOO to share information with signer for the provided purpose. Practice associated with the JWT is known but has not authorized ZOO to share information with signer for the provided purpose.
This error also occurs if the provided purpose isn't a known key. This error also occurs if the provided purpose isn't a known key.
'404': '404':
$ref: '#/components/responses/PatNotFound' $ref: '../zoo-api.yaml#/components/responses/PatNotFound'
'200': '200':
description: |- description: |-
Detailed medical dossier information for the patient is returned. Detailed medical dossier information for the patient is returned.
@ -80,39 +80,39 @@ get:
type: object type: object
properties: properties:
bsn: bsn:
$ref: 'schemas/PatIdentity.yaml#/bsn' $ref: '../schemas/PatIdentity.yaml#/bsn'
name: name:
$ref: 'schemas/PatIdentity.yaml#/name' $ref: '../schemas/PatIdentity.yaml#/name'
gender: gender:
$ref: 'schemas/PatIdentity.yaml#/gender' $ref: '../schemas/PatIdentity.yaml#/gender'
dob: dob:
$ref: 'schemas/PatIdentity.yaml#/dob' $ref: '../schemas/PatIdentity.yaml#/dob'
category: category:
$ref: 'schemas/PatIdentity.yaml#/category' $ref: '../schemas/PatIdentity.yaml#/category'
doctor: doctor:
$ref: 'schemas/PatIdentity.yaml#/doctor' $ref: '../schemas/PatIdentity.yaml#/doctor'
address: address:
$ref: 'schemas/PatIdentity.yaml#/address' $ref: '../schemas/PatIdentity.yaml#/address'
contact: contact:
$ref: 'schemas/PatIdentity.yaml#/contact' $ref: '../schemas/PatIdentity.yaml#/contact'
insurance: insurance:
$ref: 'schemas/PatIdentity.yaml#/insurance' $ref: '../schemas/PatIdentity.yaml#/insurance'
patid: patid:
$ref: 'schemas/PatIdentity.yaml#/patid' $ref: '../schemas/PatIdentity.yaml#/patid'
pat_unid: pat_unid:
$ref: 'schemas/PatIdentity.yaml#/pat_unid' $ref: '../schemas/PatIdentity.yaml#/pat_unid'
start_date: start_date:
$ref: 'schemas/PatIdentity.yaml#/start_date' $ref: '../schemas/PatIdentity.yaml#/start_date'
end_date: end_date:
$ref: 'schemas/PatIdentity.yaml#/end_date' $ref: '../schemas/PatIdentity.yaml#/end_date'
end_reason: end_reason:
$ref: 'schemas/PatIdentity.yaml#/end_reason' $ref: '../schemas/PatIdentity.yaml#/end_reason'
episodes: episodes:
type: array type: array
description: |- description: |-
Lists chronic problems or other diagnosed medical issues (dutch: _behandelingen / episodes / problemen_) based on ICPC1-NL. Lists chronic problems or other diagnosed medical issues (dutch: _behandelingen / episodes / problemen_) based on ICPC1-NL.
items: items:
$ref: 'schemas/med_dossier/Episode.yaml' $ref: '../schemas/med_dossier/Episode.yaml'
measurements: measurements:
type: array type: array
description: |- description: |-
@ -121,7 +121,7 @@ get:
(such as 'responsible for chronic diabetes care: Specialist'), and answers to questionnaires such as 'do you have trouble (such as 'responsible for chronic diabetes care: Specialist'), and answers to questionnaires such as 'do you have trouble
walking up stairs'). walking up stairs').
items: items:
$ref: 'schemas/med_dossier/Measurement.yaml' $ref: '../schemas/med_dossier/Measurement.yaml'
feats: feats:
type: array type: array
description: |- description: |-
@ -130,19 +130,19 @@ get:
* material that is paid separately (such some nitrogen to burn off a wart) * material that is paid separately (such some nitrogen to burn off a wart)
* 'subscription' fees such as the standard subscription fee as well as extras charged for each patient per quarter (dutch: _inschrijf_ en _module_ tarieven). * 'subscription' fees such as the standard subscription fee as well as extras charged for each patient per quarter (dutch: _inschrijf_ en _module_ tarieven).
items: items:
$ref: 'schemas/med_dossier/Feat.yaml' $ref: '../schemas/med_dossier/Feat.yaml'
correspondence: correspondence:
type: array type: array
description: |- description: |-
Lists records of correspondence (excluding correspondence within the GP office and correspondence with the patient themselves). Lists records of correspondence (excluding correspondence within the GP office and correspondence with the patient themselves).
items: items:
$ref: 'schemas/med_dossier/Correspondence.yaml' $ref: '../schemas/med_dossier/Correspondence.yaml'
medications: medications:
type: array type: array
description: |- description: |-
Lists medication, either prescribed, or delivered to the patient (or both, of course). Lists medication, either prescribed, or delivered to the patient (or both, of course).
items: items:
$ref: 'schemas/med_dossier/Medication.yaml' $ref: '../schemas/med_dossier/Medication.yaml'
contraindications: contraindications:
type: array type: array
description: |- description: |-
@ -150,7 +150,7 @@ get:
this patient's information is shown to a practicioner. Generally simply is an alternate take on a list of problems this patient's information is shown to a practicioner. Generally simply is an alternate take on a list of problems
a patient suffers from; specifically issues that may affect unrelated care (such as allergies, mental issues, and so on). a patient suffers from; specifically issues that may affect unrelated care (such as allergies, mental issues, and so on).
items: items:
$ref: 'schemas/med_dossier/Contraindication.yaml' $ref: '../schemas/med_dossier/Contraindication.yaml'
journals: journals:
type: array type: array
description: |- description: |-
@ -158,4 +158,4 @@ get:
patient themselves tells the practicioner (can include verbatim copies of what the patient wrote for text-based telehealth systems), patient themselves tells the practicioner (can include verbatim copies of what the patient wrote for text-based telehealth systems),
as well as explaining in text the conclusions included in a lab report received via mail. as well as explaining in text the conclusions included in a lab report received via mail.
items: items:
$ref: 'schemas/med_dossier/Journal.yaml' $ref: '../schemas/med_dossier/Journal.yaml'

6
paths/qoc_careprogram.yaml
Unescape Escape View File

@ -20,8 +20,8 @@ get:
programs: programs:
type: array type: array
items: items:
$ref: '#/components/schemas/CareProgram' $ref: '../schemas/CareProgram.yaml'
'401': '401':
$ref: '#/components/responses/NoAuth' $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
'403': '403':
$ref: '#/components/responses/NoAccess' $ref: '../zoo-api.yaml/#/components/responses/NoAccess'

4
paths/qoc_careprogram_{careprogramKey}_fave.yaml
Unescape Escape View File

@ -46,6 +46,6 @@ put:
description: Whether this care program should be default-shown or not. description: Whether this care program should be default-shown or not.
type: boolean type: boolean
'401': '401':
$ref: '#/components/responses/NoAuth' $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
'403': '403':
$ref: '#/components/responses/NoAccess' $ref: '../zoo-api.yaml/#/components/responses/NoAccess'

6
paths/qoc_indicatorset_{setKey}.yaml
Unescape Escape View File

@ -31,11 +31,11 @@ get:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/IndicatorSet' $ref: '../schemas/IndicatorSet.yaml'
'401': '401':
$ref: '#/components/responses/NoAuth' $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
'403': '403':
$ref: '#/components/responses/NoAccess' $ref: '../zoo-api.yaml#/components/responses/NoAccess'
'404': '404':
description: The provided `setKey` doesn't refer to a valid program. description: The provided `setKey` doesn't refer to a valid program.

2
schemas/IndicatorSet.yaml
Unescape Escape View File

@ -35,4 +35,4 @@ properties:
items: items:
type: array type: array
items: items:
$ref: '#/components/schemas/Indicator' $ref: 'Indicator.yaml'

13
zoo-api.yaml
Unescape Escape View File

@ -3,6 +3,8 @@ info:
title: Zorg op Orde API title: Zorg op Orde API
description: |- description: |-
Copyright Zorg op Orde – All rights reserved. Copyright Zorg op Orde – All rights reserved.
This documentation is available in <a href="/zoo-api-bundle.yaml">OpenAPI 3.1.0 yaml format</a>.
contact: contact:
name: Zorg op Orde name: Zorg op Orde
email: api@zorgoporde.nl email: api@zorgoporde.nl
@ -49,16 +51,6 @@ paths:
/qoc/indicatorset/{setKey}: /qoc/indicatorset/{setKey}:
$ref: 'paths/qoc_indicatorset_{setKey}.yaml' $ref: 'paths/qoc_indicatorset_{setKey}.yaml'
components: components:
schemas:
IndicatorSet:
$ref: 'schemas/IndicatorSet.yaml'
Indicator:
$ref: 'schemas/Indicator.yaml'
CareProgram:
$ref: 'schemas/CareProgram.yaml'
CareProgramSet:
$ref: 'schemas/CareProgramSet.yaml'
parameters: parameters:
Authorization: Authorization:
name: Authorization name: Authorization
@ -79,7 +71,6 @@ components:
type: string type: string
example: >- example: >-
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraWQiOiJaT08tQVBJLVBLSS1JRCIsImFnYiI6IjAxMDEyMzQ1IiwiaWF0IjoxNTE2MjM5MDIyLCJqdGkiOiJ0MTIzNC01Njc4LUFCQ0QifQ.wTesCfFTq1Mz8z7hUWU6zzKSc3dopWnpeETR7eDzFtc
responses: responses:
ReqFailure: ReqFailure:
description: |- description: |-

Write Preview
Loading…
Cancel
Save