You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
54 lines
2.3 KiB
YAML
54 lines
2.3 KiB
YAML
get:
|
|
tags:
|
|
- patient
|
|
summary: Get detailed medical dossier info for the stated patient
|
|
description: |-
|
|
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
|
|
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
|