$dump-csv
Dump resource in CSV format
$dump-csv operation dumps resource data in Aidbox format as CSV (RFC4180). In this format, columns are paths to JSON values and Rows are values. It includes the header.
Neither the specific order of columns nor the order of rows is guaranteed.
$dump-csv is an Aidbox-only endpoint. It is available at /<ResourceType>/$dump-csv and is not available at /fhir/<ResourceType>/$dump-csv. Requests to the /fhir/ prefixed path will return a 404 error.
GET [base]/<resourceType>/$dump-csv
| URL Parameter | Description |
|---|---|
resourceType | Type of the resource to dump |
Examples
Dump patients in CSV
Rest Console
GET /Patient/$dump-csv
Curl
$ curl "$AIDBOX_BASE/Patient/\$dump-csv" \
-H 'authorization: Basic YnVsay1jbGllbnQ6c2VjcmV0'
Status
200 OK
Headers
| Header | Value |
|---|---|
| Content-Type | text/csv |
| Transfer-Encoding | chunked |
Body
citizenship.0.code.text,id,name.0.given.0,resourceType
,pt-1,Alice,Patient
,pt-2,Bob,Patient
ru,pt-3,Charles,Patient
Body as table
| citizenship.0.code.text | id | name.0.given.0 | resourceType |
|---|---|---|---|
| pt-1 | Alice | Patient | |
| pt-2 | Bob | Patient | |
| ru | pt-3 | Charles | Patient |
Dump Appointments in CSV
REST Console
GET /Appointment/$dump-csv
Curl
curl -u bulk-client:secret $AIDBOX_BASE_URL/Appointment/\$dump-csv
Status
200 OK
Headers
| Header | Value |
|---|---|
| Content-Type | text/csv |
| Transfer-Encoding | chunked |
Body
id,participant.0.actor.id,participant.0.actor.resourceType,participant.0.status,resourceType,status
ap-1,pt-1,Patient,accepted,Appointment,fulfilled
ap-2,pt-1,Patient,accepted,Appointment,booked
ap-3,pt-2,Patient,accepted,Appointment,fulfilled
Body as table
| id | participant.0.actor.id | participant.0.actor.resourceType | participant.0.status | resourceType | status |
|---|---|---|---|---|---|
| ap-1 | pt-1 | Patient | accepted | Appointment | fulfilled |
| ap-2 | pt-1 | Patient | accepted | Appointment | booked |
| ap-3 | pt-2 | Patient | accepted | Appointment | fulfilled |