Load call-up status for patients in a care program. Returns each patient in a care program along with the progress on required or suggested measurements indicated for this care program.
Load the call-up status for patients in a care program. Returns each patient in a care program along with the progress on required or suggested measurements indicated for this care program.
parameters:
- name:setKey
in:path
@ -49,132 +49,158 @@ get:
description:Request inclusion of email addresses
schema:
type:boolean
- name:onlyNameAddress
in:query
required:false
description:|-
If true, only data needed for printing address labels is in the response. This output is also known as Dymo output. The format of the response depends on the HTTP Accept header. If the best match between the server en caller is:
*`text/csv`, then CSV according RFC 4180 is responded;
*`application/json`, then JSON;
*`application/vnd.ms-excel` or `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, then legacy MS Excel;
While the server is still calculating, see calculating property in the response, the output is always `application/json`.
A list of patients. The format of the response is default a comprehensive JSON, but can be limited to only data needed for printing address labels, using the `onlyNameAddress` parameter. Any non JSON response has a header row with field names.
Lists all relevant doctors. A doctor is relevant if they are responsible
for at least 1 patient in the list.
type:array
items:
type:object
properties:
name:
description:|-
The name (or possibly memocode; something an employee of the practice will recognize) of the general practitioner.
type:string
agb:
description:If known, the AGB code of this general practitioner.
type:integer
format:int32
minimum:1
maximum:99999999
required:
- name
indicators:
type:array
description:|-
One entry for each kind of measurement that (may) require call-up.
items:
type:object
properties:
title:
description:|-
The title of this indicator
type:string
example:Bloeddruk
optional:
description:|-
If present, this indicator is optional, and the value contains dutch human readable text explaining why.
type:string
example:Volgens HKN protocol is BMI meten optioneel bij Astma patiënten; echter stelt het protocol wel een relatie tussen overgewicht en de mate van klachten.
required:
- title
patients:
type:array
items:
type:object
properties:
patPubId:
$ref:'../schemas/PatIdentity.yaml#/patPubId'
patUnid:
$ref:'../schemas/PatIdentity.yaml#/patUnid'
doctor:
type:integer
format:int32
description:|-
An index (0-based) into the `doctors` entry:This is the GP responsible for this patient.
status:
$ref:'../schemas/callUpStatus-enum.yaml'
address1:
type:string
description:|-
The first line of this patient's postal address (Street name and number, generally).
city:
type:string
description:Patient lives in this city or township.
postcode:
type:string
description:Postcode of the patient.
bsn:
type:integer
minimum:1
maximum:999999999
format:int32
description:The BSN (dutch social security number) of the patient.
dob:
$ref:../schemas/date.yaml
description:Date of birth of the patient.
email:
type:string
format:email
description:Email address of the patient.
state:
type:string
description:|-
A string containing 1 character for each indicator as listed in `indicators`.
This character represents the patient's call-up state for that indicator:
Lists all relevant doctors. A doctor is relevant if they are responsible
for at least 1 patient in the list.
type:array
items:
type:object
properties:
name:
description:|-
The name (or possibly memocode; something an employee of the practice will recognize) of the general practitioner.
type:string
agb:
description:If known, the AGB code of this general practitioner.
type:integer
format:int32
minimum:1
maximum:99999999
required:
- name
indicators:
type:array
description:|-
One entry for each kind of measurement that (may) require call-up.
items:
type:object
properties:
title:
description:|-
The title of this indicator
type:string
example:Bloeddruk
optional:
description:|-
If present, this indicator is optional, and the value contains dutch human readable text explaining why.
type:string
example:Volgens HKN protocol is BMI meten optioneel bij Astma patiënten; echter stelt het protocol wel een relatie tussen overgewicht en de mate van klachten.
required:
- title
patients:
type:array
items:
type:object
properties:
patPubId:
$ref:'../schemas/PatIdentity.yaml#/patPubId'
patUnid:
$ref:'../schemas/PatIdentity.yaml#/patUnid'
doctor:
type:integer
format:int32
description:|-
An index (0-based) into the `doctors` entry:This is the GP responsible for this patient.
status:
$ref:'../schemas/callUpStatus-enum.yaml'
name:
$ref:'../schemas/pat-Name.yaml'
address1:
type:string
description:|-
The first line of this patient's postal address (Street name and number, generally).
city:
type:string
description:Patient lives in this city or township.
postcode:
type:string
description:Postcode of the patient.
bsn:
type:integer
minimum:1
maximum:999999999
format:int32
description:The BSN (dutch social security number) of the patient.
dob:
$ref:../schemas/date.yaml
description:Date of birth of the patient.
email:
type:string
format:email
description:Email address of the patient.
state:
type:string
description:|-
A string containing 1 character for each indicator as listed in `indicators`.
*`-` – This indicator is not relevant for this patient; no call-up needed.
*`R` – This is an optional indicator, but, the patient doesn't have this measurement.
*`0` – This is a required indicator and the patient doesn't have it.
*`1` – The patient has this measurement; but unless it is measured again, next quarter it'll be too long ago and no longer counts.
*`2`-`8` – `2` is like `1`, except the measurement lasts for 2 quarters up to 8 quarters.
*`+` – The measurement lasts for 9 or more quarters (for example, the measurement only needs to be done once ever and it has been done).
*`x` – unknown situation (should not occur).
required:
- patUnid
- doctor
- status
- dob
- state
required:
- gpis
- key
- name
- refDate
- calculating
This character represents the patient's call-up state for that indicator:
*`-` – This indicator is not relevant for this patient; no call-up needed.
*`R` – This is an optional indicator, but, the patient doesn't have this measurement.
*`0` – This is a required indicator and the patient doesn't have it.
*`1` – The patient has this measurement; but unless it is measured again, next quarter it'll be too long ago and no longer counts.
*`2`-`8` – `2` is like `1`, except the measurement lasts for 2 quarters up to 8 quarters.
*`+` – The measurement lasts for 9 or more quarters (for example, the measurement only needs to be done once ever and it has been done).
description:In dutch, HTML formatted; if present, contains details on how this value is measured (in more readable, less technical terms than `htmlDetail`.
type:string
example:Patiënten met ≥ 1 voorschrift(en) long acting beta-2 agonists (LABA) of long acting muscarine antagonists (LAMA) in de afgelopen 12 maanden
htmlDetail:
description:In dutch, HTML formatted; if present, contains specific details on how this value is measured (for example, contains information about which NHG bepaling codes are used).
type:string
example:LAMA (<code>R03BB</code> (04, 05, 06 of 07)) of LABA (<code>R03AC</code> (12, 13, 18 of 19))
type:
description:|-
What kind of indicator this is.
@ -183,6 +191,12 @@ properties:
type:string
example:Praktijk 2023Q3
default:''
pop:
description:|-
A number representing the total population that this indicator has calculated against; can have decimal values if this
description:In dutch, plain text formatted; should fit on one line.
type:string
example:Populatie
htmlDescription:
description:In dutch, HTML formatted; if present, contains details on how this value is measured (in more readable, less technical terms than `htmlDetail`.
type:string
example:Patiënten met ≥ 1 voorschrift(en) long acting beta-2 agonists (LABA) of long acting muscarine antagonists (LAMA) in de afgelopen 12 maanden
htmlDetail:
description:In dutch, HTML formatted; if present, contains specific details on how this value is measured (for example, contains information about which NHG bepaling codes are used).
type:string
example:LAMA (<code>R03BB</code> (04, 05, 06 of 07)) of LABA (<code>R03AC</code> (12, 13, 18 of 19))
indicatorGroups:
description:|-
A chapter contains 1 or more indicator groups. An indicator group is an array of indicators which should
Eric Hoekstra
Reinier Zwitserloot