You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
zoo-api/schemas/fundus-status.yaml

184 lines
6.9 KiB
YAML

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

type: object
required:
- agb
- name
- gpis
- patients
properties:
agb:
description: |-
The AGB code of the GP practice whose patients are provided in this object.
type: integer
format: int32
minimum: 1
maximum: 99999999
name:
description: |-
A human readable name describing the GP practice (The entity whose AGB code is sent as `agb`).
type: string
gpis:
$ref: 'GPIS.yaml'
patients:
type: array
items:
type: object
description: |-
Which patients are returned, and which Personal Identifying Information properties are sent
depends on the chosen `purpose` when making this API call.
required:
- patid
- patUnid
- doctor
- category
- fundus
properties:
bsn:
$ref: 'PatIdentity.yaml#/bsn'
name:
$ref: 'PatIdentity.yaml#/name'
gender:
$ref: 'PatIdentity.yaml#/gender'
dob:
$ref: 'PatIdentity.yaml#/dob'
category:
$ref: 'PatIdentity.yaml#/category'
doctor:
$ref: 'PatIdentity.yaml#/doctor'
address:
$ref: 'PatIdentity.yaml#/address'
contact:
$ref: 'PatIdentity.yaml#/contact'
insurance:
$ref: 'PatIdentity.yaml#/insurance'
patid:
$ref: 'PatIdentity.yaml#/patid'
patUnid:
$ref: 'PatIdentity.yaml#/patUnid'
startDate:
$ref: 'PatIdentity.yaml#/startDate'
endDate:
$ref: 'PatIdentity.yaml#/endDate'
endReason:
$ref: 'PatIdentity.yaml#/endReason'
fundus:
type: object
required:
- careprogram
- director
- lastEval
- retinoVal
- left
- right
properties:
careprogram:
description: |-
The care program that is the primary reason Funduscopy status is applicable to this patient.
type: string
example: Ouderenzorg
director:
type: object
description: |-
Contains info about the funduscopy director: Who is responsible for this patient's funduscopy care and followup?
required:
- source
- nhgResult
properties:
source:
description: |-
The aspect of the medical dossier used to determine who is director. Usually one of:
* `DMRFTZ` indicates that NHG-standard lab/measurement registration 'Regie funduscopie' is used.
* `implied` Nothing explicit is available in the medical dossier, and the default as per the policies of this care group is provided.
type: string
example: DMRFTZ
timestamp:
type: string
format: date
description: |-
If present, the medical dossier entry used to conclude the funduscopy director was measured/entered on this date.
For example, if `DMRFTZ` registration is used, the date of that measurement as per the dossier.
nhgResult:
description: |-
The director, in NHG answercode for `DMRFTZ` form, regardless of what `source` actually provided this result:
* `48` - The GP is responsible for managing funduscopy
* `49` - The specialist is responsible
* `212` - Unknown
type: integer
format: int32
enum: [48, 49, 212]
lastEval:
description: |-
The date of the last time the patient has received Funduscopy; will be `null` if no funduscopy is registered.
The most recent measurement date is provided, even if only one eye was measured on that date.
$ref: ./date.yaml
retinoVal:
description: |-
The normalized retinopathy category for the worst eye, in terms of the 2017 Retinopathy level standard (richtlijn Diabetische Retinopathie 2017).
* `-1` retinopathy level is unknown or cannot be determined.
* `0` Retinopathy level R0: No visible retinopathy.
* `1` - Retinopathy level R1: Mild background retinopathy.
* `2` - Retinopathy level R2: Pre-proliferative retinopathy.
* `3` - Retinopathy level R3: Proliferative retinopathy.
type: integer
format: int32
minimum: -1
maximum: 3
left:
description: |-
Details about specifically the left eye.
type: object
required:
- lastEval
- retinoVal
properties:
lastEval:
description: Same as previous level, specifically for left eye.
$ref: ./date.yaml
retinoVal:
description: Same as previous level, specifically for left eye.
type: integer
format: int32
minimum: -1
maximum: 3
note:
description: |-
If present, describes why this measurement is missing, unclear, or suboptimal.
For example, might mention that the result from the lab is likely available, but has not
been properly registered in the medical dossier, or that a result is available but only after
the provided `refDate`. In dutch, and human readable.
type: string
nhgCode:
description: |-
If present, the NHG memocode used to register the retinopathy level. Will be in the terms dictionary.
type: string
example: DMR7FALI
nhgResult:
description: |-
If present, the NHG result value describing the retinopathy level. Will be in the terms dictionary.
type: integer
format: int32
example: 562
right:
type: object
description: |-
Like the left eye.
required:
- lastEval
- retinoVal
properties:
lastEval:
$ref: ./date.yaml
retinoVal:
type: integer
format: int32
minimum: -1
maximum: 3
note:
type: string
nhgCode:
type: string
nhgResult:
type: integer
format: int32