From 9fa9e4a0999d672f7a5d76ea13eeb9d24b6a4346 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Wed, 29 May 2024 02:54:31 +0200 Subject: [PATCH] Rename 'his' to 'gpis' in all descriptions --- .gitignore | 2 ++ paths/patient_dossier.yaml | 2 +- paths/population_frequentUser_patients.yaml | 2 +- paths/population_statistics_employeeFeat.yaml | 4 ++-- paths/qoc_participating-practices.yaml | 4 ++-- schemas/PatIdentity.yaml | 2 +- schemas/med_dossier/Episode.yaml | 4 ++-- schemas/med_dossier/Measurement.yaml | 2 +- schemas/med_dossier/Medication.yaml | 6 +++--- schemas/med_dossier/Practitioner.yaml | 2 +- schemas/pat-patId.yaml | 4 ++-- schemas/pat-patUnid.yaml | 4 ++-- zoo-api.yaml | 2 +- 13 files changed, 21 insertions(+), 19 deletions(-) diff --git a/.gitignore b/.gitignore index 2c28f32..2c87e1d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ /zoo-api.html /zoo-api-bundle.yaml +/.settings +/.project diff --git a/paths/patient_dossier.yaml b/paths/patient_dossier.yaml index 390ee40..c3b5db7 100644 --- a/paths/patient_dossier.yaml +++ b/paths/patient_dossier.yaml @@ -7,7 +7,7 @@ get: which will be logged and reviewed for the _Principle of Least Privilege_ policy. Known design parameters: - - send along the date on which the result is based (HIS snapshot date) + - send along the date on which the result is based (GPIS snapshot date) - Sender must send a key (or list of keys) representing the context, such as 'DM', 'Obesitas', 'Dietetiek', etc. We combine the targeted data (the GP or zorggroep) with these keys to know precisely what we filter (we do not just return all medical dossier data). - uptime is important; these API calls are done live as patients show. - q - edit it a bit, can be for example 'dm' or even 'dm/dietetiek'. Send all relevant parts in one response. diff --git a/paths/population_frequentUser_patients.yaml b/paths/population_frequentUser_patients.yaml index 97e92e5..a4067b2 100644 --- a/paths/population_frequentUser_patients.yaml +++ b/paths/population_frequentUser_patients.yaml @@ -106,7 +106,7 @@ get: description: type: string example: consult huisarts langer dan 20 minuten - description: The feat description is taken from the HIS import. + description: The feat description is taken from the GPIS import. n: type: number description: The count of the feats with the given code for the patient. diff --git a/paths/population_statistics_employeeFeat.yaml b/paths/population_statistics_employeeFeat.yaml index 3f9d994..7937c04 100644 --- a/paths/population_statistics_employeeFeat.yaml +++ b/paths/population_statistics_employeeFeat.yaml @@ -3,7 +3,7 @@ get: - Population statistics operationId: populationStatisticsEmployeeFeat summary: Employee turnover - description: Summaries the performance of employees expressed in feat count and turnover amounts. Only contract and national tariffs are used. Tariffs imported from any HIS are ignored. Contract tariffs as registered by Zorg op Orde or, if not present, national tariffs as published by the government are used. Only to most recent years of national tariffs are available. + description: Summaries the performance of employees expressed in feat count and turnover amounts. Only contract and national tariffs are used. Tariffs imported from any GPIS are ignored. Contract tariffs as registered by Zorg op Orde or, if not present, national tariffs as published by the government are used. Only to most recent years of national tariffs are available. parameters: - $ref: '../zoo-api.yaml#/components/parameters/Authorization' - name: periodStart @@ -18,7 +18,7 @@ get: $ref: ../schemas/date.yaml - $ref: '../zoo-api.yaml#/components/parameters/GpCodes' description: |- - Restricts to the GP's which were medical responsible for the feat. Uses the GP at the time of the feat, or if not available, the GP responsible for the patient at the time of the HIS-import. The GP at the time of the feat is the most accurate. + Restricts to the GP's which were medical responsible for the feat. Uses the GP at the time of the feat, or if not available, the GP responsible for the patient at the time of the GPIS-import. The GP at the time of the feat is the most accurate. The responsible GP is not written in the response, due the structure of the agreggation. - name: employees diff --git a/paths/qoc_participating-practices.yaml b/paths/qoc_participating-practices.yaml index 786e9b3..91d1479 100644 --- a/paths/qoc_participating-practices.yaml +++ b/paths/qoc_participating-practices.yaml @@ -79,13 +79,13 @@ get: calculationBasedOn: description: |- If present, this GP practice is calculated for this refDate for this care program, and the calculation - is based on a snapshot of HIS data at this instant. + is based on a snapshot of GPIS data at this instant. type: string format: datetime example: 2023-04-01T12:30:00.000Z mostRecentDataAvailable: description: |- - If present, this GP practice's most recent available data is a HIS snapshot with HIS data at this instant. + If present, this GP practice's most recent available data is a GPIS snapshot with GPIS data at this instant. Usually equal to `calculationBasedOn`, but can be newer. If not present, this GP practice has no data available. type: string format: datetime diff --git a/schemas/PatIdentity.yaml b/schemas/PatIdentity.yaml index 69a7692..23bf449 100644 --- a/schemas/PatIdentity.yaml +++ b/schemas/PatIdentity.yaml @@ -31,7 +31,7 @@ doctor: description: |- If known, the AGB code of the primary care GP (dutch: _Inschrijf arts_). - Value 0 indicates this HIS or practice doesn't assign patients to individual GPs, + Value 0 indicates this GPIS or practice doesn't assign patients to individual GPs, or this information isn't known. type: number example: 1051234 diff --git a/schemas/med_dossier/Episode.yaml b/schemas/med_dossier/Episode.yaml index cbc720a..e4dd67c 100644 --- a/schemas/med_dossier/Episode.yaml +++ b/schemas/med_dossier/Episode.yaml @@ -8,7 +8,7 @@ properties: description: |- The ICPC1.1 (NL variant) code describing this problem / chronic condition. - Guaranteed to be formatted as `X01.00`, _or_ blank (for HIS systems that allow registering problems / conditions without an ICPC). + Guaranteed to be formatted as `X01.00`, _or_ blank (for GPIS that allow registering problems / conditions without an ICPC). Note that certain ICPC1.1 codes are generally stated without the subcode, for example, `B73` (Leukemia). Nevertheless these are returned by this API as `B73.00`. @@ -33,7 +33,7 @@ properties: $ref: ../date.yaml description: description: |- - Most HIS source systems default the 'description' of an episode to the standard description for the provided ICPC, but allow the + Most GPIS default the 'description' of an episode to the standard description for the provided ICPC, but allow the practitioner to change this description. type: string example: "Geboorte dochter" diff --git a/schemas/med_dossier/Measurement.yaml b/schemas/med_dossier/Measurement.yaml index c356b2a..e891127 100644 --- a/schemas/med_dossier/Measurement.yaml +++ b/schemas/med_dossier/Measurement.yaml @@ -30,7 +30,7 @@ properties: description: |- If the source system uses a different code to represent this measurement in its own system, it is listed here. - If present, guaranteed to be different from `nhg_code`. For example, a HIS might use `ROKENHG` instead of NHG-standard `ROOKAQ` to + If present, guaranteed to be different from `nhg_code`. For example, a GPIS might use `ROKENHG` instead of NHG-standard `ROOKAQ` to represent registration of patient's smoking behaviour. type: string example: ROKENNHG diff --git a/schemas/med_dossier/Medication.yaml b/schemas/med_dossier/Medication.yaml index 207b511..0ed027b 100644 --- a/schemas/med_dossier/Medication.yaml +++ b/schemas/med_dossier/Medication.yaml @@ -51,12 +51,12 @@ properties: example: AN usageCode: description: |- - A coded description of how to use this medication. Depends on source HIS software; sometimes even on the individual configuration of - a practice's HIS or that practice's regional server; these values aren't normalized, and sometimes not available at all. + A coded description of how to use this medication. Depends on source GPIS; sometimes even on the individual configuration of + a practice's GPIS or that practice's regional server; these values aren't normalized, and sometimes not available at all. type: string example: 1D1T usageText: description: |- - Human-readable (dutch) description of how to use this medication. Depends on source HIS software and often not available at all. + Human-readable (dutch) description of how to use this medication. Depends on source GPIS and often not available at all. type: string example: Gebruik bekend diff --git a/schemas/med_dossier/Practitioner.yaml b/schemas/med_dossier/Practitioner.yaml index d23ba0e..700a086 100644 --- a/schemas/med_dossier/Practitioner.yaml +++ b/schemas/med_dossier/Practitioner.yaml @@ -9,6 +9,6 @@ description: |- OPEN QUESTION: Would it be useful if this field is more structured and e.g. explains what it is, or that this field contains an ID that can be separately looked up using another API endpoint; we are very dependent on the source for the nature of this information, but some e.g. provide the doctor under whose authority a practitioner is operating, which could be useful information. We can't guarantee that we can provide this data - in a specific structure due to fundamental differences between HIS vendors, hence why right now this field is free-form. + in a specific structure due to fundamental differences between GPIS vendors, hence why right now this field is free-form. type: string example: AA \ No newline at end of file diff --git a/schemas/pat-patId.yaml b/schemas/pat-patId.yaml index 9328d22..17c358d 100644 --- a/schemas/pat-patId.yaml +++ b/schemas/pat-patId.yaml @@ -1,6 +1,6 @@ description: |- - Patient's "public" ID, as used and shown on the HIS patient page. Not necessarily unique, - and not necessarily present; 0 indicates no patid is known or this HIS does not use (numeric) + Patient's "public" ID, as used and shown on the GPIS patient page. Not necessarily unique, + and not necessarily present; 0 indicates no patid is known or this GPIS does not use (numeric) public IDs. The primary purpose of this field is to show it to medical professionals working at this practice diff --git a/schemas/pat-patUnid.yaml b/schemas/pat-patUnid.yaml index c80ee5a..865cb5c 100644 --- a/schemas/pat-patUnid.yaml +++ b/schemas/pat-patUnid.yaml @@ -1,6 +1,6 @@ description: |- - Patient's unique and persistent ID in HIS. Usually identical to `patid` but certain HISes may + Patient's unique and persistent ID in GPIS. Usually identical to `patid` but certain HISes may use UUID, or has globally unique keys (e.g. very large numbers). Can be blank, but only - if supplying HIS does not send them. + if supplying GPIS does not send them. type: string example: 1234 diff --git a/zoo-api.yaml b/zoo-api.yaml index 01b7ee7..0358d6a 100644 --- a/zoo-api.yaml +++ b/zoo-api.yaml @@ -151,7 +151,7 @@ components: GpCodes: name: gpCodes in: query - description: Code of the GP as known in the HIS. + description: Code of the GP as known in the GPIS. example: AA,BZP,RZ,ECH schema: type: array