# UCLouvain Patients API

**Canonical:** https://apis.io/apis/uclouvain/uclouvain-patients-api/  
**Provider:** UCLouvain — https://apis.io/providers/uclouvain/  
**Base URL:** https://orthanc.uclouvain.be/demo/  
**Documentation:** https://orthanc.uclouvain.be/

UCLouvain Patients API is one of 18 APIs that [UCLouvain](https://apis.io/providers/uclouvain/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Patients. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

The Patients API from UCLouvain — 32 operation(s) for patients.

## Operations (41)

| Method | Path | Summary |
|---|---|---|
| GET | `/patients` | List the available patients |
| DELETE | `/patients/{id}` | Delete some patient |
| GET | `/patients/{id}` | Get information about some patient |
| POST | `/patients/{id}/anonymize` | Anonymize patient |
| GET | `/patients/{id}/archive` | Create ZIP archive |
| POST | `/patients/{id}/archive` | Create ZIP archive |
| GET | `/patients/{id}/attachments` | List attachments |
| DELETE | `/patients/{id}/attachments/{name}` | Delete attachment |
| PUT | `/patients/{id}/attachments/{name}` | Set attachment |
| POST | `/patients/{id}/attachments/{name}/compress` | Compress attachment |
| GET | `/patients/{id}/attachments/{name}/compressed-data` | Get attachment (no decompression) |
| GET | `/patients/{id}/attachments/{name}/compressed-md5` | Get MD5 of attachment on disk |
| GET | `/patients/{id}/attachments/{name}/compressed-size` | Get size of attachment on disk |
| GET | `/patients/{id}/attachments/{name}/data` | Get attachment |
| GET | `/patients/{id}/attachments/{name}/info` | Get info about the attachment |
| GET | `/patients/{id}/attachments/{name}/is-compressed` | Is attachment compressed? |
| GET | `/patients/{id}/attachments/{name}/md5` | Get MD5 of attachment |
| GET | `/patients/{id}/attachments/{name}/size` | Get size of attachment |
| POST | `/patients/{id}/attachments/{name}/uncompress` | Uncompress attachment |
| POST | `/patients/{id}/attachments/{name}/verify-md5` | Verify attachment |
| GET | `/patients/{id}/instances` | Get child instances |
| GET | `/patients/{id}/instances-tags` | Get tags of instances |
| GET | `/patients/{id}/labels` | List labels |
| DELETE | `/patients/{id}/labels/{label}` | Remove label |
| GET | `/patients/{id}/labels/{label}` | Test label |
| PUT | `/patients/{id}/labels/{label}` | Add label |
| GET | `/patients/{id}/media` | Create DICOMDIR media |
| POST | `/patients/{id}/media` | Create DICOMDIR media |
| GET | `/patients/{id}/metadata` | List metadata |
| DELETE | `/patients/{id}/metadata/{name}` | Delete metadata |
| GET | `/patients/{id}/metadata/{name}` | Get metadata |
| PUT | `/patients/{id}/metadata/{name}` | Set metadata |
| POST | `/patients/{id}/modify` | Modify patient |
| GET | `/patients/{id}/module` | Get patient module |
| GET | `/patients/{id}/protected` | Is the patient protected against recycling? |
| PUT | `/patients/{id}/protected` | Protect/Unprotect a patient against recycling |
| POST | `/patients/{id}/reconstruct` | Reconstruct tags & optionally files of patient |
| GET | `/patients/{id}/series` | Get child series |
| GET | `/patients/{id}/shared-tags` | Get shared tags |
| GET | `/patients/{id}/statistics` | Get patient statistics |
| GET | `/patients/{id}/studies` | Get child studies |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/openapi/uclouvain-patients-api-openapi.yml
- **x-openapi-original** — https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/openapi/_original/uclouvain-orthanc-api.json
- **APIReference** — https://orthanc.uclouvain.be/api/index.html
- **Documentation** — https://orthanc.uclouvain.be/book/
- **x-example** — https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/examples/uclouvain-orthanc-system-example.json

## Other UCLouvain APIs (12)

- [Open Data @ UCLouvain -- Dataverse deployment (Native + Search API)](https://apis.io/apis/uclouvain/dataverse-native-api/)
- [Open Data @ UCLouvain Dataverse OAI-PMH](https://apis.io/apis/uclouvain/dataverse-oai/)
- [DIAL.pr (BOREAL) -- DSpace-CRIS REST API](https://apis.io/apis/uclouvain/dial-pr-rest/)
- [DIAL.pr OAI-PMH](https://apis.io/apis/uclouvain/dial-pr-oai/)
- [DIAL.mem -- DSpace-CRIS REST API](https://apis.io/apis/uclouvain/dial-mem-rest/)
- [DIAL.mem OAI-PMH](https://apis.io/apis/uclouvain/dial-mem-oai/)
- [OER-UCLouvain OAI-PMH](https://apis.io/apis/uclouvain/oer-oai/)
- [UCLouvain Shibboleth Identity Provider -- SAML 2.0 metadata](https://apis.io/apis/uclouvain/identity-federation/)
- [UCLouvain Instances API](https://apis.io/apis/uclouvain/uclouvain-instances-api/)
- [UCLouvain Jobs API](https://apis.io/apis/uclouvain/uclouvain-jobs-api/)
- [UCLouvain Logs API](https://apis.io/apis/uclouvain/uclouvain-logs-api/)
- [UCLouvain Networking API](https://apis.io/apis/uclouvain/uclouvain-networking-api/)

## Tags

Patients

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/uclouvain/uclouvain-patients-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/uclouvain/.