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