diff --git a/examples/patient_base.1.json b/examples/patient_base.1.json index a6ff7f6..ab6dd2e 100644 --- a/examples/patient_base.1.json +++ b/examples/patient_base.1.json @@ -35,5 +35,14 @@ }, "patid": 1234, "pat_unid": "1234", - "start_date": "1994-08-20" -} \ No newline at end of file + "start_date": "1994-08-20", + "careprograms": { + "principal": [ + "dm", + "copd" + ], + "auxiliary": [ + "vvr" + ] + } +} diff --git a/paths/patient_base.yaml b/paths/patient_base.yaml index e781511..78836f5 100644 --- a/paths/patient_base.yaml +++ b/paths/patient_base.yaml @@ -63,6 +63,8 @@ get: $ref: '../schemas/PatIdentity.yaml#/end_date' end_reason: $ref: '../schemas/PatIdentity.yaml#/end_reason' + careprograms: + $ref: '../schemas/PatIdentity.yaml#/careprograms' '400': description: The request is invalid; for example, it doesn't contain the required `BSN` parameter. '401': diff --git a/schemas/PatIdentity.yaml b/schemas/PatIdentity.yaml index b437386..b70a7ed 100644 --- a/schemas/PatIdentity.yaml +++ b/schemas/PatIdentity.yaml @@ -232,3 +232,47 @@ end_reason: * `X` = Other type: string default: "" +careprograms: + type: object + properties: + principal: + description: |- + A list of keys (strings) describing which care programs this patient + is actively receiving (they have been diagnosed or marked for inclusion in + the program, _and_ they are marked as receiving this care via the GP (not a specialist), + _and_ they are marked as being actively enrolled in a chronic care program for it). + + A program is considered _principal_ (in contrast to _auxiliary_) if no other program + the patient is actively participating in supersedes it (even partially). + + The list of possible care program values can change; we advise treating this value as + a plain string and not an enum hardcoded in your codebase. + + Note that careprogram inclusion depends on a GP practice's processes; if Zorg op Orde + has not been informed about these, no care programs will be reported. + + Currently, the set of possible values is + - dm + - copd + - astma + - hvz + - vvr + - ouderenzorg + - atriumfibrilleren + - hartfalen + - dermatoscopie + - fractuurpreventie + - ecg + type: array + items: + type: string + example: ["dm", "copd"] + auxiliary: + description: |- + Just like _principal_, except, all programs listed here are incompletely applied + because another program the patient participates in covers some or all of the care + implied by this program, and this program is treated as the auxiliary one. + type: array + items: + type: string + example: ["vvr"]