Rename 'his' to 'gpis' in all descriptions

EH/population-statistics-authorisation
Reinier Zwitserloot 2 years ago
parent b323a48d7d
commit 9fa9e4a099
No known key found for this signature in database
GPG Key ID: DADEDCAA42950296

2
.gitignore vendored

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

@ -7,7 +7,7 @@ get:
which will be logged and reviewed for the _Principle of Least Privilege_ policy. which will be logged and reviewed for the _Principle of Least Privilege_ policy.
Known design parameters: 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). - 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. - 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. - q - edit it a bit, can be for example 'dm' or even 'dm/dietetiek'. Send all relevant parts in one response.

@ -106,7 +106,7 @@ get:
description: description:
type: string type: string
example: consult huisarts langer dan 20 minuten 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: n:
type: number type: number
description: The count of the feats with the given code for the patient. description: The count of the feats with the given code for the patient.

@ -3,7 +3,7 @@ get:
- Population statistics - Population statistics
operationId: populationStatisticsEmployeeFeat operationId: populationStatisticsEmployeeFeat
summary: Employee turnover 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: parameters:
- $ref: '../zoo-api.yaml#/components/parameters/Authorization' - $ref: '../zoo-api.yaml#/components/parameters/Authorization'
- name: periodStart - name: periodStart
@ -18,7 +18,7 @@ get:
$ref: ../schemas/date.yaml $ref: ../schemas/date.yaml
- $ref: '../zoo-api.yaml#/components/parameters/GpCodes' - $ref: '../zoo-api.yaml#/components/parameters/GpCodes'
description: |- 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. The responsible GP is not written in the response, due the structure of the agreggation.
- name: employees - name: employees

@ -79,13 +79,13 @@ get:
calculationBasedOn: calculationBasedOn:
description: |- description: |-
If present, this GP practice is calculated for this refDate for this care program, and the calculation 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 type: string
format: datetime format: datetime
example: 2023-04-01T12:30:00.000Z example: 2023-04-01T12:30:00.000Z
mostRecentDataAvailable: mostRecentDataAvailable:
description: |- 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. Usually equal to `calculationBasedOn`, but can be newer. If not present, this GP practice has no data available.
type: string type: string
format: datetime format: datetime

@ -31,7 +31,7 @@ doctor:
description: |- description: |-
If known, the AGB code of the primary care GP (dutch: _Inschrijf arts_). 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. or this information isn't known.
type: number type: number
example: 1051234 example: 1051234

@ -8,7 +8,7 @@ properties:
description: |- description: |-
The ICPC1.1 (NL variant) code describing this problem / chronic condition. 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 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`. returned by this API as `B73.00`.
@ -33,7 +33,7 @@ properties:
$ref: ../date.yaml $ref: ../date.yaml
description: description:
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. practitioner to change this description.
type: string type: string
example: "Geboorte dochter" example: "Geboorte dochter"

@ -30,7 +30,7 @@ properties:
description: |- description: |-
If the source system uses a different code to represent this measurement in its own system, it is listed here. 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. represent registration of patient's smoking behaviour.
type: string type: string
example: ROKENNHG example: ROKENNHG

@ -51,12 +51,12 @@ properties:
example: AN example: AN
usageCode: usageCode:
description: |- description: |-
A coded description of how to use this medication. Depends on source HIS software; sometimes even on the individual configuration of A coded description of how to use this medication. Depends on source GPIS; 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 practice's GPIS or that practice's regional server; these values aren't normalized, and sometimes not available at all.
type: string type: string
example: 1D1T example: 1D1T
usageText: usageText:
description: |- 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 type: string
example: Gebruik bekend example: Gebruik bekend

@ -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 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 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 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 type: string
example: AA example: AA

@ -1,6 +1,6 @@
description: |- description: |-
Patient's "public" ID, as used and shown on the HIS patient page. Not necessarily unique, 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 HIS does not use (numeric) and not necessarily present; 0 indicates no patid is known or this GPIS does not use (numeric)
public IDs. public IDs.
The primary purpose of this field is to show it to medical professionals working at this practice The primary purpose of this field is to show it to medical professionals working at this practice

@ -1,6 +1,6 @@
description: |- 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 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 type: string
example: 1234 example: 1234

@ -151,7 +151,7 @@ components:
GpCodes: GpCodes:
name: gpCodes name: gpCodes
in: query 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 example: AA,BZP,RZ,ECH
schema: schema:
type: array type: array

Loading…
Cancel
Save