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/TermsDictionary.yaml

52 lines
2.6 KiB
YAML

description: |-
Provides definitions of codes used in the rest of this response. Only codes used in the response messages are added to the dictionary. For example: if the response doesn't enclose measurements, then these are not in the dictionary. If the response holds feat codes 12001 and 12004, but not 12011, then the dictionary holds 12001 and 12004, but not 12011.
Always sent first.
type: object
properties:
measurements:
description: |-
Represents measurements (such as bloodpressure) and snapshot determinations (such as 'who is responsible for Type 2 diabetes chronic care'),
based on NHG memocodes. Each key in this object is a full NHG memocode (with no spaces), and each value is an object. That object
contains a key/value pair `"num"` containing the NHG numeric code for that memocode, a k/v pair `"text"` containing a dutch human
readable description. If the valid values for this measurement are enumerated, a k/v pair `"nhgVal": true` is present. That means the
value of such a measurement can be looked up in the `nhgAnswers` entry.
type: object
additionalProperties: true
example:
"DMHBTZ":
"num": 2206
"text": "hoofdbehandelaar diabetes"
"nhgVal": true
nhgAnswers:
description: |-
Enumerated NHG answers (the answer to any measurements with `"nhgVal": true`) can be looked up here.
type: object
additionalProperties: true
example:
"48": "Huisarts"
"49": "Specialist"
icpcs:
description: |-
Represents diagnoses and medical conditions, based on the ICPC1.1-NL standard. Keys in this object represent ICPC codes, always
formatted as a capital letter, followed by 2 digits, a dot, and 2 more digits. These map to value objects that contain 2
k/v pairs: `"text"` which contains dutch human readable text explaining what this ICPC code represents, and a `"classText"` k/v pair
containing the dutch human readable name of the class (the letter).
type: object
additionalProperties: true
example:
"T90.02":
"text": "Diabetes mellitus type 2"
"classText": "Endocriene klieren/metabol./voeding"
atcs:
description: |-
Represents medications, mapping ATC codes to value objects containing one k/v pair: `"text"` to a dutch human readable
description of the medication. The ATC codes may represent groups of medications (less than 7 characters).
type: object
additionalProperties: true
example:
"A02AB":
"text": "Aluminiumverbindingen"
"A11GA01":
"text": "Ascorbinezuur"