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:
parameters:
- name:setKey
- name:setKey
in:path
in:path
@ -49,132 +49,158 @@ get:
description:Request inclusion of email addresses
description:Request inclusion of email addresses
schema:
schema:
type:boolean
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
description:|-
for at least 1 patient in the list.
Lists all relevant doctors. A doctor is relevant if they are responsible
type:array
for at least 1 patient in the list.
items:
type:array
type:object
items:
properties:
type:object
name:
properties:
description:|-
name:
The name (or possibly memocode; something an employee of the practice will recognize) of the general practitioner.
description:|-
type:string
The name (or possibly memocode; something an employee of the practice will recognize) of the general practitioner.
agb:
type:string
description:If known, the AGB code of this general practitioner.
agb:
type:integer
description:If known, the AGB code of this general practitioner.
format:int32
type:integer
minimum:1
format:int32
maximum:99999999
minimum:1
required:
maximum:99999999
- name
required:
indicators:
- name
type:array
indicators:
description:|-
type:array
One entry for each kind of measurement that (may) require call-up.
description:|-
items:
One entry for each kind of measurement that (may) require call-up.
type:object
items:
properties:
type:object
title:
properties:
description:|-
title:
The title of this indicator
description:|-
type:string
The title of this indicator
example:Bloeddruk
type:string
optional:
example:Bloeddruk
description:|-
optional:
If present, this indicator is optional, and the value contains dutch human readable text explaining why.
description:|-
type:string
If present, this indicator is optional, and the value contains dutch human readable text explaining why.
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.
type:string
required:
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.
- title
required:
patients:
- title
type:array
patients:
items:
type:array
type:object
items:
properties:
type:object
patPubId:
properties:
$ref:'../schemas/PatIdentity.yaml#/patPubId'
patPubId:
patUnid:
$ref:'../schemas/PatIdentity.yaml#/patPubId'
$ref:'../schemas/PatIdentity.yaml#/patUnid'
patUnid:
doctor:
$ref:'../schemas/PatIdentity.yaml#/patUnid'
type:integer
doctor:
format:int32
type:integer
description:|-
format:int32
An index (0-based) into the `doctors` entry:This is the GP responsible for this patient.
description:|-
status:
An index (0-based) into the `doctors` entry:This is the GP responsible for this patient.
$ref:'../schemas/callUpStatus-enum.yaml'
status:
address1:
$ref:'../schemas/callUpStatus-enum.yaml'
type:string
name:
description:|-
$ref:'../schemas/pat-Name.yaml'
The first line of this patient's postal address (Street name and number, generally).
address1:
city:
type:string
type:string
description:|-
description:Patient lives in this city or township.
The first line of this patient's postal address (Street name and number, generally).
postcode:
city:
type:string
type:string
description:Postcode of the patient.
description:Patient lives in this city or township.
bsn:
postcode:
type:integer
type:string
minimum:1
description:Postcode of the patient.
maximum:999999999
bsn:
format:int32
type:integer
description:The BSN (dutch social security number) of the patient.
minimum:1
dob:
maximum:999999999
$ref:../schemas/date.yaml
format:int32
description:Date of birth of the patient.
description:The BSN (dutch social security number) of the patient.
email:
dob:
type:string
$ref:../schemas/date.yaml
format:email
description:Date of birth of the patient.
description:Email address of the patient.
email:
state:
type:string
type:string
format:email
description:|-
description:Email address of the patient.
A string containing 1 character for each indicator as listed in `indicators`.
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:
This character represents the patient's call-up state for that indicator:
*`-` – This indicator is not relevant for this patient; no call-up needed.
*`-` – 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.
*`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.
*`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.
*`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.
*`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).
*`+` – 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:
type:
description:|-
description:|-
What kind of indicator this is.
What kind of indicator this is.
@ -183,6 +191,12 @@ properties:
type:string
type:string
example:Praktijk 2023Q3
example:Praktijk 2023Q3
default:''
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.
description:In dutch, plain text formatted; should fit on one line.
type:string
type:string
example:Populatie
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:
indicatorGroups:
description:|-
description:|-
A chapter contains 1 or more indicator groups. An indicator group is an array of indicators which should
A chapter contains 1 or more indicator groups. An indicator group is an array of indicators which should
Eric Hoekstra
Reinier Zwitserloot