diff --git a/zoo-api.yaml b/zoo-api.yaml index a7018c8..7a27a2c 100644 --- a/zoo-api.yaml +++ b/zoo-api.yaml @@ -66,6 +66,49 @@ paths: items: type: string + /patient/dossier: + get: + tags: + - patient + summary: Get detailed medical dossier info for the stated patient + parameters: + - name: bsn + in: query + description: |- + The SSN (dutch: _BSN_) of a patient to look up. May only contain digits, cannot contain more than 9 digits, and cannot be 0. + Either `bsn` or `pu` must be present. + schema: + type: string + example: 123456789 + - name: pu + in: query + description: |- + The Patient unique ID, as e.g. reported by `/patient/base`'s `pat_unid` response. + Either `bsn` or `pu` must be present. + schema: + type: string + example: "" + - name: q + in: query + description: |- + A space, comma, or bar-separated list of dossier aspects to query. If omitted, everything is returned. + The keys match the keys in the JSON structure that is returned on a success, such as `medication` or `measurements`. + schema: + type: string + example: "medication,measurements" + responses: + '200': + description: Detailed medical dossier information for the patient is returned. + content: + application/json: + schema: + type: object + properties: + tbd: + description: |- + Work in progress + type: string + example: Work in progress /patient/base: get: tags: