diff --git a/paths/patient_dossier.yaml b/paths/patient_dossier.yaml index 7767f99..240832b 100644 --- a/paths/patient_dossier.yaml +++ b/paths/patient_dossier.yaml @@ -6,6 +6,13 @@ get: WorkInProgress: The API will require you to provide (as parameters) the purpose of the request and potentially the person on whose authority this request is being made, which will be logged and reviewed for the _Principle of Least Privilege_ policy. + + Known design parameters: + - send along the date on which the result is based (HIS snapshot date) + - Sender must send a key (or list of keys) representing the context, such as 'DM', 'Obesitas', 'Dietetiek', etc. We combine the targeted data (the GP or zorggroep) with these keys to know precisely what we filter (we do not just return all medical dossier data). + - uptime is important; these API calls are done live as patients show. + - q - edit it a bit, can be for example 'dm' or even 'dm/dietetiek'. Send all relevant parts in one response. + - required response categories: Journaal, Bepalingen, Medicatie, episodes. parameters: - name: bsn in: query