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/med_dossier/Measurement.yaml

70 lines
3.4 KiB
YAML

type: object
required:
- code
- when
- value
properties:
code:
description: |-
NHG-standardized labcode (describes the nature of the measurement), as listed on
[Webtools NHG labcodeviewer](https://bepalingen.nhg.org/labcodes/determinations).
The full memo+mat+bijz code is provided with no separation.
If the source allows custom labcodes, this value can contain a non-NHG-standard code. Most source systems do allow this.
Guaranteed to be provided, and will never be blank.
OPEN QUESTION: Would it be more convenient if this API guarantees the provided code is NHG compatible, relying on the `source_code` field
to represent such custom codes?
OPEN QUESTION: Would it be more convenient if this API provides this code separated out into memo/mat/bijz, e.g. "KREA O MK" instead of "KREAOMK"?
type: string
example: KREAOMK
source_code:
description: |-
*OPTIONAL* If the source system uses a different code to represent this measurement in its own system, it is listed here.
If present, guaranteed to be different from `nhg_code`. For example, a HIS might use `ROKENHG` instead of NHG-standard `ROOKAQ` to
represent registration of patient's smoking behaviour.
type: string
example: ROKENNHG
when:
description: |-
Date when this measurement was done. In practice it may instead represent the date when the measurement was registered
which might be a day or two after the measurement was actually performed; not all source systems make it possible to
distinguish the nature of the date.
type: string
format: date
example: "2023-04-30"
value:
description: |-
The value of the measurement. Normalized and NHG compatible if possible. For example, enumerated values (such as for `DMHBKZ` which
represents whether the general practicioner or the specialist is the primary caregiver for chronic diabetes mellitus care) use the
NHG numeric answer codes (in `DMHBKZ`'s case, `"48"` is returned if the GP is the primary caregiver, and `"49"` if the specialist is).
If the source provides a value that is not understood by ZOO's normalizers, the source value is provided verbatim.
This value can be blank; various labcodes simply represent that an act was performed and do not register any result.
If the value is numeric (for example, systolic blood pressure: `nhg_code = "RRSYKA"`), the dot is used as fractional separator, regardless
of what the source has provided.
type: string
example: 48
source_value:
description: |-
*OPTIONAL* The value of the measurement as reported by the source, verbatim (no normalization is applied in any way).
Only provided if meaningfully different from the normalized value.
type: string
example: HUISARTS
comment:
description: |-
*OPTIONAL* Some source systems allow adding a comment to any measurement; if one is present, it is provided here.
Note that these can be quite lengthy, as sometimes a lab will add standard boilerplate text about how to interpret
the result in these fields.
type: string
example: >-
tekst Sensibilisatie voor algemeen voorkomende inhalatieallergenen (huisstofmijt, kat, hond, graspollen, boompollen, bijvoetpollen, kruidpollen) is op dit moment niet vastgesteld.
practicioner:
$ref: 'Practicioner.yaml'