optionality of response values was registered both in the description and via the `required: ` key.

Removed the `*OPTIONAL*` in the descriptions.
EH/population-statistics-authorisation
Reinier Zwitserloot 2 years ago
parent d2717bb276
commit 8b1961b5b0
No known key found for this signature in database
GPG Key ID: DADEDCAA42950296

@ -13,7 +13,7 @@ properties:
example: 'RAYNAUD, FENOMEEN' example: 'RAYNAUD, FENOMEEN'
when: when:
description: |- description: |-
*OPTIONAL* If present, the date when this contraindication was registered. If present, the date when this contraindication was registered.
type: string type: string
format: date format: date
example: "2019-02-05" example: "2019-02-05"

@ -31,7 +31,7 @@ properties:
example: KNO example: KNO
episode: episode:
description: |- description: |-
*OPTIONAL* An ICPC code (formatted as e.g. `X99.12`) representing the problem or chronic illness that serves as context for this correspondence. An ICPC code (formatted as e.g. `X99.12`) representing the problem or chronic illness that serves as context for this correspondence.
Not all correspondence can be directly related to an ICPC code, and many source systems fundamentally do not allow linking correspondence to Not all correspondence can be directly related to an ICPC code, and many source systems fundamentally do not allow linking correspondence to
a given medical issue. Hence, this field is usually blank. a given medical issue. Hence, this field is usually blank.

@ -26,7 +26,7 @@ properties:
example: 1900-01-01 example: 1900-01-01
end: end:
description: |- description: |-
*OPTIONAL* If the episode has been determined to no longer be relevant (for example, cured), the date when the episode was closed. If the episode has been determined to no longer be relevant (for example, cured), the date when the episode was closed.
type: string type: string
format: date format: date
example: "2022-12-31" example: "2022-12-31"
@ -39,7 +39,7 @@ properties:
example: "2022-10-20" example: "2022-10-20"
description: description:
description: |- description: |-
*OPTIONAL* Most HIS source systems default the 'description' of an episode to the standard description for the provided ICPC, but allow the Most HIS source systems default the 'description' of an episode to the standard description for the provided ICPC, but allow the
practitioner to change this description. practitioner to change this description.
type: string type: string
example: "Geboorte dochter" example: "Geboorte dochter"

@ -23,7 +23,7 @@ properties:
example: "2023-02-28" example: "2023-02-28"
invoice: invoice:
description: |- description: |-
*OPTIONAL* If this feat has been declared, the invoice id that declared it. Not all source systems track this, and generally If this feat has been declared, the invoice id that declared it. Not all source systems track this, and generally
invoices aren't instantly sent as feats are registered. Thus, if this field isn't provided, either the feat hasn't been invoiced yet, invoices aren't instantly sent as feats are registered. Thus, if this field isn't provided, either the feat hasn't been invoiced yet,
or the source system doesn't track invoicing, or the GP office doesn't use the source system for invoicing. or the source system doesn't track invoicing, or the GP office doesn't use the source system for invoicing.
type: string type: string

@ -6,7 +6,7 @@ required:
properties: properties:
icpc: icpc:
description: |- description: |-
*OPTIONAL* An ICPC1.1-NL code representing the nature of this journal note. Does not necessarily mean the patient suffers from the condition An ICPC1.1-NL code representing the nature of this journal note. Does not necessarily mean the patient suffers from the condition
this ICPC represents. For example, a patient that comes in asking questions about signs of Diabetes would have journal text with ICPC `"T90.02"`, this ICPC represents. For example, a patient that comes in asking questions about signs of Diabetes would have journal text with ICPC `"T90.02"`,
even if tests show they clearly do not have Diabetes Mellitus. even if tests show they clearly do not have Diabetes Mellitus.
@ -16,7 +16,7 @@ properties:
example: "A97.00" example: "A97.00"
episode: episode:
description: |- description: |-
*OPTIONAL* An ICPC1.1-NL code representing the problem / chronic illness that this journal note has been filed under. An ICPC1.1-NL code representing the problem / chronic illness that this journal note has been filed under.
In our experience the difference between `icpc` and `episode` are not well demarkated and practitioners do not necessarily use these fields In our experience the difference between `icpc` and `episode` are not well demarkated and practitioners do not necessarily use these fields
for their intended purpose. We suggest making no distinction between these 2 fields and accepting instead that this means journal text for their intended purpose. We suggest making no distinction between these 2 fields and accepting instead that this means journal text
@ -84,7 +84,7 @@ properties:
example: C example: C
code: code:
description: |- description: |-
*OPTIONAL* If present, a short code representing a specific kind of action, such as a referral (`VER` - from dutch _Verwijzing_), If present, a short code representing a specific kind of action, such as a referral (`VER` - from dutch _Verwijzing_),
`H` for medication recipe refill (dutch: _Herhaalrecept_), `REC` for prescribing a recipe, `LAB` for processing laboratory results, `H` for medication recipe refill (dutch: _Herhaalrecept_), `REC` for prescribing a recipe, `LAB` for processing laboratory results,
or `BVO` for a nationally organized checkup such as for Cervical Cancer (from dutch: _Bevolkingsonderzoek_). or `BVO` for a nationally organized checkup such as for Cervical Cancer (from dutch: _Bevolkingsonderzoek_).

@ -28,7 +28,7 @@ properties:
example: KREAOMK example: KREAOMK
source_code: source_code:
description: |- description: |-
*OPTIONAL* If the source system uses a different code to represent this measurement in its own system, it is listed here. 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 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. represent registration of patient's smoking behaviour.
@ -58,7 +58,7 @@ properties:
example: 48 example: 48
comment: comment:
description: |- description: |-
*OPTIONAL* Some source systems allow adding a comment to any measurement; if one is present, it is provided here. 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 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. the result in these fields.

@ -52,17 +52,17 @@ properties:
example: "CUTISOFT NWK ST 10X10 48851" example: "CUTISOFT NWK ST 10X10 48851"
pharmacy: pharmacy:
description: |- description: |-
*OPTIONAL* If automatically sent to a specific pharmacy, some source-system custom coding that indicates which pharmacy it was sent to. If automatically sent to a specific pharmacy, some source-system custom coding that indicates which pharmacy it was sent to.
type: string type: string
example: AN example: AN
usageCode: usageCode:
description: |- description: |-
*OPTIONAL* A coded description of how to use this medication. Depends on source HIS software; sometimes even on the individual configuration of A coded description of how to use this medication. Depends on source HIS software; sometimes even on the individual configuration of
a practice's HIS or that practice's regional server; these values aren't normalized, and sometimes not available at all. a practice's HIS or that practice's regional server; these values aren't normalized, and sometimes not available at all.
type: string type: string
example: 1D1T example: 1D1T
usageText: usageText:
description: |- description: |-
*OPTIONAL* Human-readable (dutch) description of how to use this medication. Depends on source HIS software and often not available at all. Human-readable (dutch) description of how to use this medication. Depends on source HIS software and often not available at all.
type: string type: string
example: Gebruik bekend example: Gebruik bekend

Loading…
Cancel
Save