diff --git a/paths/qoc_careprogram.yaml b/paths/qoc_careprogram.yaml index a7173a3..0481ee9 100644 --- a/paths/qoc_careprogram.yaml +++ b/paths/qoc_careprogram.yaml @@ -21,9 +21,10 @@ get: type: object properties: programs: + description: The kind of chronic care that this care program caters to. Can be omitted in cases where this care program doesn't cover a generally accepted protocollized chronic care condition (Often, new research). type: array items: - $ref: '../schemas/CareProgram.yaml' + $ref: '../schemas/CareProgram-enum.yaml' '401': $ref: '../zoo-api.yaml/#/components/responses/NoAuth' '403': diff --git a/paths/qoc_checkupList_set_status.yaml b/paths/qoc_checkupList_set_status.yaml index 6759463..9dd6059 100644 --- a/paths/qoc_checkupList_set_status.yaml +++ b/paths/qoc_checkupList_set_status.yaml @@ -22,6 +22,8 @@ post: type: object properties: careprogram: + description: |- + The kind of chronic care that this care program caters to. Can be omitted in cases where this care program doesn't cover a generally accepted protocollized chronic care condition (Often, new research). $ref: '../schemas/CareProgram-enum.yaml' callUpStatus: $ref: '../schemas/callUpStatus-enum.yaml' diff --git a/schemas/CareProgram-enum.yaml b/schemas/CareProgram-enum.yaml index b19a10e..97be9e2 100644 --- a/schemas/CareProgram-enum.yaml +++ b/schemas/CareProgram-enum.yaml @@ -1,8 +1,5 @@ description: |- - The kind of chronic care that this care program caters to. Can be omitted in cases where this care program doesn't cover a generally - accepted protocollized chronic care condition (Often, new research). - - _WARNING_: HVZ and VVR are being debated; this really is a single care program (probably called `CVRM`). This may change soon. + _WARNING_: HVZ and VVR are being debated; this really is a single care program (probably called CVRM). This may change soon. _NOTE_: This list is expanded any time new care programs are introduced. API callers are encouraged not to hardcode the list of enumerated values, or at least be prepared to accept other values. @@ -14,7 +11,7 @@ description: |-