---
title: "Anonymize study"
method: POST
path: "/studies/{id}/anonymize"
tags: ["Studies"]
---

# Anonymize study

`POST /studies/{id}/anonymize`

Start a job that will anonymize all the DICOM instances within the study whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new study, whose Orthanc identifiers will be returned by the job. https://orthanc.uclouvain.be/book/users/anonymization.html#anonymization-of-patients-studies-or-series

## Path parameters

- `id` string, required

## Request body

- object
  - `Asynchronous` boolean — If `true`, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.
  - `DicomVersion` string — Version of the DICOM standard to be used for anonymization. Check out configuration option `DeidentifyLogsDicomVersion` for possible values.
  - `Force` boolean — Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
  - `Keep` string[] — List of DICOM tags whose value must not be destroyed by the anonymization. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the `dcmodify` command-line tool (wildcards are supported as well).
  - `KeepLabels` boolean — Keep the labels of all resources level (defaults to `false`)
  - `KeepPrivateTags` boolean — Keep the private tags from the DICOM instances (defaults to `false`)
  - `KeepSource` boolean — If set to `false`, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.
  - `LossyQuality` number — If transcoding to a lossy transfer syntax, this entry defines the quality as an integer between 1 and 100. If not provided, the value is defined by the "DicomLossyTranscodingQuality" configuration. (new in v1.12.7)
  - `Permissive` boolean — If `true`, ignore errors during the individual steps of the job. Default value is `false`.
  - `Priority` number — In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is `0`
  - `PrivateCreator` string — The private creator to be used for private tags in `Replace`
  - `Remove` string[] — List of additional tags to be removed from the DICOM instances. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the `dcmodify` command-line tool (wildcards are supported as well).
  - `Replace` object — Associative array to change the value of some DICOM tags in the DICOM instances. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the `dcmodify` command-line tool (wildcards are supported as well).
  - `Synchronous` boolean — If `true`, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is *not* desirable for long jobs, as it might lead to network timeouts.
  - `Transcode` string — Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
  - `UserData` object — User data that will travel along with the job.

## Response `200`

- object
  - `ID` string — In asynchronous mode, identifier of the job
  - `Path` string — In asynchronous mode, path to access the job in the REST API

---

[API](https://skmtc.net/uclouvain/apis/orthanc-api.md) · [All operations](https://skmtc.net/uclouvain/apis/orthanc-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uclouvain/orthanc-api/versions/9297c4930d96/schema)