diff --git a/paths/exports_available.yaml b/paths/exports_available.yaml index 577c1a2..cf7453b 100644 --- a/paths/exports_available.yaml +++ b/paths/exports_available.yaml @@ -1,13 +1,13 @@ get: operationId: exportsAvailable tags: - - HIS exports + - GPIS exports summary: List available exports responses: '200': description: |- - Lists all available HIS 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, + Lists all available GPIS export snapshots. + 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. content: application/json: diff --git a/paths/exports_{agb}_{filename}.yaml b/paths/exports_{agb}_{filename}.yaml index 3e301af..11541c6 100644 --- a/paths/exports_{agb}_{filename}.yaml +++ b/paths/exports_{agb}_{filename}.yaml @@ -1,7 +1,7 @@ get: operationId: exportsDownload tags: - - HIS exports + - GPIS exports summary: Download an available export parameters: - name: agb @@ -20,7 +20,7 @@ get: responses: '200': 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. '401': diff --git a/paths/exports_{agb}_{filename}_{tablename}.yaml b/paths/exports_{agb}_{filename}_{tablename}.yaml index be18c1d..58685e5 100644 --- a/paths/exports_{agb}_{filename}_{tablename}.yaml +++ b/paths/exports_{agb}_{filename}_{tablename}.yaml @@ -1,7 +1,7 @@ get: operationId: exportsDownloadPerTable tags: - - HIS exports + - GPIS exports summary: Download one CSV table from an available export parameters: - name: agb @@ -27,7 +27,7 @@ get: responses: '200': 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. '401': diff --git a/paths/qoc_checkupList_set_status.yaml b/paths/qoc_checkupList_set_status.yaml index 91078e7..f1dc191 100644 --- a/paths/qoc_checkupList_set_status.yaml +++ b/paths/qoc_checkupList_set_status.yaml @@ -55,7 +55,7 @@ post: responses: '200': 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. content: 'application/json': diff --git a/schemas/GPIS.yaml b/schemas/GPIS.yaml index 667127b..9d9095d 100644 --- a/schemas/GPIS.yaml +++ b/schemas/GPIS.yaml @@ -1,5 +1,5 @@ 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 properties: gpisType: diff --git a/schemas/IndicatorParticipants.yaml b/schemas/IndicatorParticipants.yaml index 75c3e8d..4162af6 100644 --- a/schemas/IndicatorParticipants.yaml +++ b/schemas/IndicatorParticipants.yaml @@ -94,7 +94,7 @@ properties: cache: type: boolean 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 required: - group diff --git a/schemas/IndicatorSet.yaml b/schemas/IndicatorSet.yaml index c30dc73..d2e2cca 100644 --- a/schemas/IndicatorSet.yaml +++ b/schemas/IndicatorSet.yaml @@ -103,5 +103,5 @@ properties: items: $ref: 'Indicator.yaml' 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 \ No newline at end of file diff --git a/schemas/pat-patUnid.yaml b/schemas/pat-patUnid.yaml index 865cb5c..774afca 100644 --- a/schemas/pat-patUnid.yaml +++ b/schemas/pat-patUnid.yaml @@ -1,5 +1,5 @@ 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 if supplying GPIS does not send them. type: string diff --git a/zoo-api.yaml b/zoo-api.yaml index 708959d..b7522af 100644 --- a/zoo-api.yaml +++ b/zoo-api.yaml @@ -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. - name: Customer management - - name: HIS exports + - name: GPIS exports description: |- - List and download exported parts of HIS dossiers. + List and download exported parts of GPIS dossiers. paths: /patient/dossier: $ref: 'paths/patient_dossier.yaml'