[style] renamed HIS to GPIS

live
Reinier Zwitserloot 1 year ago
parent cc6d785444
commit 4a413d6ac7
No known key found for this signature in database
GPG Key ID: DADEDCAA42950296

@ -1,13 +1,13 @@
get: get:
operationId: exportsAvailable operationId: exportsAvailable
tags: tags:
- HIS exports - GPIS exports
summary: List available exports summary: List available exports
responses: responses:
'200': '200':
description: |- description: |-
Lists all available HIS export snapshots. Lists all available GPIS export snapshots.
A HIS export snapshot contains parts of medical dossier info for a subset of all patients in a GP practice. Exactly which filters are applied, A GPIS export snapshot contains parts of medical dossier info for a subset of all patients in a GP practice. Exactly which filters are applied,
which data is provided, and how it is formatted is arranged between Zorg op Orde and a party using the ZOO API. which data is provided, and how it is formatted is arranged between Zorg op Orde and a party using the ZOO API.
content: content:
application/json: application/json:

@ -1,7 +1,7 @@
get: get:
operationId: exportsDownload operationId: exportsDownload
tags: tags:
- HIS exports - GPIS exports
summary: Download an available export summary: Download an available export
parameters: parameters:
- name: agb - name: agb
@ -20,7 +20,7 @@ get:
responses: responses:
'200': '200':
description: |- description: |-
Fetches the requested HIS export as ZIP file. Fetches the requested GPIS export as ZIP file.
Note that the response will have content type `application/zip` even if the requester's `Accept` header does not indicate this mime type is supported. Note that the response will have content type `application/zip` even if the requester's `Accept` header does not indicate this mime type is supported.
'401': '401':

@ -1,7 +1,7 @@
get: get:
operationId: exportsDownloadPerTable operationId: exportsDownloadPerTable
tags: tags:
- HIS exports - GPIS exports
summary: Download one CSV table from an available export summary: Download one CSV table from an available export
parameters: parameters:
- name: agb - name: agb
@ -27,7 +27,7 @@ get:
responses: responses:
'200': '200':
description: |- description: |-
Fetches the requested table from the HIS export. Fetches the requested table from the GPIS export.
Note that the response will have the content type of the request resource (usually `text/csv`) even if the requester's `Accept` header does not indicate this mime type is supported. Note that the response will have the content type of the request resource (usually `text/csv`) even if the requester's `Accept` header does not indicate this mime type is supported.
'401': '401':

@ -55,7 +55,7 @@ post:
responses: responses:
'200': '200':
description: |- description: |-
BSNs or patIds whose status has actually updated. BSNs or patIds which were not known in the HIS are ignored and not returned here. BSNs or patIds whose status has actually updated. BSNs or patIds which were not known in the GPIS are ignored and not returned here.
The caller should determine the difference between the two sets to get the ignored patients. If a BSN matched more than one patient, all these patients were updated. The caller should determine the difference between the two sets to get the ignored patients. If a BSN matched more than one patient, all these patients were updated.
content: content:
'application/json': 'application/json':

@ -1,5 +1,5 @@
description: |- description: |-
The source of the medical data used to produce this report: which general practitioner information system was used, and when the data was provided. Omitted if no HIS database was imported (yet). The source of the medical data used to produce this report: which general practitioner information system was used, and when the data was provided. Omitted if no GPIS database was imported (yet).
type: object type: object
properties: properties:
gpisType: gpisType:

@ -94,7 +94,7 @@ properties:
cache: cache:
type: boolean type: boolean
description: |- description: |-
If true, the indicator was retrieved from the API cache. The indicator is only retrieved from the cache if there is no recent calculation available in the database and if the indicator won't change anymore. This is the case when it was calculated with a reference date in the past and for which a certain period no new HIS-data is provided. The cached indicator reflects the indicator definition on the reference date. A cached indicator is not updated when the definition changes. If true, the indicator was retrieved from the API cache. The indicator is only retrieved from the cache if there is no recent calculation available in the database and if the indicator won't change anymore. This is the case when it was calculated with a reference date in the past and for which a certain period no new GPIS-data is provided. The cached indicator reflects the indicator definition on the reference date. A cached indicator is not updated when the definition changes.
example: true example: true
required: required:
- group - group

@ -103,5 +103,5 @@ properties:
items: items:
$ref: 'Indicator.yaml' $ref: 'Indicator.yaml'
cache: cache:
description: If true, the indicator set was retrieved from the API cache. The set is only retrieved from the cache if there is no recent calculation available in the database and if the set won't change anymore. This is the case for all indicator sets which were calculated with a reference date in the past and for which a certain period no new HIS-data is provided. The cached indicator set reflects the indicator definitions of the reference date. Cached indicators are not updated with new definitions. description: If true, the indicator set was retrieved from the API cache. The set is only retrieved from the cache if there is no recent calculation available in the database and if the set won't change anymore. This is the case for all indicator sets which were calculated with a reference date in the past and for which a certain period no new GPIS-data is provided. The cached indicator set reflects the indicator definitions of the reference date. Cached indicators are not updated with new definitions.
type: boolean type: boolean

@ -1,5 +1,5 @@
description: |- description: |-
Patient's unique and persistent ID in GPIS. Usually identical to `patid` but certain HISes may Patient's unique and persistent ID in GPIS. Usually identical to `patid` but certain GPISes may
use UUID, or has globally unique keys (e.g. very large numbers). Can be blank, but only use UUID, or has globally unique keys (e.g. very large numbers). Can be blank, but only
if supplying GPIS does not send them. if supplying GPIS does not send them.
type: string type: string

@ -41,9 +41,9 @@ tags:
As well as a 'config' view where they see _all_ care programs that could possibly be relevant for that customer, where the customer can preview the report (essentially, run the report as normal), favourite something they don't get by default, or unfavourite something they get by default. As well as a 'config' view where they see _all_ care programs that could possibly be relevant for that customer, where the customer can preview the report (essentially, run the report as normal), favourite something they don't get by default, or unfavourite something they get by default.
- name: Customer management - name: Customer management
- name: HIS exports - name: GPIS exports
description: |- description: |-
List and download exported parts of HIS dossiers. List and download exported parts of GPIS dossiers.
paths: paths:
/patient/dossier: /patient/dossier:
$ref: 'paths/patient_dossier.yaml' $ref: 'paths/patient_dossier.yaml'

Loading…
Cancel
Save