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.
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.
A comma separated list of patUnid values, as provided by other API endpoints.
For each patUnid the contact details are in the response. If sending lots of patUnids, we suggest you call this API in a POST (which is also allowed, though the semantic intent of this method is GET:It only queries and makes no changes) to avoid HTTP limits on query length.
@ -18,9 +18,27 @@ get:
example:"1234,5678"
- name:fields
in:query
mandatory:true
required:true
schema:
type:array
items:
type:string
enum:
- bsn
- patPubId
- patUnid
- gender
- displayName
- fullName
- addressLine
- postcode
- city
- tel
- email
- dob
explode:false
description:|-
Comma separated list of data fields that shold be returned in the response. Available options are:
Comma separated list of data fields that should be returned in the response. Available options are:
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.
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.
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.
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.
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.</dd>
<dt><code>PatientSnoozed</code></dt>
<dd>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.
<dd>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.</dd>
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).
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.
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.
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.
Update and query properties of ZOO customers (such as who is the contact person and which care programs they participate in).
- name:EPD exports
description:|-
List and download exported parts of EPD (General Practioner Information Systems) dossiers.
paths:
/patient/dossier:
$ref:'paths/patient_dossier.yaml'
@ -162,7 +164,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
@ -238,7 +240,6 @@ components:
description:Indicated practice is known but has not authorized ZOO to share this information with signer.
Reinier Zwitserloot