Wandering date definitions replaced by reference to schema of date.

EH/population-statistics-authorisation
Eric Hoekstra 2 years ago
parent e30e8154c9
commit ebfed91296

@ -52,7 +52,7 @@ get:
- $ref: '../zoo-api.yaml#/components/parameters/Authorization' - $ref: '../zoo-api.yaml#/components/parameters/Authorization'
responses: responses:
'200': '200':
description: All patients where funduscopy status is relevant is returned. description: All patients where funduscopy status is relevant are returned.
content: content:
application/json: application/json:
schema: schema:
@ -77,13 +77,12 @@ get:
A human readable name describing the care group being queried (The entity whose AGB code is sent as `agb`). A human readable name describing the care group being queried (The entity whose AGB code is sent as `agb`).
type: string type: string
refDate: refDate:
$ref: ../schemas/date.yaml
example: '2024-04-01'
description: |- description: |-
The date used for all calculations: Any time spans are relative to this date, any measurement requirements The date used for all calculations: Any time spans are relative to this date, any measurement requirements
as stated in the care group's policies such as 'must be registered every year or cannot be considered' are applied as stated in the care group's policies such as 'must be registered every year or cannot be considered' are applied
to this date, anything that occured after this date is ignored. to this date, anything that occured after this date is ignored.
type: string
format: date
example: '2024-04-01'
practices: practices:
description: |- description: |-
One entry for each practice that is part of this care group and participates in at least one funduscopy-related care program. One entry for each practice that is part of this care group and participates in at least one funduscopy-related care program.

@ -56,12 +56,11 @@ get:
dict: dict:
$ref: '../schemas/TermsDictionary.yaml' $ref: '../schemas/TermsDictionary.yaml'
refDate: refDate:
$ref: ../schemas/date.yaml
description: |- description: |-
The date used for all calculations: Any time spans are relative to this date, any measurement requirements The date used for all calculations: Any time spans are relative to this date, any measurement requirements
as stated in the care group's policies such as 'must be registered every year or cannot be considered' are applied as stated in the care group's policies such as 'must be registered every year or cannot be considered' are applied
to this date, anything that occured after this date is ignored. to this date, anything that occured after this date is ignored.
type: string
format: date
example: '2024-04-01' example: '2024-04-01'
practice: practice:
$ref: "../schemas/fundus-status.yaml" $ref: "../schemas/fundus-status.yaml"

@ -18,9 +18,7 @@ get:
The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`. The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`.
required: false required: false
schema: schema:
type: string $ref: ../schemas/date.yaml
format: date
example: 2023-04-01
- name: addr - name: addr
in: query in: query
required: false required: false
@ -138,8 +136,7 @@ get:
format: int32 format: int32
description: The BSN (dutch social security number) of the patient. description: The BSN (dutch social security number) of the patient.
dob: dob:
type: string $ref: ../schemas/date.yaml
format: date
description: Date of birth of the patient. description: Date of birth of the patient.
email: email:
type: string type: string

@ -23,9 +23,7 @@ get:
The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`. The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`.
required: false required: false
schema: schema:
type: string $ref: ../schemas/date.yaml
format: date
example: 2023-04-01
- $ref: '../zoo-api.yaml#/components/parameters/CareGroup' - $ref: '../zoo-api.yaml#/components/parameters/CareGroup'
- $ref: '../zoo-api.yaml#/components/parameters/Authorization' - $ref: '../zoo-api.yaml#/components/parameters/Authorization'
responses: responses:

@ -22,9 +22,7 @@ get:
The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`. The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`.
required: false required: false
schema: schema:
type: string $ref: ../schemas/date.yaml
format: date
example: 2023-04-01
- $ref: '../zoo-api.yaml#/components/parameters/Authorization' - $ref: '../zoo-api.yaml#/components/parameters/Authorization'
responses: responses:
'200': '200':

@ -16,9 +16,7 @@ get:
The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`. The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`.
required: false required: false
schema: schema:
type: string $ref: ../schemas/date.yaml
format: date
example: 2023-04-01
- $ref: '../zoo-api.yaml#/components/parameters/Authorization' - $ref: '../zoo-api.yaml#/components/parameters/Authorization'
responses: responses:
'200': '200':

@ -9,9 +9,7 @@ get:
The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`. The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`.
required: false required: false
schema: schema:
type: string $ref: ../schemas/date.yaml
format: date
example: 2023-04-01
responses: responses:
'200': '200':
description: >- description: >-
@ -23,9 +21,7 @@ get:
properties: properties:
refDate: refDate:
description: 'Groups reported are available for this date (dutch: _peildatum_).' description: 'Groups reported are available for this date (dutch: _peildatum_).'
type: string $ref: ../schemas/date.yaml
format: date
example: 2023-04-01
groups: groups:
description: A list of available groups. description: A list of available groups.
type: array type: array

