From 1c4aff7e5c269e0629453186b4ea589f50744fa9 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Wed, 29 Jul 2026 03:33:35 +0200 Subject: [PATCH] [rename] GPIS -> EPD --- paths/customer_basic.yaml | 2 +- paths/exports_available.yaml | 6 +++--- paths/exports_{agb}_{filename}.yaml | 4 ++-- paths/exports_{agb}_{filename}_{tablename}.yaml | 4 ++-- paths/patient_dossier.yaml | 2 +- paths/population_frequentUser_patients.yaml | 2 +- paths/population_statistics_employeeFeat.yaml | 4 ++-- paths/qoc_checkupList_set_status.yaml | 4 ++-- paths/qoc_participating-practices.yaml | 4 ++-- schemas/CallupPolicyType-enum-full.yaml | 2 +- schemas/GPIS.yaml | 2 +- schemas/IndicatorParticipants.yaml | 2 +- schemas/IndicatorSet.yaml | 2 +- schemas/PatIdentity.yaml | 2 +- schemas/employee-alias.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 | 6 +++--- schemas/pat-patPubId.yaml | 4 ++-- schemas/pat-patUnid.yaml | 4 ++-- zoo-api.yaml | 6 +++--- 23 files changed, 39 insertions(+), 39 deletions(-) diff --git a/paths/customer_basic.yaml b/paths/customer_basic.yaml index 095fadd..d9bbffd 100644 --- a/paths/customer_basic.yaml +++ b/paths/customer_basic.yaml @@ -33,7 +33,7 @@ get: description: The AGB of the institution, if the customer is a care group or other institute, otherwise omitted. One of practiceAgb or institutionAgb is always present. $ref: ../schemas/agb.yaml gpisMethod: - description: The current GPIS type and how medical dossiers are transferred to Zorg op Orde. + description: The current EPD type and how medical dossiers are transferred to Zorg op Orde. example: HealthConnected (automatische koppeling) lastImport: $ref: ../schemas/GPIS.yaml diff --git a/paths/exports_available.yaml b/paths/exports_available.yaml index cf7453b..edbaaad 100644 --- a/paths/exports_available.yaml +++ b/paths/exports_available.yaml @@ -1,13 +1,13 @@ get: operationId: exportsAvailable tags: - - GPIS exports + - EPD exports summary: List available exports responses: '200': description: |- - 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, + Lists all available EPD export snapshots. + An EPD 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 11541c6..fe0db71 100644 --- a/paths/exports_{agb}_{filename}.yaml +++ b/paths/exports_{agb}_{filename}.yaml @@ -1,7 +1,7 @@ get: operationId: exportsDownload tags: - - GPIS exports + - EPD exports summary: Download an available export parameters: - name: agb @@ -20,7 +20,7 @@ get: responses: '200': description: |- - Fetches the requested GPIS export as ZIP file. + Fetches the requested EPD 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 58685e5..08f99f7 100644 --- a/paths/exports_{agb}_{filename}_{tablename}.yaml +++ b/paths/exports_{agb}_{filename}_{tablename}.yaml @@ -1,7 +1,7 @@ get: operationId: exportsDownloadPerTable tags: - - GPIS exports + - EPD 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 GPIS export. + Fetches the requested table from the EPD 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/patient_dossier.yaml b/paths/patient_dossier.yaml index 5755271..beff88e 100644 --- a/paths/patient_dossier.yaml +++ b/paths/patient_dossier.yaml @@ -10,7 +10,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 (GPIS snapshot date) + - send along the date on which the result is based (EPD 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 3addf5a..2aa59e2 100644 --- a/paths/population_frequentUser_patients.yaml +++ b/paths/population_frequentUser_patients.yaml @@ -109,7 +109,7 @@ get: description: type: string example: consult huisarts langer dan 20 minuten - description: The feat description is taken from the GPIS import. + description: The feat description is taken from the EPD 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 7937c04..0a68e11 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 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. + description: Summaries the performance of employees expressed in feat count and turnover amounts. Only contract and national tariffs are used. Tariffs imported from any EPD 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 GPIS-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 EPD 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_checkupList_set_status.yaml b/paths/qoc_checkupList_set_status.yaml index f945e49..ebf37e2 100644 --- a/paths/qoc_checkupList_set_status.yaml +++ b/paths/qoc_checkupList_set_status.yaml @@ -56,7 +56,7 @@ post: maxItems: 1000 example: 10012,32122,1212 description: |- - patient GPIS ids. One of `bsns` or `patIds` must be provided (but not both). + patient EPD ids. One of `bsns` or `patIds` must be provided (but not both). required: - careprogram - callUpStatus @@ -65,7 +65,7 @@ post: responses: '200': description: |- - BSNs or patIds whose status has actually updated. BSNs or patIds which were not known in the GPIS are ignored and not returned here. + BSNs or patIds whose status has actually updated. BSNs or patIds which were not known in the EPD 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/paths/qoc_participating-practices.yaml b/paths/qoc_participating-practices.yaml index 69c7a92..bae1202 100644 --- a/paths/qoc_participating-practices.yaml +++ b/paths/qoc_participating-practices.yaml @@ -79,11 +79,11 @@ 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 GPIS data at this instant. + is based on a snapshot of EPD data at this instant. $ref: ../schemas/dateTime.yaml mostRecentDataAvailable: description: |- - If present, this GP practice's most recent available data is a GPIS snapshot with GPIS data at this instant. + If present, this GP practice's most recent available data is an EPD snapshot with EPD data at this instant. Usually equal to `calculationBasedOn`, but can be newer. If not present, this GP practice has no data available. $ref: ../schemas/dateTime.yaml required: diff --git a/schemas/CallupPolicyType-enum-full.yaml b/schemas/CallupPolicyType-enum-full.yaml index 7bd4633..c9d6524 100644 --- a/schemas/CallupPolicyType-enum-full.yaml +++ b/schemas/CallupPolicyType-enum-full.yaml @@ -8,7 +8,7 @@ description: |- The effect of this policy is to modify the 'callup state' for that patient/indicator combination. For example, the amputee would receive a `-` state for 'foot inspection' (indicating: Foot inspection is not relevant for this patient) instead of a `0` (indicating: Foot inspection must be done this quarter). Naturally, any policy that expires _before_ the `refDate` of a callup list you're asking for doesn't apply.
PatientSnoozed
-
A policy that applies to a specific patient for a certain care program type (e.g. `COPD`), and indicates that providing chronic care at the GP level is not possible for a limited time. For longer 'snoozing' the advice is generally to set the GPIS based registration of chronic care participation (i.e. the value 'COKZ' (COPD chronic care participation) to 'No'), but when the situation is temporary and a medical operator knows when the situation ends, this policy can be used instead, which has the advantage of restoring the patient to chronic care reporting automatically when the policy is expires. `expiry` is mandatory for this type of policy. +
A policy that applies to a specific patient for a certain care program type (e.g. `COPD`), and indicates that providing chronic care at the GP level is not possible for a limited time. For longer 'snoozing' the advice is generally to set the EPD based registration of chronic care participation (i.e. the value 'COKZ' (COPD chronic care participation) to 'No'), but when the situation is temporary and a medical operator knows when the situation ends, this policy can be used instead, which has the advantage of restoring the patient to chronic care reporting automatically when the policy is expires. `expiry` is mandatory for this type of policy. The effect of this policy is to default the patient's call up plan (the `chosenStatus` is `byPolicy`) to `doNotCallup` until the policy expires.
diff --git a/schemas/GPIS.yaml b/schemas/GPIS.yaml index d8629e5..eca5135 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 GPIS 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 EPD database was imported (yet). type: object properties: gpisType: diff --git a/schemas/IndicatorParticipants.yaml b/schemas/IndicatorParticipants.yaml index 0f820f3..eb9a6ea 100644 --- a/schemas/IndicatorParticipants.yaml +++ b/schemas/IndicatorParticipants.yaml @@ -96,7 +96,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 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. + 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 EPD 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 065d52a..81c2fb0 100644 --- a/schemas/IndicatorSet.yaml +++ b/schemas/IndicatorSet.yaml @@ -94,5 +94,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 GPIS-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 EPD 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/PatIdentity.yaml b/schemas/PatIdentity.yaml index 9db9313..40c152c 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 GPIS or practice doesn't assign patients to individual GPs, + Value 0 indicates this EPD or practice doesn't assign patients to individual GPs, or this information isn't known. type: number example: 1051234 diff --git a/schemas/employee-alias.yaml b/schemas/employee-alias.yaml index fedc4ff..2d0977b 100644 --- a/schemas/employee-alias.yaml +++ b/schemas/employee-alias.yaml @@ -1,3 +1,3 @@ -description: Alias for the doctor, sometimes called _memocode_. Should be an unique identifier for a doctor in a GPIS. +description: Alias for the doctor, sometimes called _memocode_. Should be an unique identifier for a doctor in an EPD. type: string example: MH,RZ,AXW \ No newline at end of file diff --git a/schemas/med_dossier/Episode.yaml b/schemas/med_dossier/Episode.yaml index e4dd67c..d4f9b11 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 GPIS that allow registering problems / conditions without an ICPC). + Guaranteed to be formatted as `X01.00`, _or_ blank (for EPDs 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 GPIS default the 'description' of an episode to the standard description for the provided ICPC, but allow the + Most EPDs 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 e891127..1858748 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 GPIS might use `ROKENHG` instead of NHG-standard `ROOKAQ` to + If present, guaranteed to be different from `nhg_code`. For example, an EPD 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 0ed027b..a693455 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 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. + A coded description of how to use this medication. Depends on source EPD; sometimes even on the individual configuration of + a practice's EPD 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 GPIS and often not available at all. + Human-readable (dutch) description of how to use this medication. Depends on source EPD 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 700a086..0c07054 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 GPIS vendors, hence why right now this field is free-form. + in a specific structure due to fundamental differences between EPD 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 c061356..f3049ad 100644 --- a/schemas/pat-patId.yaml +++ b/schemas/pat-patId.yaml @@ -1,10 +1,10 @@ description: |- _DEPRECATED_ this value will be removed in some future version and you should no longer - rely on it. Some GPIS use non-numeric public IDs. Use value `patPubId` instead which is like + rely on it. Some EPDs use non-numeric public IDs. Use value `patPubId` instead which is like this one, except a string instead of a number. - 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) + Patient's "public" ID, as used and shown on the EPD patient page. Not necessarily unique, + and not necessarily present; 0 indicates no patid is known or this EPD 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-patPubId.yaml b/schemas/pat-patPubId.yaml index 7136bad..3ec5255 100644 --- a/schemas/pat-patPubId.yaml +++ b/schemas/pat-patPubId.yaml @@ -1,6 +1,6 @@ description: |- - 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 public IDs. + Patient's "public" ID, as used and shown on the EPD patient page. Not necessarily unique, + and not necessarily present; 0 indicates no patid is known or this EPD does not use public IDs. The primary purpose of this field is to show it to medical professionals working at this practice who can use it to search for this dossier and is a way to communicate without sharing privacy-sensitive diff --git a/schemas/pat-patUnid.yaml b/schemas/pat-patUnid.yaml index b194955..f0ca5c8 100644 --- a/schemas/pat-patUnid.yaml +++ b/schemas/pat-patUnid.yaml @@ -1,6 +1,6 @@ description: |- - Patient's unique and persistent ID in GPIS. Usually identical to `patPubId` but certain GPISes may + Patient's unique and persistent ID in the EPD. Usually identical to `patPubId` but certain EPDs 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. + if supplying EPD does not send them. type: string example: "1234" diff --git a/zoo-api.yaml b/zoo-api.yaml index a412003..2efd864 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: GPIS exports description: |- - List and download exported parts of GPIS dossiers. + - name: EPD exports + List and download exported parts of EPD (General Practioner Information Systems) dossiers. paths: /patient/dossier: $ref: 'paths/patient_dossier.yaml' @@ -162,7 +162,7 @@ components: GpCodes: name: gpCodes in: query - description: Code of the GP as known in the GPIS. + description: Code of the GP as known in the EPD. example: AA,BZP,RZ,ECH schema: type: array