[bugfix] Changed examples in terms dictionary to yaml and better explained user how to use a dict.

EH/population-statistics-authorisation
Eric Hoekstra 2 years ago
parent 8f49609034
commit 392e469068

@ -1,5 +1,5 @@
description: |- description: |-
Provides definitions of codes used in the rest of this response. 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. Always sent first.
type: object type: object
@ -13,24 +13,19 @@ properties:
value of such a measurement can be looked up in the `nhgAnswers` entry. value of such a measurement can be looked up in the `nhgAnswers` entry.
type: object type: object
additionalProperties: true additionalProperties: true
example: |- example:
{ "DMHBTZ":
"DMHBTZ": { "num": 2206
"num": 2206, "text": "hoofdbehandelaar diabetes"
"text": "hoofdbehandelaar diabetes",
"nhgVal": true "nhgVal": true
}
}
nhgAnswers: nhgAnswers:
description: |- description: |-
Enumerated NHG answers (the answer to any measurements with `"nhgVal": true`) can be looked up here. Enumerated NHG answers (the answer to any measurements with `"nhgVal": true`) can be looked up here.
type: object type: object
additionalProperties: true additionalProperties: true
example: |- example:
{ "48": "Huisarts"
"48": "Huisarts",
"49": "Specialist" "49": "Specialist"
}
icpcs: icpcs:
description: |- description: |-
Represents diagnoses and medical conditions, based on the ICPC1.1-NL standard. Keys in this object represent ICPC codes, always Represents diagnoses and medical conditions, based on the ICPC1.1-NL standard. Keys in this object represent ICPC codes, always
@ -39,25 +34,18 @@ properties:
containing the dutch human readable name of the class (the letter). containing the dutch human readable name of the class (the letter).
type: object type: object
additionalProperties: true additionalProperties: true
example: |- example:
{ "T90.02":
"T90.02": { "text": "Diabetes mellitus type 2"
"text": "Diabetes mellitus type 2",
"classText": "Endocriene klieren/metabol./voeding" "classText": "Endocriene klieren/metabol./voeding"
}
}
atcs: atcs:
description: |- description: |-
Represents medications, mapping ATC codes to value objects containing one k/v pair: `"text"` to a dutch human readable 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). description of the medication. The ATC codes may represent groups of medications (less than 7 characters).
type: object type: object
additionalProperties: true additionalProperties: true
example: |- example:
{ "A02AB":
"A02AB": {
"text": "Aluminiumverbindingen" "text": "Aluminiumverbindingen"
}, "A11GA01":
"A11GA01": {
"text": "Ascorbinezuur" "text": "Ascorbinezuur"
}
}
Loading…
Cancel
Save