@ -23,9 +23,7 @@ get:
The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`. The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`.
required: false required: false
schema: schema:
type: string $ref: ../schemas/date.yaml
format: date
example: 2023-04-01
responses: responses:
'200': '200':
description: >- description: >-
@ -47,9 +45,7 @@ get:
example: 2023-04-01T12:30:00.000Z example: 2023-04-01T12:30:00.000Z
refDate: refDate:
description: 'Groups reported are available for this date (dutch: _peildatum_).' description: 'Groups reported are available for this date (dutch: _peildatum_).'
type: string $ref: ../schemas/date.yaml
format: date
example: 2023-04-01
key: key:
description: Repeats the `setKey` parameter, if present. description: Repeats the `setKey` parameter, if present.
type: string type: string

@ -19,9 +19,7 @@ properties:
example: Diabetes Mellitus type 2 per InEen 2023 accreditatie example: Diabetes Mellitus type 2 per InEen 2023 accreditatie
refDate: refDate:
description: 'All calculations are done based on this date (dutch: _peildatum_).' description: 'All calculations are done based on this date (dutch: _peildatum_).'
type: string $ref: ./date.yaml
format: date
example: 2023-04-01
calculating: calculating:
description: |- description: |-
Calculating an indicator set report takes some time; this API responds with a `calculating` value of less than 1.0 and Calculating an indicator set report takes some time; this API responds with a `calculating` value of less than 1.0 and

@ -117,8 +117,7 @@ patid:
patUnid: patUnid:
$ref: 'pat-patUnid.yaml' $ref: 'pat-patUnid.yaml'
startDate: startDate:
type: string $ref: ./date.yaml
format: date
description: |- description: |-
Date patient joined the practice (dutch: _inschrijf datum_). Date patient joined the practice (dutch: _inschrijf datum_).
@ -128,8 +127,7 @@ startDate:
back you want to go). back you want to go).
example: 1994-08-20 example: 1994-08-20
endDate: endDate:
type: string $ref: ./date.yaml
format: date
description: |- description: |-
If present, patient has exited the practice on this date. (dutch: _uitschrijf datum_). If present, patient has exited the practice on this date. (dutch: _uitschrijf datum_).
default: "" default: ""

@ -110,8 +110,7 @@ properties:
The date of the last time the patient has received Funduscopy; will be `null` if no funduscopy is registered. 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. The most recent measurement date is provided, even if only one eye was measured on that date.
type: string $ref: ./date.yaml
format: date
retinoVal: retinoVal:
description: |- description: |-
The normalized retinopathy category for the worst eye, in terms of the 2017 Retinopathy level standard (richtlijn Diabetische Retinopathie 2017). The normalized retinopathy category for the worst eye, in terms of the 2017 Retinopathy level standard (richtlijn Diabetische Retinopathie 2017).
@ -135,8 +134,7 @@ properties:
properties: properties:
lastEval: lastEval:
description: Same as previous level, specifically for left eye. description: Same as previous level, specifically for left eye.
type: string $ref: ./date.yaml
format: date
retinoVal: retinoVal:
description: Same as previous level, specifically for left eye. description: Same as previous level, specifically for left eye.
type: integer type: integer
@ -171,8 +169,7 @@ properties:
- retinoVal - retinoVal
properties: properties:
lastEval: lastEval:
type: string $ref: ./date.yaml
format: date
retinoVal: retinoVal:
type: integer type: integer
format: int32 format: int32

@ -14,6 +14,4 @@ properties:
when: when:
description: |- description: |-
If present, the date when this contraindication was registered. If present, the date when this contraindication was registered.
type: string $ref: ../date.yaml
format: date
example: "2019-02-05"

@ -19,9 +19,7 @@ properties:
when: when:
description: |- description: |-
The date when this correspondence was received or sent. The date when this correspondence was received or sent.
type: string $ref: ../date.yaml
format: date
example: "2023-03-31"
speciality_code: speciality_code:
description: |- description: |-
A short memocode representing the speciality of `other`. For example, `"OOG"` (eye specialist), `"CHI"` (Surgery), etc. Often blank. A short memocode representing the speciality of `other`. For example, `"OOG"` (eye specialist), `"CHI"` (Surgery), etc. Often blank.

