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.
61 lines
2.7 KiB
YAML
61 lines
2.7 KiB
YAML
get:
|
|
operationId: exportsAvailable
|
|
tags:
|
|
- GPIS exports
|
|
summary: List available exports
|
|
responses:
|
|
'200':
|
|
description: |-
|
|
Lists all available GPIS export snapshots.
|
|
A GPIS export snapshot contains parts of medical dossier info for a subset of all patients in a GP practice. Exactly which filters are applied,
|
|
which data is provided, and how it is formatted is arranged between Zorg op Orde and a party using the ZOO API.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
exportSources:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
agb:
|
|
$ref: ../schemas/agb.yaml
|
|
name:
|
|
type: string
|
|
description: Name of the GP practice
|
|
available:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
filename:
|
|
type: string
|
|
description: |-
|
|
This filename can be used in the `/agb/filename` endpoint to fetch this data.
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: |-
|
|
The export contains data sourced from an EPD system at this time; it will not
|
|
contain any medical dossier data later than this timestamp.
|
|
tables:
|
|
type: array
|
|
description: |-
|
|
Lists the names of all tables that are provided as part of this export.<br />
|
|
If using the <a href="#tag/Exports/operation/exportsDownload">fetch as zip</a> endpoint, the zip will contain an entry named <code><em>that_name</em>.csv</code>.<br />
|
|
If using the <a href="#tag/Exports/operation/exportsDownloadPerTable">fetch each table individually</a> endpoint, this name represents a table name you can ask for.
|
|
items:
|
|
type: string
|
|
required:
|
|
- filename
|
|
- timestamp
|
|
- tables
|
|
required:
|
|
- agb
|
|
- name
|
|
- available
|
|
'401':
|
|
$ref: '../zoo-api.yaml/#/components/responses/NoAuth'
|
|
'403':
|
|
$ref: '../zoo-api.yaml/#/components/responses/NoAccess' |