@ -21,22 +21,16 @@ properties:
Always provided, but may contain the sentinel value of `1900-01-01` if the source doesn't have a start date. Generally Always provided, but may contain the sentinel value of `1900-01-01` if the source doesn't have a start date. Generally
such episodes are to be treated as having always been part of the patient's dossier. such episodes are to be treated as having always been part of the patient's dossier.
type: string $ref: ../date.yaml
format: date
example: 1900-01-01
end: end:
description: |- description: |-
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 $ref: ../date.yaml
format: date
example: "2022-12-31"
mut: mut:
description: |- description: |-
The last time an event (for example, seeing the patient for chronic care related to this episode) was recorded in context of The last time an event (for example, seeing the patient for chronic care related to this episode) was recorded in context of
this episode. Is guaranteed to be present and will never be earlier than `start`. this episode. Is guaranteed to be present and will never be earlier than `start`.
type: string $ref: ../date.yaml
format: date
example: "2022-10-20"
description: description:
description: |- description: |-
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

@ -18,9 +18,7 @@ properties:
when: when:
description: |- description: |-
The stated feat was performed on this date. subscription style feats by convention always on the first day of a quarter. The stated feat was performed on this date. subscription style feats by convention always on the first day of a quarter.
format: date $ref: ../date.yaml
type: string
example: "2023-02-28"
invoice: invoice:
description: |- description: |-
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

@ -27,9 +27,7 @@ properties:
when: when:
description: |- description: |-
The date when this journal text was typed and registered. The date when this journal text was typed and registered.
type: string $ref: ../date.yaml
format: date
example: "2015-05-01"
s: s:
description: |- description: |-
The journal text as typed by the practitioner for the 'S' field of SOAP (Subjective / Objective / Analysis / Plan). (Dutch: _S_ / _Subjectief_). The journal text as typed by the practitioner for the 'S' field of SOAP (Subjective / Objective / Analysis / Plan). (Dutch: _S_ / _Subjectief_).

@ -39,9 +39,7 @@ properties:
Date when this measurement was done. In practice it may instead represent the date when the measurement was registered 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 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. distinguish the nature of the date.
type: string $ref: ../date.yaml
format: date
example: "2023-04-30"
value: value:
description: |- description: |-
The value of the measurement. Normalized and NHG compatible if possible. For example, enumerated values (such as for `DMHBKZ` which The value of the measurement. Normalized and NHG compatible if possible. For example, enumerated values (such as for `DMHBKZ` which

@ -18,9 +18,7 @@ properties:
but was picked up by the patient. but was picked up by the patient.
We advise coalescing `prescribed` and `delivered`, as this guarantees an actual date. We advise coalescing `prescribed` and `delivered`, as this guarantees an actual date.
type: string $ref: ../date.yaml
format: date
example: "2023-03-27"
delivered: delivered:
description: |- description: |-
If present, the date when the patient received this medication (usually, because they picked it up at a pharmacy). Not all pharmacies are If present, the date when the patient received this medication (usually, because they picked it up at a pharmacy). Not all pharmacies are
@ -28,9 +26,7 @@ properties:
entity that filled the prescription does not relay this to the source system. entity that filled the prescription does not relay this to the source system.
At least one of `prescribed` and `delivered` is guaranteed to have a value. At least one of `prescribed` and `delivered` is guaranteed to have a value.
type: string $ref: ../date.yaml
format: date
example: "2023-03-28"
prescriber: prescriber:
$ref: "Practitioner.yaml" $ref: "Practitioner.yaml"
end: end:
@ -40,9 +36,7 @@ properties:
If not present, this isn't the kind of medication that is designed to be used until symptoms fade or is no longer needed, or, If not present, this isn't the kind of medication that is designed to be used until symptoms fade or is no longer needed, or,
our normalization systems aren't capable of normalizing the dosage/form into a meaningful end date. our normalization systems aren't capable of normalizing the dosage/form into a meaningful end date.
type: string $ref: ../date.yaml
format: date
example: "2023-04-14"
description: description:
description: |- description: |-
This field is usually initialized with a general dutch name for the medication, but can be overwritten with custom text by the prescriber. This field is usually initialized with a general dutch name for the medication, but can be overwritten with custom text by the prescriber.

@ -3,7 +3,5 @@ description: |-
Note that by convention, patients whose birthdate is unknown (rare, but can happen in certain asylum seeker cases) Note that by convention, patients whose birthdate is unknown (rare, but can happen in certain asylum seeker cases)
pick a date and tend to pick either `xxxx-01-01` or `xxxx-07-01`. Can, in rare cases, be unavailable - if birth date is not known. pick a date and tend to pick either `xxxx-01-01` or `xxxx-07-01`. Can, in rare cases, be unavailable - if birth date is not known.
type: string $ref: ./date.yaml
format: date
example: 1970-07-01

@ -137,9 +137,7 @@ components:
use this date as reference, and so forth). use this date as reference, and so forth).
Defaults to today. Defaults to today.
schema: schema:
type: string $ref: schemas/date.yaml
format: date
example: '2024-04-01'
CareGroup: CareGroup:
name: group name: group
in: query in: query

Loading…
Cancel
Save