Orthanc is an open-source, lightweight DICOM server for healthcare and
medical research. This R6 generator creates a client to access
Orthanc's RESTful API. More details about the Orthanc REST API can be
found here: https://orthanc.uclouvain.be/book/users/rest.html.
The full documentation of the Orthanc API can be found here: https://orthanc.uclouvain.be/api/.
Active bindings
num_instancesNumber of instances.
num_seriesNumber of series.
num_studiesNumber of studies.
num_patientsNumber of patients.
Methods
Method new()
Initialize a new Orthanc API Client
Usage
Orthanc$new(url, username = NULL, password = NULL, ...)Method GET()
GET request with specified route
Method DELETE()
DELETE to specified route
Method POST()
POST to specified route
Usage
Orthanc$POST(
route,
file = NULL,
json = NULL,
data = NULL,
params = NULL,
headers = NULL,
cookies = NULL
)Method PUT()
PUT to specified route
Usage
Orthanc$PUT(
route,
file = NULL,
json = NULL,
data = NULL,
params = NULL,
headers = NULL,
cookies = NULL
)Method stream()
Stream an HTTP response body and write to disk.
Method print()
Print method for Orthanc.
Method get_changes()
List changes
Whenever Orthanc receives a new DICOM instance, this event is recorded in the so-called Changes Log. This enables remote scripts to react to the arrival of new DICOM resources. A typical application is auto-routing, where an external script waits for a new DICOM instance to arrive into Orthanc, then forward this instance to another modality. Please note that, when resources are deleted, their corresponding change entries are also removed from the Changes Log, which helps ensuring that this log does not grow indefinitely.
Details
Optional query parameters (params):
last (number): Request only the last change id (this argument must be used alone)
limit (number): Limit the number of results
since (number): Show only the resources since the provided index excluded
to (number): Show only the resources till the provided index included (only available if your DB backend supports ExtendedChanges)
type (string): Show only the changes of the provided type (only available if your DB backend supports ExtendedChanges). Multiple values can be provided and must be separated by a ';'.
Method get_exports()
List exports
For medical traceability, Orthanc can be configured to store
a log of all the resources that have been exported to remote
modalities. In auto-routing scenarios, it is important to
prevent this log to grow indefinitely as incoming instances are
routed. You can either disable this logging by setting the option
LogExportedResources to FALSE in the configuration file, or
periodically clear this log by DELETE-ing this URI. This route
might be removed in future versions of Orthanc.
Method get_instances()
List the available instances
List the Orthanc identifiers of all the available DICOM instances
Details
Optional query parameters (params):
expand (string): If present, retrieve detailed information about the individual resources, not only their Orthanc identifiers
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
limit (number): Limit the number of results
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
response-content (string): Defines the content of response for each returned resource. Allowed values are
MainDicomTags,Metadata,Children,Parent,Labels,Status,IsStable,IsProtected,Attachments. If not specified, Orthanc will returnMainDicomTags,Metadata,Children,Parent,Labels,Status,IsStable,IsProtected.e.g: 'response-content=MainDicomTags;Children (new in Orthanc 1.12.5 - overridesexpand)short (boolean): If present, report the DICOM tags in hexadecimal format
since (number): Show only the resources since the provided index
Method post_instances()
Upload DICOM instances
Upload DICOM instances
Method delete_instances_id()
Delete some instance
Delete the DICOM instance whose Orthanc identifier is provided in the URL
Method get_instances_id()
Get information about some instance
Get detailed information about the DICOM instance whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the instance of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method post_instances_id_anonymize()
Anonymize instance
Download an anonymized version of the DICOM instance whose Orthanc identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/anonymization.html#anonymization-of-a-single-instance
Arguments
id(character) Orthanc identifier of the instance of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
DicomVersion (character): Version of the DICOM standard to be used for anonymization. Check out configuration option
DeidentifyLogsDicomVersionfor possible values.Force (logical): Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
Keep (list): 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
dcmodifycommand-line tool (wildcards are supported as well).KeepLabels (logical): Keep the labels of all resources level (defaults to
FALSE)KeepPrivateTags (logical): Keep the private tags from the DICOM instances (defaults to
FALSE)KeepSource (logical): If set to
FALSE, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.LossyQuality (numeric): 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)
PrivateCreator (character): The private creator to be used for private tags in
ReplaceRemove (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Replace (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Transcode (character): Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
Method get_instances_id_attachments()
List attachments
Get the list of attachments that are associated with the given instance
Arguments
id(character) Orthanc identifier of the instance of interest.
params(list) Named-list of optional query parameters. See Details.
Method delete_instances_id_attachments_name()
Delete attachment
Delete an attachment associated with the given DICOM instance. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_instances_id_attachments_name()
List operations on attachments
Get the list of the operations that are available for attachments associated with the given instance
Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method put_instances_id_attachments_name()
Set attachment
Attach a file to the given DICOM instance. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
data(bytes or character) Raw data for request body. See Details.
Method post_instances_id_attachments_name_compress()
Compress attachment
Change the compression scheme that is used to store an attachment.
Method get_instances_id_attachments_name_compressed_data()
Get attachment (no decompression)
Get the (binary) content of one attachment associated with
the given instance. The attachment will not be decompressed if
StorageCompression is TRUE.
Usage
Orthanc$get_instances_id_attachments_name_compressed_data(
id,
name,
params = NULL,
headers = NULL
)Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Content-Range (string): Optional content range to access part of the attachment (new in Orthanc 1.12.5)
If-None-Match (string): Optional revision of the attachment, to check if its content has changed
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
Method get_instances_id_attachments_name_compressed_md5()
Get MD5 of attachment on disk
Get the MD5 hash of one attachment associated with the given
instance, as stored on the disk. This is different from .../md5
iff EnableStorage is TRUE.
Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_instances_id_attachments_name_compressed_size()
Get size of attachment on disk
Get the size of one attachment associated with the given
instance, as stored on the disk. This is different from
.../size iff EnableStorage is TRUE.
Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_instances_id_attachments_name_data()
Get attachment
Get the (binary) content of one attachment associated with the given instance
Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Content-Range (string): Optional content range to access part of the attachment (new in Orthanc 1.12.5)
If-None-Match (string): Optional revision of the attachment, to check if its content has changed
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
Method get_instances_id_attachments_name_info()
Get info about the attachment
Get all the information about the attachment associated with the given instance
Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_instances_id_attachments_name_is_compressed()
Is attachment compressed?
Test whether the attachment has been stored as a compressed file on the disk.
Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_instances_id_attachments_name_md5()
Get MD5 of attachment
Get the MD5 hash of one attachment associated with the given instance
Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_instances_id_attachments_name_size()
Get size of attachment
Get the size of one attachment associated with the given instance
Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method post_instances_id_attachments_name_uncompress()
Uncompress attachment
Change the compression scheme that is used to store an attachment.
Method post_instances_id_attachments_name_verify_md5()
Verify attachment
Verify that the attachment is not corrupted, by validating its MD5 hash
Method get_instances_id_content_path()
Get raw tag
Get the raw content of one DICOM tag in the hierarchy of DICOM dataset
Method post_instances_id_export()
Write DICOM onto filesystem
Write the DICOM file onto the filesystem where Orthanc is
running. This is insecure for Orthanc servers that are remotely
accessible since one could overwrite any system file. Since
Orthanc 1.12.0, this route is disabled by default, but can be
enabled using the RestApiWriteToFileSystemEnabled configuration
option.
Method get_instances_id_file()
Download DICOM
Download one DICOM instance
Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Accept (string): This HTTP header can be set to retrieve the DICOM instance in DICOMweb format
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
lossy-quality (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)
transcode (string): If present, the DICOM file will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
Method get_instances_id_frames()
List available frames
List the frames that are available in the DICOM instance of interest
Method get_instances_id_frames_frame()
List operations
List the available operations under URI
/instances/{id}/frames/{frame}/
Method get_instances_id_frames_frame_image_int16()
Decode a frame (int16)
Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be interpreted according to two's complement.
Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
frame(numeric) Index of the frame (starts at
0).params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Accept (string): Format of the resulting image. Can be
image/png(default),image/jpegorimage/x-portable-arbitrarymap
Optional query parameters (params):
quality (number): Quality for JPEG images (between 1 and 100, defaults to 90)
returnUnsupportedImage (boolean): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (value is true if option is present)
Method get_instances_id_frames_frame_image_uint16()
Decode a frame (uint16)
Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.
Usage
Orthanc$get_instances_id_frames_frame_image_uint16(
id,
frame,
params = NULL,
headers = NULL
)Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
frame(numeric) Index of the frame (starts at
0).params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Accept (string): Format of the resulting image. Can be
image/png(default),image/jpegorimage/x-portable-arbitrarymap
Optional query parameters (params):
quality (number): Quality for JPEG images (between 1 and 100, defaults to 90)
returnUnsupportedImage (boolean): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (value is true if option is present)
Method get_instances_id_frames_frame_image_uint8()
Decode a frame (uint8)
Decode one frame of interest from the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.
Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
frame(numeric) Index of the frame (starts at
0).params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Accept (string): Format of the resulting image. Can be
image/png(default),image/jpegorimage/x-portable-arbitrarymap
Optional query parameters (params):
quality (number): Quality for JPEG images (between 1 and 100, defaults to 90)
returnUnsupportedImage (boolean): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (value is true if option is present)
Method get_instances_id_frames_frame_matlab()
Decode frame for Matlab
Decode one frame of interest from the given DICOM instance, and
export this frame as a Octave/Matlab matrix to be imported with
eval(): https://orthanc.uclouvain.be/book/faq/matlab.html
Method get_instances_id_frames_frame_numpy()
Decode frame for numpy
Decode one frame of interest from the given DICOM instance, for use with numpy in Python. The numpy array has 3 dimensions: (height, width, color channel).
Arguments
id(character) Orthanc identifier of the DICOM resource of interest.
frame(numeric) Index of the frame (starts at
0).params(list) Named-list of optional query parameters. See Details.
Method get_instances_id_frames_frame_preview()
Decode a frame (preview)
Decode one frame of interest from the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.
Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
frame(numeric) Index of the frame (starts at
0).params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Accept (string): Format of the resulting image. Can be
image/png(default),image/jpegorimage/x-portable-arbitrarymap
Optional query parameters (params):
quality (number): Quality for JPEG images (between 1 and 100, defaults to 90)
returnUnsupportedImage (boolean): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (value is true if option is present)
Method get_instances_id_frames_frame_raw()
Access raw frame
Access the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files in compressed transfer syntaxes.
Method get_instances_id_frames_frame_raw.gz()
Access raw frame (compressed)
Access the raw content of one individual frame of the DICOM instance of interest, bypassing image decoding. This is notably useful to access the source files in compressed transfer syntaxes. The image is compressed using gzip
Method get_instances_id_frames_frame_rendered()
Render a frame
Render one frame of interest from the given DICOM instance.
This function takes scaling into account (RescaleSlope and
RescaleIntercept tags), as well as the default windowing stored
in the DICOM file (WindowCenter and WindowWidthtags), and
can be used to resize the resulting image. Color images are not
affected by windowing.
Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
frame(numeric) Index of the frame (starts at
0).params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Accept (string): Format of the resulting image. Can be
image/png(default),image/jpegorimage/x-portable-arbitrarymap
Optional query parameters (params):
height (number): Height of the resized image
quality (number): Quality for JPEG images (between 1 and 100, defaults to 90)
returnUnsupportedImage (boolean): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (value is true if option is present)
smooth (boolean): Whether to smooth image on resize
width (number): Width of the resized image
window-center (number): Windowing center
window-width (number): Windowing width
Method get_instances_id_header()
Get DICOM meta-header
Get the DICOM tags in the meta-header of the DICOM instance. By
default, the full format is used, which combines hexadecimal
tags with human-readable description.
Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
params(list) Named-list of optional query parameters. See Details.
Method get_instances_id_image_int16()
Decode an image (int16)
Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [-32768,32767] range. Negative values must be interpreted according to two's complement.
Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Accept (string): Format of the resulting image. Can be
image/png(default),image/jpegorimage/x-portable-arbitrarymap
Optional query parameters (params):
quality (number): Quality for JPEG images (between 1 and 100, defaults to 90)
returnUnsupportedImage (boolean): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (value is true if option is present)
Method get_instances_id_image_uint16()
Decode an image (uint16)
Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,65535] range.
Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Accept (string): Format of the resulting image. Can be
image/png(default),image/jpegorimage/x-portable-arbitrarymap
Optional query parameters (params):
quality (number): Quality for JPEG images (between 1 and 100, defaults to 90)
returnUnsupportedImage (boolean): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (value is true if option is present)
Method get_instances_id_image_uint8()
Decode an image (uint8)
Decode the first frame of the given DICOM instance. Pixels of grayscale images are truncated to the [0,255] range.
Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Accept (string): Format of the resulting image. Can be
image/png(default),image/jpegorimage/x-portable-arbitrarymap
Optional query parameters (params):
quality (number): Quality for JPEG images (between 1 and 100, defaults to 90)
returnUnsupportedImage (boolean): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (value is true if option is present)
Method get_instances_id_labels()
List labels
Get the labels that are associated with the given instance (new in Orthanc 1.12.0)
Method delete_instances_id_labels_label()
Remove label
Remove a label associated with a instance
Method get_instances_id_labels_label()
Test label
Test whether the instance is associated with the given label
Method put_instances_id_labels_label()
Add label
Associate a label with a instance
Method get_instances_id_matlab()
Decode frame for Matlab
Decode the first frame of the given DICOM instance., and
export this frame as a Octave/Matlab matrix to be imported with
eval(): https://orthanc.uclouvain.be/book/faq/matlab.html
Method get_instances_id_metadata()
List metadata
Get the list of metadata that are associated with the given instance
Arguments
id(character) Orthanc identifier of the instance of interest.
params(list) Named-list of optional query parameters. See Details.
Method delete_instances_id_metadata_name()
Delete metadata
Delete some metadata associated with the given DICOM instance. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the metadata, or its index (cf.
UserMetadataconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_instances_id_metadata_name()
Get metadata
Get the value of a metadata that is associated with the given instance
Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the metadata, or its index (cf.
UserMetadataconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method put_instances_id_metadata_name()
Set metadata
Set the value of some metadata in the given DICOM instance. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the instance of interest.
name(character) The name of the metadata, or its index (cf.
UserMetadataconfiguration option).headers(list) Named-list of optional header parameters. See Details.
data(bytes or character) Raw data for request body. See Details.
Method post_instances_id_modify()
Modify instance
Download a modified version of the DICOM instance whose Orthanc identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/anonymization.html#modification-of-a-single-instance
Arguments
id(character) Orthanc identifier of the instance of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Force (logical): Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
Keep (list): Keep the original value of the specified tags, to be chosen among the
StudyInstanceUID,SeriesInstanceUIDandSOPInstanceUIDtags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.KeepSource (logical): If set to
FALSE, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.LossyQuality (numeric): 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)
PrivateCreator (character): The private creator to be used for private tags in
ReplaceRemove (list): List of tags that must be removed from the DICOM instances. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the
dcmodifycommand-line tool (wildcards are supported as well).RemovePrivateTags (logical): Remove the private tags from the DICOM instances (defaults to
FALSE)Replace (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Transcode (character): Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
Method get_instances_id_module()
Get instance module
Get the instance module of the DICOM instance whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the instance of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
ignore-length (array): Also include the DICOM tags that are provided in this list, even if their associated value is long
short (boolean): If present, report the DICOM tags in hexadecimal format
simplify (boolean): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)
Method get_instances_id_numpy()
Decode instance for numpy
Decode the given DICOM instance, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel).
Arguments
id(character) Orthanc identifier of the DICOM resource of interest.
params(list) Named-list of optional query parameters. See Details.
Method get_instances_id_patient()
Get parent patient
Get detailed information about the parent patient of the DICOM instance whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the instance of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method get_instances_id_pdf()
Get embedded PDF
Get the PDF file that is embedded in one DICOM instance. If the
DICOM instance doesn't contain the EncapsulatedDocument tag or
if the MIMETypeOfEncapsulatedDocument tag doesn't correspond to
the PDF type, a 404 HTTP error is raised.
Method get_instances_id_preview()
Decode an image (preview)
Decode the first frame of the given DICOM instance. The full dynamic range of grayscale images is rescaled to the [0,255] range.
Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Accept (string): Format of the resulting image. Can be
image/png(default),image/jpegorimage/x-portable-arbitrarymap
Optional query parameters (params):
quality (number): Quality for JPEG images (between 1 and 100, defaults to 90)
returnUnsupportedImage (boolean): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (value is true if option is present)
Method post_instances_id_reconstruct()
Reconstruct tags & optionally files of instance
Reconstruct the main DICOM tags in DB of the instance whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.
Arguments
id(character) Orthanc identifier of the instance of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
LimitToThisLevelMainDicomTags (logical): Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is useful e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4)
ReconstructFiles (logical): Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)
Method get_instances_id_rendered()
Render an image
Render the first frame of the given DICOM instance. This function
takes scaling into account (RescaleSlope and RescaleIntercept
tags), as well as the default windowing stored in the DICOM file
(WindowCenter and WindowWidthtags), and can be used to resize
the resulting image. Color images are not affected by windowing.
Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Accept (string): Format of the resulting image. Can be
image/png(default),image/jpegorimage/x-portable-arbitrarymap
Optional query parameters (params):
height (number): Height of the resized image
quality (number): Quality for JPEG images (between 1 and 100, defaults to 90)
returnUnsupportedImage (boolean): Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (value is true if option is present)
smooth (boolean): Whether to smooth image on resize
width (number): Width of the resized image
window-center (number): Windowing center
window-width (number): Windowing width
Method get_instances_id_series()
Get parent series
Get detailed information about the parent series of the DICOM instance whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the instance of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method get_instances_id_simplified_tags()
Get human-readable tags
Get the DICOM tags in human-readable format (same as the
/instances/{id}/tags?simplify route)
Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
ignore-length (array): Also include the DICOM tags that are provided in this list, even if their associated value is long
whole (boolean): Whether to read the whole DICOM file from the storage area (new in Orthanc 1.12.4). If set to "false" (default value), the DICOM file is read until the pixel data tag (7fe0,0010) to optimize access to storage. Setting the option to "true" provides access to the DICOM tags stored after the pixel data tag.
Method get_instances_id_statistics()
Get instance statistics
Get statistics about the given instance
Method get_instances_id_study()
Get parent study
Get detailed information about the parent study of the DICOM instance whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the instance of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method get_instances_id_tags()
Get DICOM tags
Get the DICOM tags in the specified format. By default, the
full format is used, which combines hexadecimal tags with
human-readable description.
Arguments
id(character) Orthanc identifier of the DICOM instance of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
ignore-length (array): Also include the DICOM tags that are provided in this list, even if their associated value is long
short (boolean): If present, report the DICOM tags in hexadecimal format
simplify (boolean): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)
whole (boolean): Whether to read the whole DICOM file from the storage area (new in Orthanc 1.12.4). If set to "false" (default value), the DICOM file is read until the pixel data tag (7fe0,0010) to optimize access to storage. Setting the option to "true" provides access to the DICOM tags stored after the pixel data tag.
Method get_jobs()
List jobs
List all the available jobs
Method delete_jobs_id()
Delete a job from history
Delete the job from the jobs history. Only a completed job can be deleted. If the job has not run or not completed yet, you must cancel it first. If the job has outputs, all outputs will be deleted as well.
Method get_jobs_id()
Get job
Retrieve detailed information about the job whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs
Method post_jobs_id_cancel()
Cancel job
Cancel the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs
Method post_jobs_id_pause()
Pause job
Pause the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs
Method post_jobs_id_resubmit()
Resubmit job
Resubmit the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs
Method post_jobs_id_resume()
Resume job
Resume the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs
Method delete_jobs_id_key()
Delete a job output
Delete the output produced by a job. As of Orthanc 1.12.1, only
the jobs that generate a DICOMDIR media or a ZIP archive provide
such an output (with key equals to archive).
Method get_jobs_id_key()
Get job output
Retrieve some output produced by a job. As of Orthanc 1.8.2, only
the jobs that generate a DICOMDIR media or a ZIP archive provide
such an output (with key equals to archive).
Method get_modalities()
List DICOM modalities
List all the DICOM modalities that are known to Orthanc. This
corresponds either to the content of the DicomModalities
configuration option, or to the information stored in the
database if DicomModalitiesInDatabase is TRUE.
Method delete_modalities_id()
Delete DICOM modality
Delete one DICOM modality. This change is permanent iff.
DicomModalitiesInDatabase is TRUE, otherwise it is lost at
the next restart of Orthanc.
Method get_modalities_id()
List operations on modality
List the operations that are available for a DICOM modality.
Method put_modalities_id()
Update DICOM modality
Define a new DICOM modality, or update an existing one. This
change is permanent iff. DicomModalitiesInDatabase is TRUE,
otherwise it is lost at the next restart of Orthanc.
Arguments
id(character) Identifier of the new/updated DICOM modality.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
AET (character): AET of the remote DICOM modality
AllowEcho (logical): Whether to accept C-ECHO SCU commands issued by the remote modality
AllowFind (logical): Whether to accept C-FIND SCU commands issued by the remote modality
AllowFindWorklist (logical): Whether to accept C-FIND SCU commands for worklists issued by the remote modality
AllowGet (logical): Whether to accept C-GET SCU commands issued by the remote modality
AllowMove (logical): Whether to accept C-MOVE SCU commands issued by the remote modality
AllowStorageCommitment (logical): Whether to accept storage commitment requests issued by the remote modality
AllowStore (logical): Whether to accept C-STORE SCU commands issued by the remote modality
AllowTranscoding (logical): Whether to allow transcoding for operations initiated by this modality. This option applies to Orthanc C-GET SCP and to Orthanc C-STORE SCU. It only has an effect if the global option
EnableTranscodingis set toTRUE.Host (character): Host address of the remote DICOM modality (typically, an IP address)
LocalAet (character): Whether to override the default DicomAet in the SCU connection initiated by Orthanc to this modality
Manufacturer (character): Manufacturer of the remote DICOM modality (check configuration option
DicomModalitiesfor possible valuesPort (numeric): TCP port of the remote DICOM modality
Timeout (numeric): Whether to override the default DicomScuTimeout in the SCU connection initiated by Orthanc to this modality
UseDicomTls (logical): Whether to use DICOM TLS in the SCU connection initiated by Orthanc (new in Orthanc 1.9.0)
Method get_modalities_id_configuration()
Get modality configuration
Get detailed information about the configuration of some DICOM modality
Method post_modalities_id_echo()
Trigger C-ECHO SCU
Trigger C-ECHO SCU command against the DICOM modality whose identifier is provided in URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-c-echo
Arguments
id(character) Identifier of the modality of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
CheckFind (logical): Issue a dummy C-FIND command after the C-GET SCU, in order to check whether the remote modality knows about Orthanc. This field defaults to the value of the
DicomEchoChecksFindconfiguration option. New in Orthanc 1.8.1.Timeout (numeric): Timeout for the C-ECHO command, in seconds
Method post_modalities_id_find_worklist()
C-FIND SCU for worklist
Trigger C-FIND SCU command against the remote worklists of the DICOM modality whose identifier is provided in URL
Arguments
id(character) Identifier of the modality of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Full (logical): If set to
TRUE, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)Query (list): Associative array containing the filter on the values of the DICOM tags
Short (logical): If set to
TRUE, report the DICOM tags in hexadecimal format
Method post_modalities_id_get()
Trigger C-GET SCU
Start a C-GET SCU command as a job, in order to retrieve DICOM resources from a remote DICOM modality whose identifier is provided in the URL:
Arguments
id(character) Identifier of the modality of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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.Level (character): Level of the query (
Patient,Study,SeriesorInstance)LocalAet (character): Local AET that is used for this commands, defaults to
DicomAetconfiguration option. Ignored ifDicomModalitiesalready setsLocalAetfor this modality.Permissive (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0Resources (list): List of queries identifying all the DICOM resources to be sent. Usage of wildcards is prohibited and the query shall only contain DICOM ID tags. Additionally, you may provide SOPClassesInStudy to limit the scope of the DICOM negotiation to certain SOPClassUID or to present uncommon SOPClassUID during the DICOM negotiation. By default, Orhanc will propose the most 120 common SOPClassUIDs.
Synchronous (logical): 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.Timeout (numeric): Timeout for the C-GET command, in seconds
UserData (list): User data that will travel along with the job.
Method post_modalities_id_move()
Trigger C-MOVE SCU
Start a C-MOVE SCU command as a job, in order to drive the execution of a sequence of C-STORE commands by some remote DICOM modality whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-c-move
Arguments
id(character) Identifier of the modality of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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.Level (character): Level of the query (
Patient,Study,SeriesorInstance)LocalAet (character): Local AET that is used for this commands, defaults to
DicomAetconfiguration option. Ignored ifDicomModalitiesalready setsLocalAetfor this modality.Permissive (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0Resources (list): List of queries identifying all the DICOM resources to be sent
Synchronous (logical): 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.TargetAet (character): Target AET that will be used by the remote DICOM modality as a target for its C-STORE SCU commands, defaults to
DicomAetconfiguration option in order to do a simple query/retrieveTimeout (numeric): Timeout for the C-MOVE command, in seconds
UserData (list): User data that will travel along with the job.
Method post_modalities_id_query()
Trigger C-FIND SCU
Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest
Arguments
id(character) Identifier of the modality of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Level (character): Level of the query (
Patient,Study,SeriesorInstance)LocalAet (character): Local AET that is used for this commands, defaults to
DicomAetconfiguration option. Ignored ifDicomModalitiesalready setsLocalAetfor this modality.Normalize (logical): Whether to normalize the query, i.e. whether to wipe out from the query, the DICOM tags that are not applicable for the query-retrieve level of interest
Query (list): Associative array containing the filter on the values of the DICOM tags
Timeout (numeric): Timeout for the C-FIND command and subsequent C-MOVE retrievals, in seconds (new in Orthanc 1.9.1)
Method post_modalities_id_storage_commitment()
Trigger storage commitment request
Trigger a storage commitment request to some remote DICOM modality whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/storage-commitment.html#storage-commitment-scu
Arguments
id(character) Identifier of the modality of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
DicomInstances (list): List of DICOM resources that are not necessarily stored within Orthanc, but that must be checked by storage commitment. This is a list of JSON objects that must contain the
SOPClassUIDandSOPInstanceUIDfields.Resources (list): List of the Orthanc identifiers of the DICOM resources to be checked by storage commitment
Timeout (numeric): Timeout for the storage commitment command (new in Orthanc 1.9.1)
Method post_modalities_id_store()
Trigger C-STORE SCU
Start a C-STORE SCU command as a job, in order to send DICOM resources stored locally to some remote DICOM modality whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#rest-store-scu
Arguments
id(character) Identifier of the modality of interest.
json(list) Named-list for request body. See Details.
data(bytes or character) Raw data for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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.CalledAet (character): Called AET that is used for this commands, defaults to
AETconfiguration option. Allows you to overwrite the destination AET for a specific operation.Host (character): Host that is used for this commands, defaults to
Hostconfiguration option. Allows you to overwrite the destination host for a specific operation.LocalAet (character): Local AET that is used for this commands, defaults to
DicomAetconfiguration option. Ignored ifDicomModalitiesalready setsLocalAetfor this modality.MoveOriginatorAet (character): Move originator AET that is used for this commands, in order to fake a C-MOVE SCU
MoveOriginatorID (numeric): Move originator ID that is used for this commands, in order to fake a C-MOVE SCU
Permissive (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Port (numeric): Port that is used for this command, defaults to
Portconfiguration option. Allows you to overwrite the destination port for a specific operation.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0Resources (list): List of the Orthanc identifiers of all the DICOM resources to be sent
StorageCommitment (logical): Whether to chain C-STORE with DICOM storage commitment to validate the success of the transmission: https://orthanc.uclouvain.be/book/users/storage-commitment.html#chaining-c-store-with-storage-commitment
Synchronous (logical): 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.Timeout (numeric): Timeout for the C-STORE command, in seconds
UserData (list): User data that will travel along with the job. Request body: The Orthanc identifier of one resource to be sent (text/plain).
Method post_modalities_id_store_straight()
Straight C-STORE SCU
Synchronously send the DICOM instance in the POST body to the
remote DICOM modality whose identifier is provided in URL,
without having to first store it locally within Orthanc. This
is an alternative to command-line tools such as storescu from
DCMTK or dcm4che.
Method get_patients()
List the available patients
List the Orthanc identifiers of all the available DICOM patients
Details
Optional query parameters (params):
expand (string): If present, retrieve detailed information about the individual resources, not only their Orthanc identifiers
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
limit (number): Limit the number of results
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
response-content (string): Defines the content of response for each returned resource. Allowed values are
MainDicomTags,Metadata,Children,Parent,Labels,Status,IsStable,IsProtected,Attachments. If not specified, Orthanc will returnMainDicomTags,Metadata,Children,Parent,Labels,Status,IsStable,IsProtected.e.g: 'response-content=MainDicomTags;Children (new in Orthanc 1.12.5 - overridesexpand)short (boolean): If present, report the DICOM tags in hexadecimal format
since (number): Show only the resources since the provided index
Method delete_patients_id()
Delete some patient
Delete the DICOM patient whose Orthanc identifier is provided in the URL
Method get_patients_id()
Get information about some patient
Get detailed information about the DICOM patient whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the patient of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method post_patients_id_anonymize()
Anonymize patient
Start a job that will anonymize all the DICOM instances within the patient whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new patient, whose Orthanc identifiers will be returned by the job. https://orthanc.uclouvain.be/book/users/anonymization.html#anonymization-of-patients-studies-or-series
Arguments
id(character) Orthanc identifier of the patient of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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 (character): Version of the DICOM standard to be used for anonymization. Check out configuration option
DeidentifyLogsDicomVersionfor possible values.Force (logical): Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
Keep (list): 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
dcmodifycommand-line tool (wildcards are supported as well).KeepLabels (logical): Keep the labels of all resources level (defaults to
FALSE)KeepPrivateTags (logical): Keep the private tags from the DICOM instances (defaults to
FALSE)KeepSource (logical): If set to
FALSE, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.LossyQuality (numeric): 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 (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0PrivateCreator (character): The private creator to be used for private tags in
ReplaceRemove (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Replace (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Synchronous (logical): 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 (character): Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): User data that will travel along with the job.
Method get_patients_id_archive()
Create ZIP archive
Synchronously create a ZIP archive containing the DICOM patient
whose Orthanc identifier is provided in the URL. This flavor
is synchronous, which might not be desirable to archive large
amount of data, as it might lead to network timeouts. Prefer the
asynchronous version using POST method.
Arguments
id(character) Orthanc identifier of the patient of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
lossy-quality (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)
transcode (string): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
Method post_patients_id_archive()
Create ZIP archive
Create a ZIP archive containing the DICOM patient whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the patient of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): If
TRUE, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.Filename (character): Filename to set in the "Content-Disposition" HTTP header (including file extension)
LossyQuality (numeric): 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)
Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority.
Synchronous (logical): If
TRUE, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option "SynchronousZipStream" is set to "false", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.Transcode (character): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): In asynchronous mode, user data that will be attached to the job.
Method get_patients_id_attachments()
List attachments
Get the list of attachments that are associated with the given patient
Arguments
id(character) Orthanc identifier of the patient of interest.
params(list) Named-list of optional query parameters. See Details.
Method delete_patients_id_attachments_name()
Delete attachment
Delete an attachment associated with the given DICOM patient. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_patients_id_attachments_name()
List operations on attachments
Get the list of the operations that are available for attachments associated with the given patient
Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method put_patients_id_attachments_name()
Set attachment
Attach a file to the given DICOM patient. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
data(bytes or character) Raw data for request body. See Details.
Method post_patients_id_attachments_name_compress()
Compress attachment
Change the compression scheme that is used to store an attachment.
Method get_patients_id_attachments_name_compressed_data()
Get attachment (no decompression)
Get the (binary) content of one attachment associated with
the given patient. The attachment will not be decompressed if
StorageCompression is TRUE.
Usage
Orthanc$get_patients_id_attachments_name_compressed_data(
id,
name,
params = NULL,
headers = NULL
)Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Content-Range (string): Optional content range to access part of the attachment (new in Orthanc 1.12.5)
If-None-Match (string): Optional revision of the attachment, to check if its content has changed
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
Method get_patients_id_attachments_name_compressed_md5()
Get MD5 of attachment on disk
Get the MD5 hash of one attachment associated with the given
patient, as stored on the disk. This is different from .../md5
iff EnableStorage is TRUE.
Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_patients_id_attachments_name_compressed_size()
Get size of attachment on disk
Get the size of one attachment associated with the given patient,
as stored on the disk. This is different from .../size iff
EnableStorage is TRUE.
Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_patients_id_attachments_name_data()
Get attachment
Get the (binary) content of one attachment associated with the given patient
Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Content-Range (string): Optional content range to access part of the attachment (new in Orthanc 1.12.5)
If-None-Match (string): Optional revision of the attachment, to check if its content has changed
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
Method get_patients_id_attachments_name_info()
Get info about the attachment
Get all the information about the attachment associated with the given patient
Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_patients_id_attachments_name_is_compressed()
Is attachment compressed?
Test whether the attachment has been stored as a compressed file on the disk.
Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_patients_id_attachments_name_md5()
Get MD5 of attachment
Get the MD5 hash of one attachment associated with the given patient
Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_patients_id_attachments_name_size()
Get size of attachment
Get the size of one attachment associated with the given patient
Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method post_patients_id_attachments_name_uncompress()
Uncompress attachment
Change the compression scheme that is used to store an attachment.
Method post_patients_id_attachments_name_verify_md5()
Verify attachment
Verify that the attachment is not corrupted, by validating its MD5 hash
Method get_patients_id_instances()
Get child instances
Get detailed information about the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the patient of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
expand (string): If false or missing, only retrieve the list of child instances
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method get_patients_id_instances_tags()
Get tags of instances
Get the tags of all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the patient of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
ignore-length (array): Also include the DICOM tags that are provided in this list, even if their associated value is long
short (boolean): If present, report the DICOM tags in hexadecimal format
simplify (boolean): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)
Method get_patients_id_labels()
List labels
Get the labels that are associated with the given patient (new in Orthanc 1.12.0)
Method delete_patients_id_labels_label()
Remove label
Remove a label associated with a patient
Method get_patients_id_labels_label()
Test label
Test whether the patient is associated with the given label
Method put_patients_id_labels_label()
Add label
Associate a label with a patient
Method get_patients_id_media()
Create DICOMDIR media
Synchronously create a DICOMDIR media containing the DICOM
patient whose Orthanc identifier is provided in the URL. This
flavor is synchronous, which might not be desirable to archive
large amount of data, as it might lead to network timeouts.
Prefer the asynchronous version using POST method.
Arguments
id(character) Orthanc identifier of the patient of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
extended (string): If present, will include additional tags such as
SeriesDescription, leading to a so-called extended DICOMDIRfilename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
lossy-quality (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)
transcode (string): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
Method post_patients_id_media()
Create DICOMDIR media
Create a DICOMDIR media containing the DICOM patient whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the patient of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): If
TRUE, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.Extended (logical): If
TRUE, will include additional tags such asSeriesDescription, leading to a so-called extended DICOMDIR. Default value isFALSE.Filename (character): Filename to set in the "Content-Disposition" HTTP header (including file extension)
LossyQuality (numeric): 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)
Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority.
Synchronous (logical): If
TRUE, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option "SynchronousZipStream" is set to "false", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.Transcode (character): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): In asynchronous mode, user data that will be attached to the job.
Method get_patients_id_metadata()
List metadata
Get the list of metadata that are associated with the given patient
Arguments
id(character) Orthanc identifier of the patient of interest.
params(list) Named-list of optional query parameters. See Details.
Method delete_patients_id_metadata_name()
Delete metadata
Delete some metadata associated with the given DICOM patient. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the metadata, or its index (cf.
UserMetadataconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_patients_id_metadata_name()
Get metadata
Get the value of a metadata that is associated with the given patient
Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the metadata, or its index (cf.
UserMetadataconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method put_patients_id_metadata_name()
Set metadata
Set the value of some metadata in the given DICOM patient. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the patient of interest.
name(character) The name of the metadata, or its index (cf.
UserMetadataconfiguration option).headers(list) Named-list of optional header parameters. See Details.
data(bytes or character) Raw data for request body. See Details.
Method post_patients_id_modify()
Modify patient
Start a job that will modify all the DICOM instances within the patient whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new patient, whose Orthanc identifiers will be returned by the job. https://orthanc.uclouvain.be/book/users/anonymization.html#modification-of-studies-or-series
Arguments
id(character) Orthanc identifier of the patient of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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.Force (logical): Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
Keep (list): Keep the original value of the specified tags, to be chosen among the
StudyInstanceUID,SeriesInstanceUIDandSOPInstanceUIDtags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.KeepSource (logical): If set to
FALSE, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.LossyQuality (numeric): 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 (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0PrivateCreator (character): The private creator to be used for private tags in
ReplaceRemove (list): List of tags that must be removed from the DICOM instances. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the
dcmodifycommand-line tool (wildcards are supported as well).RemovePrivateTags (logical): Remove the private tags from the DICOM instances (defaults to
FALSE)Replace (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Synchronous (logical): 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 (character): Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): User data that will travel along with the job.
Method get_patients_id_module()
Get patient module
Get the patient module of the DICOM patient whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the patient of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
ignore-length (array): Also include the DICOM tags that are provided in this list, even if their associated value is long
short (boolean): If present, report the DICOM tags in hexadecimal format
simplify (boolean): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)
Method get_patients_id_protected()
Is the patient protected against recycling?
Is the patient protected against recycling?
Method put_patients_id_protected()
Protect/Unprotect a patient against recycling
Protects a patient by sending 1 or TRUE in the
payload request. Unprotects a patient by sending
0 or FALSE in the payload requests. More info:
https://orthanc.uclouvain.be/book/faq/features.html#recycling-protection
Method post_patients_id_reconstruct()
Reconstruct tags & optionally files of patient
Reconstruct the main DICOM tags in DB of the patient whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.
Arguments
id(character) Orthanc identifier of the patient of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
LimitToThisLevelMainDicomTags (logical): Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is useful e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4)
ReconstructFiles (logical): Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)
Method get_patients_id_series()
Get child series
Get detailed information about the child series of the DICOM patient whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the patient of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
expand (string): If false or missing, only retrieve the list of child series
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method get_patients_id_shared_tags()
Get shared tags
Extract the DICOM tags whose value is constant across all the child instances of the DICOM patient whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the patient of interest.
params(list) Named-list of optional query parameters. See Details.
Method get_patients_id_studies()
Get child studies
Get detailed information about the child studies of the DICOM patient whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the patient of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
expand (string): If false or missing, only retrieve the list of child studies
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method get_peers()
List Orthanc peers
List all the Orthanc peers that are known to Orthanc. This
corresponds either to the content of the OrthancPeers
configuration option, or to the information stored in the
database if OrthancPeersInDatabase is TRUE.
Method delete_peers_id()
Delete Orthanc peer
Delete one Orthanc peer. This change is permanent iff.
OrthancPeersInDatabase is TRUE, otherwise it is lost at the
next restart of Orthanc.
Method get_peers_id()
List operations on peer
List the operations that are available for an Orthanc peer.
Method put_peers_id()
Update Orthanc peer
Define a new Orthanc peer, or update an existing one. This change
is permanent iff. OrthancPeersInDatabase is TRUE, otherwise
it is lost at the next restart of Orthanc.
Arguments
id(character) Identifier of the new/updated Orthanc peer.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
CertificateFile (character): SSL certificate for the HTTPS connections
CertificateKeyFile (character): Key file for the SSL certificate for the HTTPS connections
CertificateKeyPassword (character): Key password for the SSL certificate for the HTTPS connections
HttpHeaders (list): HTTP headers to be used for the connections to the remote peer
Password (character): Password for the credentials
URL (character): URL of the root of the REST API of the remote Orthanc peer, for instance
http://localhost:8042/Username (character): Username for the credentials
Method get_peers_id_configuration()
Get peer configuration
Get detailed information about the configuration of some Orthanc peer
Method post_peers_id_store()
Send to Orthanc peer
Send DICOM resources stored locally to some remote Orthanc peer whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#sending-one-resource
Arguments
id(character) Identifier of the modality of interest.
json(list) Named-list for request body. See Details.
data(bytes or character) Raw data for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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.Compress (logical): Whether to compress the DICOM instances using gzip before the actual sending
Permissive (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0Resources (list): List of the Orthanc identifiers of all the DICOM resources to be sent
Synchronous (logical): 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 (character): Transcode to the provided DICOM transfer syntax before the actual sending
UserData (list): User data that will travel along with the job. Request body: The Orthanc identifier of one resource to be sent (text/plain).
Method post_peers_id_store_straight()
Straight store to peer
Synchronously send the DICOM instance in the POST body to the
Orthanc peer whose identifier is provided in URL, without having
to first store it locally within Orthanc. This is an alternative
to command-line tools such as curl.
Method get_peers_id_system()
Get peer system information
Get system information about some Orthanc peer. This corresponds
to doing a GET request against the /system URI of the remote
peer. This route can be used to test connectivity.
Method get_plugins_explorer.js()
JavaScript extensions to Orthanc Explorer
Get the JavaScript extensions that are installed by all the
plugins using the OrthancPluginExtendOrthancExplorer() function
of the plugin SDK. This route is for internal use of Orthanc
Explorer.
Method get_plugins_id()
Get plugin
Get system information about the plugin whose identifier is provided in the URL
Method get_queries()
List query/retrieve operations
List the identifiers of all the query/retrieve
operations on DICOM modalities, as initiated by calls to
/modalities/{id}/query. The length of this list is bounded
by the QueryRetrieveSize configuration option of Orthanc.
https://orthanc.uclouvain.be/book/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest
Method delete_queries_id()
Delete a query
Delete the query/retrieve operation whose identifier is provided in the URL
Method get_queries_id()
List operations on a query
List the available operations for the query/retrieve operation whose identifier is provided in the URL
Method get_queries_id_answers()
List answers to a query
List the indices of all the available answers resulting from a query/retrieve operation on some DICOM modality, whose identifier is provided in the URL
Arguments
id(character) Identifier of the query of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
expand (string): If present, retrieve detailed information about the individual answers
short (boolean): If present, report the DICOM tags in hexadecimal format
simplify (boolean): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)
Method get_queries_id_answers_index()
List operations on an answer
List the available operations on an answer associated with the query/retrieve operation whose identifier is provided in the URL
Method get_queries_id_answers_index_content()
Get one answer
Get the content (DICOM tags) of one answer associated with the query/retrieve operation whose identifier is provided in the URL
Arguments
id(character) Identifier of the query of interest.
index(character) Index of the answer.
params(list) Named-list of optional query parameters. See Details.
Method post_queries_id_answers_index_query_instances()
Query the child instances of an answer
Issue a second DICOM C-FIND operation, in order to query the child instances associated with one answer to some query/retrieve operation whose identifiers are provided in the URL
Arguments
id(character) Identifier of the query of interest.
index(character) Index of the answer.
json(list) Named-list for request body. See Details.
Method post_queries_id_answers_index_query_series()
Query the child series of an answer
Issue a second DICOM C-FIND operation, in order to query the child series associated with one answer to some query/retrieve operation whose identifiers are provided in the URL
Arguments
id(character) Identifier of the query of interest.
index(character) Index of the answer.
json(list) Named-list for request body. See Details.
Method post_queries_id_answers_index_query_studies()
Query the child studies of an answer
Issue a second DICOM C-FIND operation, in order to query the child studies associated with one answer to some query/retrieve operation whose identifiers are provided in the URL
Arguments
id(character) Identifier of the query of interest.
index(character) Index of the answer.
json(list) Named-list for request body. See Details.
Method post_queries_id_answers_index_retrieve()
Retrieve one answer with a C-MOVE or a C-GET SCU
Start a C-MOVE or a C-GET SCU command as a job, in order to retrieve one answer associated with the query/retrieve operation whose identifiers are provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-retrieve-c-move
Arguments
id(character) Identifier of the query of interest.
index(character) Index of the answer.
json(list) Named-list for request body. See Details.
data(bytes or character) Raw data for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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.Full (logical): If set to
TRUE, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)Permissive (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0RetrieveMethod (character): Force usage of C-MOVE or C-GET to retrieve the resource. If note defined in the payload, the retrieve method is defined in the DicomDefaultRetrieveMethod configuration or in DicomModalities->..->RetrieveMethod
Simplify (logical): If set to
TRUE, report the DICOM tags in human-readable format (using the symbolic name of the tags)Synchronous (logical): 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.TargetAet (character): AET of the target modality. By default, the AET of Orthanc is used, as defined in the
DicomAetconfiguration option.Timeout (numeric): Timeout for the C-MOVE command, in seconds
UserData (list): User data that will travel along with the job. Request body: AET of the target modality (text/plain).
Method get_queries_id_level()
Get level of original query
Get the query level (value of the QueryRetrieveLevel tag) of
the query/retrieve operation whose identifier is provided in the
URL
Method get_queries_id_modality()
Get modality of original query
Get the identifier of the DICOM modality that was targeted by the query/retrieve operation whose identifier is provided in the URL
Method get_queries_id_query()
Get original query arguments
Get the original DICOM filter associated with the query/retrieve operation whose identifier is provided in the URL
Arguments
id(character) Identifier of the query of interest.
params(list) Named-list of optional query parameters. See Details.
Method post_queries_id_retrieve()
Retrieve all answers with C-MOVE SCU
Start a C-MOVE SCU command as a job, in order to retrieve all the answers associated with the query/retrieve operation whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-retrieve-c-move
Arguments
id(character) Identifier of the query of interest.
json(list) Named-list for request body. See Details.
data(bytes or character) Raw data for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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.Full (logical): If set to
TRUE, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)Permissive (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0RetrieveMethod (character): Force usage of C-MOVE or C-GET to retrieve the resource. If note defined in the payload, the retrieve method is defined in the DicomDefaultRetrieveMethod configuration or in DicomModalities->..->RetrieveMethod
Simplify (logical): If set to
TRUE, report the DICOM tags in human-readable format (using the symbolic name of the tags)Synchronous (logical): 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.TargetAet (character): AET of the target modality. By default, the AET of Orthanc is used, as defined in the
DicomAetconfiguration option.Timeout (numeric): Timeout for the C-MOVE command, in seconds
UserData (list): User data that will travel along with the job. Request body: AET of the target modality (text/plain).
Method get_series()
List the available series
List the Orthanc identifiers of all the available DICOM series
Details
Optional query parameters (params):
expand (string): If present, retrieve detailed information about the individual resources, not only their Orthanc identifiers
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
limit (number): Limit the number of results
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
response-content (string): Defines the content of response for each returned resource. Allowed values are
MainDicomTags,Metadata,Children,Parent,Labels,Status,IsStable,IsProtected,Attachments. If not specified, Orthanc will returnMainDicomTags,Metadata,Children,Parent,Labels,Status,IsStable,IsProtected.e.g: 'response-content=MainDicomTags;Children (new in Orthanc 1.12.5 - overridesexpand)short (boolean): If present, report the DICOM tags in hexadecimal format
since (number): Show only the resources since the provided index
Method delete_series_id()
Delete some series
Delete the DICOM series whose Orthanc identifier is provided in the URL
Method get_series_id()
Get information about some series
Get detailed information about the DICOM series whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the series of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method post_series_id_anonymize()
Anonymize series
Start a job that will anonymize all the DICOM instances within the series whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new series, whose Orthanc identifiers will be returned by the job. https://orthanc.uclouvain.be/book/users/anonymization.html#anonymization-of-patients-studies-or-series
Arguments
id(character) Orthanc identifier of the series of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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 (character): Version of the DICOM standard to be used for anonymization. Check out configuration option
DeidentifyLogsDicomVersionfor possible values.Force (logical): Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
Keep (list): 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
dcmodifycommand-line tool (wildcards are supported as well).KeepLabels (logical): Keep the labels of all resources level (defaults to
FALSE)KeepPrivateTags (logical): Keep the private tags from the DICOM instances (defaults to
FALSE)KeepSource (logical): If set to
FALSE, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.LossyQuality (numeric): 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 (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0PrivateCreator (character): The private creator to be used for private tags in
ReplaceRemove (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Replace (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Synchronous (logical): 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 (character): Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): User data that will travel along with the job.
Method get_series_id_archive()
Create ZIP archive
Synchronously create a ZIP archive containing the DICOM series
whose Orthanc identifier is provided in the URL. This flavor
is synchronous, which might not be desirable to archive large
amount of data, as it might lead to network timeouts. Prefer the
asynchronous version using POST method.
Arguments
id(character) Orthanc identifier of the series of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
lossy-quality (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)
transcode (string): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
Method post_series_id_archive()
Create ZIP archive
Create a ZIP archive containing the DICOM series whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the series of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): If
TRUE, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.Filename (character): Filename to set in the "Content-Disposition" HTTP header (including file extension)
LossyQuality (numeric): 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)
Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority.
Synchronous (logical): If
TRUE, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option "SynchronousZipStream" is set to "false", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.Transcode (character): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): In asynchronous mode, user data that will be attached to the job.
Method get_series_id_attachments()
List attachments
Get the list of attachments that are associated with the given series
Arguments
id(character) Orthanc identifier of the series of interest.
params(list) Named-list of optional query parameters. See Details.
Method delete_series_id_attachments_name()
Delete attachment
Delete an attachment associated with the given DICOM series. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_series_id_attachments_name()
List operations on attachments
Get the list of the operations that are available for attachments associated with the given series
Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method put_series_id_attachments_name()
Set attachment
Attach a file to the given DICOM series. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
data(bytes or character) Raw data for request body. See Details.
Method post_series_id_attachments_name_compress()
Compress attachment
Change the compression scheme that is used to store an attachment.
Method get_series_id_attachments_name_compressed_data()
Get attachment (no decompression)
Get the (binary) content of one attachment associated with
the given series. The attachment will not be decompressed if
StorageCompression is TRUE.
Usage
Orthanc$get_series_id_attachments_name_compressed_data(
id,
name,
params = NULL,
headers = NULL
)Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Content-Range (string): Optional content range to access part of the attachment (new in Orthanc 1.12.5)
If-None-Match (string): Optional revision of the attachment, to check if its content has changed
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
Method get_series_id_attachments_name_compressed_md5()
Get MD5 of attachment on disk
Get the MD5 hash of one attachment associated with the given
series, as stored on the disk. This is different from .../md5
iff EnableStorage is TRUE.
Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_series_id_attachments_name_compressed_size()
Get size of attachment on disk
Get the size of one attachment associated with the given series,
as stored on the disk. This is different from .../size iff
EnableStorage is TRUE.
Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_series_id_attachments_name_data()
Get attachment
Get the (binary) content of one attachment associated with the given series
Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Content-Range (string): Optional content range to access part of the attachment (new in Orthanc 1.12.5)
If-None-Match (string): Optional revision of the attachment, to check if its content has changed
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
Method get_series_id_attachments_name_info()
Get info about the attachment
Get all the information about the attachment associated with the given series
Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_series_id_attachments_name_is_compressed()
Is attachment compressed?
Test whether the attachment has been stored as a compressed file on the disk.
Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_series_id_attachments_name_md5()
Get MD5 of attachment
Get the MD5 hash of one attachment associated with the given series
Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_series_id_attachments_name_size()
Get size of attachment
Get the size of one attachment associated with the given series
Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method post_series_id_attachments_name_uncompress()
Uncompress attachment
Change the compression scheme that is used to store an attachment.
Method post_series_id_attachments_name_verify_md5()
Verify attachment
Verify that the attachment is not corrupted, by validating its MD5 hash
Method get_series_id_instances()
Get child instances
Get detailed information about the child instances of the DICOM series whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the series of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
expand (string): If false or missing, only retrieve the list of child instances
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method get_series_id_instances_tags()
Get tags of instances
Get the tags of all the child instances of the DICOM series whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the series of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
ignore-length (array): Also include the DICOM tags that are provided in this list, even if their associated value is long
short (boolean): If present, report the DICOM tags in hexadecimal format
simplify (boolean): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)
Method get_series_id_labels()
List labels
Get the labels that are associated with the given series (new in Orthanc 1.12.0)
Method delete_series_id_labels_label()
Remove label
Remove a label associated with a series
Method get_series_id_labels_label()
Test label
Test whether the series is associated with the given label
Method put_series_id_labels_label()
Add label
Associate a label with a series
Method get_series_id_media()
Create DICOMDIR media
Synchronously create a DICOMDIR media containing the DICOM series
whose Orthanc identifier is provided in the URL. This flavor
is synchronous, which might not be desirable to archive large
amount of data, as it might lead to network timeouts. Prefer the
asynchronous version using POST method.
Arguments
id(character) Orthanc identifier of the series of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
extended (string): If present, will include additional tags such as
SeriesDescription, leading to a so-called extended DICOMDIRfilename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
lossy-quality (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)
transcode (string): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
Method post_series_id_media()
Create DICOMDIR media
Create a DICOMDIR media containing the DICOM series whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the series of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): If
TRUE, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.Extended (logical): If
TRUE, will include additional tags such asSeriesDescription, leading to a so-called extended DICOMDIR. Default value isFALSE.Filename (character): Filename to set in the "Content-Disposition" HTTP header (including file extension)
LossyQuality (numeric): 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)
Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority.
Synchronous (logical): If
TRUE, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option "SynchronousZipStream" is set to "false", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.Transcode (character): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): In asynchronous mode, user data that will be attached to the job.
Method get_series_id_metadata()
List metadata
Get the list of metadata that are associated with the given series
Arguments
id(character) Orthanc identifier of the series of interest.
params(list) Named-list of optional query parameters. See Details.
Method delete_series_id_metadata_name()
Delete metadata
Delete some metadata associated with the given DICOM series. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the metadata, or its index (cf.
UserMetadataconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_series_id_metadata_name()
Get metadata
Get the value of a metadata that is associated with the given series
Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the metadata, or its index (cf.
UserMetadataconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method put_series_id_metadata_name()
Set metadata
Set the value of some metadata in the given DICOM series. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the series of interest.
name(character) The name of the metadata, or its index (cf.
UserMetadataconfiguration option).headers(list) Named-list of optional header parameters. See Details.
data(bytes or character) Raw data for request body. See Details.
Method post_series_id_modify()
Modify series
Start a job that will modify all the DICOM instances within the series whose identifier is provided in the URL. The modified DICOM instances will be stored into a brand new series, whose Orthanc identifiers will be returned by the job. https://orthanc.uclouvain.be/book/users/anonymization.html#modification-of-studies-or-series
Arguments
id(character) Orthanc identifier of the series of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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.Force (logical): Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
Keep (list): Keep the original value of the specified tags, to be chosen among the
StudyInstanceUID,SeriesInstanceUIDandSOPInstanceUIDtags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.KeepSource (logical): If set to
FALSE, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.LossyQuality (numeric): 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 (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0PrivateCreator (character): The private creator to be used for private tags in
ReplaceRemove (list): List of tags that must be removed from the DICOM instances. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the
dcmodifycommand-line tool (wildcards are supported as well).RemovePrivateTags (logical): Remove the private tags from the DICOM instances (defaults to
FALSE)Replace (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Synchronous (logical): 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 (character): Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): User data that will travel along with the job.
Method get_series_id_module()
Get series module
Get the series module of the DICOM series whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the series of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
ignore-length (array): Also include the DICOM tags that are provided in this list, even if their associated value is long
short (boolean): If present, report the DICOM tags in hexadecimal format
simplify (boolean): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)
Method get_series_id_numpy()
Decode series for numpy
Decode the given DICOM series, for use with numpy in Python. The numpy array has 4 dimensions: (frame, height, width, color channel).
Arguments
id(character) Orthanc identifier of the DICOM resource of interest.
params(list) Named-list of optional query parameters. See Details.
Method get_series_id_patient()
Get parent patient
Get detailed information about the parent patient of the DICOM series whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the series of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method post_series_id_reconstruct()
Reconstruct tags & optionally files of series
Reconstruct the main DICOM tags in DB of the series whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.
Arguments
id(character) Orthanc identifier of the series of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
LimitToThisLevelMainDicomTags (logical): Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is useful e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4)
ReconstructFiles (logical): Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)
Method get_series_id_shared_tags()
Get shared tags
Extract the DICOM tags whose value is constant across all the child instances of the DICOM series whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the series of interest.
params(list) Named-list of optional query parameters. See Details.
Method get_series_id_study()
Get parent study
Get detailed information about the parent study of the DICOM series whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the series of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method get_storage_commitment_id()
Get storage commitment report
Get the storage commitment report whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/storage-commitment.html#storage-commitment-scu
Method post_storage_commitment_id_remove()
Remove after storage commitment
Remove out of Orthanc, the DICOM instances that have
been reported to have been properly received in the
storage commitment report whose identifier is provided
in the URL. This is only possible if the Status
of the storage commitment report is Success.
https://orthanc.uclouvain.be/book/users/storage-commitment.html#removing-the-instances
Method get_studies()
List the available studies
List the Orthanc identifiers of all the available DICOM studies
Details
Optional query parameters (params):
expand (string): If present, retrieve detailed information about the individual resources, not only their Orthanc identifiers
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
limit (number): Limit the number of results
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
response-content (string): Defines the content of response for each returned resource. Allowed values are
MainDicomTags,Metadata,Children,Parent,Labels,Status,IsStable,IsProtected,Attachments. If not specified, Orthanc will returnMainDicomTags,Metadata,Children,Parent,Labels,Status,IsStable,IsProtected.e.g: 'response-content=MainDicomTags;Children (new in Orthanc 1.12.5 - overridesexpand)short (boolean): If present, report the DICOM tags in hexadecimal format
since (number): Show only the resources since the provided index
Method delete_studies_id()
Delete some study
Delete the DICOM study whose Orthanc identifier is provided in the URL
Method get_studies_id()
Get information about some study
Get detailed information about the DICOM study whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the study of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method post_studies_id_anonymize()
Anonymize study
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
Arguments
id(character) Orthanc identifier of the study of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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 (character): Version of the DICOM standard to be used for anonymization. Check out configuration option
DeidentifyLogsDicomVersionfor possible values.Force (logical): Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
Keep (list): 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
dcmodifycommand-line tool (wildcards are supported as well).KeepLabels (logical): Keep the labels of all resources level (defaults to
FALSE)KeepPrivateTags (logical): Keep the private tags from the DICOM instances (defaults to
FALSE)KeepSource (logical): If set to
FALSE, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.LossyQuality (numeric): 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 (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0PrivateCreator (character): The private creator to be used for private tags in
ReplaceRemove (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Replace (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Synchronous (logical): 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 (character): Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): User data that will travel along with the job.
Method get_studies_id_archive()
Create ZIP archive
Synchronously create a ZIP archive containing the DICOM study
whose Orthanc identifier is provided in the URL. This flavor
is synchronous, which might not be desirable to archive large
amount of data, as it might lead to network timeouts. Prefer the
asynchronous version using POST method.
Arguments
id(character) Orthanc identifier of the study of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
lossy-quality (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)
transcode (string): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
Method post_studies_id_archive()
Create ZIP archive
Create a ZIP archive containing the DICOM study whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the study of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): If
TRUE, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.Filename (character): Filename to set in the "Content-Disposition" HTTP header (including file extension)
LossyQuality (numeric): 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)
Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority.
Synchronous (logical): If
TRUE, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option "SynchronousZipStream" is set to "false", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.Transcode (character): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): In asynchronous mode, user data that will be attached to the job.
Method get_studies_id_attachments()
List attachments
Get the list of attachments that are associated with the given study
Arguments
id(character) Orthanc identifier of the study of interest.
params(list) Named-list of optional query parameters. See Details.
Method delete_studies_id_attachments_name()
Delete attachment
Delete an attachment associated with the given DICOM study. This call will fail if trying to delete a system attachment (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_studies_id_attachments_name()
List operations on attachments
Get the list of the operations that are available for attachments associated with the given study
Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method put_studies_id_attachments_name()
Set attachment
Attach a file to the given DICOM study. This call will fail if trying to modify a system attachment (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
data(bytes or character) Raw data for request body. See Details.
Method post_studies_id_attachments_name_compress()
Compress attachment
Change the compression scheme that is used to store an attachment.
Method get_studies_id_attachments_name_compressed_data()
Get attachment (no decompression)
Get the (binary) content of one attachment associated with
the given study. The attachment will not be decompressed if
StorageCompression is TRUE.
Usage
Orthanc$get_studies_id_attachments_name_compressed_data(
id,
name,
params = NULL,
headers = NULL
)Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Content-Range (string): Optional content range to access part of the attachment (new in Orthanc 1.12.5)
If-None-Match (string): Optional revision of the attachment, to check if its content has changed
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
Method get_studies_id_attachments_name_compressed_md5()
Get MD5 of attachment on disk
Get the MD5 hash of one attachment associated with the given
study, as stored on the disk. This is different from .../md5
iff EnableStorage is TRUE.
Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_studies_id_attachments_name_compressed_size()
Get size of attachment on disk
Get the size of one attachment associated with the given study,
as stored on the disk. This is different from .../size iff
EnableStorage is TRUE.
Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_studies_id_attachments_name_data()
Get attachment
Get the (binary) content of one attachment associated with the given study
Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).params(list) Named-list of optional query parameters. See Details.
headers(list) Named-list of optional header parameters. See Details.
Details
Optional headers (headers):
Content-Range (string): Optional content range to access part of the attachment (new in Orthanc 1.12.5)
If-None-Match (string): Optional revision of the attachment, to check if its content has changed
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
Method get_studies_id_attachments_name_info()
Get info about the attachment
Get all the information about the attachment associated with the given study
Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_studies_id_attachments_name_is_compressed()
Is attachment compressed?
Test whether the attachment has been stored as a compressed file on the disk.
Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_studies_id_attachments_name_md5()
Get MD5 of attachment
Get the MD5 hash of one attachment associated with the given study
Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_studies_id_attachments_name_size()
Get size of attachment
Get the size of one attachment associated with the given study
Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the attachment, or its index (cf.
UserContentTypeconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method post_studies_id_attachments_name_uncompress()
Uncompress attachment
Change the compression scheme that is used to store an attachment.
Method post_studies_id_attachments_name_verify_md5()
Verify attachment
Verify that the attachment is not corrupted, by validating its MD5 hash
Method get_studies_id_instances()
Get child instances
Get detailed information about the child instances of the DICOM study whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the study of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
expand (string): If false or missing, only retrieve the list of child instances
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method get_studies_id_instances_tags()
Get tags of instances
Get the tags of all the child instances of the DICOM study whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the study of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
ignore-length (array): Also include the DICOM tags that are provided in this list, even if their associated value is long
short (boolean): If present, report the DICOM tags in hexadecimal format
simplify (boolean): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)
Method get_studies_id_labels()
List labels
Get the labels that are associated with the given study (new in Orthanc 1.12.0)
Method delete_studies_id_labels_label()
Remove label
Remove a label associated with a study
Method get_studies_id_labels_label()
Test label
Test whether the study is associated with the given label
Method put_studies_id_labels_label()
Add label
Associate a label with a study
Method get_studies_id_media()
Create DICOMDIR media
Synchronously create a DICOMDIR media containing the DICOM study
whose Orthanc identifier is provided in the URL. This flavor
is synchronous, which might not be desirable to archive large
amount of data, as it might lead to network timeouts. Prefer the
asynchronous version using POST method.
Arguments
id(character) Orthanc identifier of the study of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
extended (string): If present, will include additional tags such as
SeriesDescription, leading to a so-called extended DICOMDIRfilename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
lossy-quality (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)
transcode (string): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
Method post_studies_id_media()
Create DICOMDIR media
Create a DICOMDIR media containing the DICOM study whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the study of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): If
TRUE, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.Extended (logical): If
TRUE, will include additional tags such asSeriesDescription, leading to a so-called extended DICOMDIR. Default value isFALSE.Filename (character): Filename to set in the "Content-Disposition" HTTP header (including file extension)
LossyQuality (numeric): 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)
Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority.
Synchronous (logical): If
TRUE, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option "SynchronousZipStream" is set to "false", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.Transcode (character): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): In asynchronous mode, user data that will be attached to the job.
Method post_studies_id_merge()
Merge study
Start a new job so as to move some DICOM resources into the DICOM study whose Orthanc identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/anonymization.html#merging
Arguments
id(character) Orthanc identifier of the study of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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.KeepSource (logical): If set to
TRUE, instructs Orthanc to keep a copy of the original resources in their source study. By default, the original resources are deleted from Orthanc.Permissive (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0Resources (list): The list of DICOM resources (studies, series, and/or instances) to be merged into the study of interest (mandatory option)
Synchronous (logical): 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.UserData (list): User data that will travel along with the job.
Method get_studies_id_metadata()
List metadata
Get the list of metadata that are associated with the given study
Arguments
id(character) Orthanc identifier of the study of interest.
params(list) Named-list of optional query parameters. See Details.
Method delete_studies_id_metadata_name()
Delete metadata
Delete some metadata associated with the given DICOM study. This call will fail if trying to delete a system metadata (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the metadata, or its index (cf.
UserMetadataconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method get_studies_id_metadata_name()
Get metadata
Get the value of a metadata that is associated with the given study
Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the metadata, or its index (cf.
UserMetadataconfiguration option).headers(list) Named-list of optional header parameters. See Details.
Method put_studies_id_metadata_name()
Set metadata
Set the value of some metadata in the given DICOM study. This call will fail if trying to modify a system metadata (i.e. whose index is < 1024).
Arguments
id(character) Orthanc identifier of the study of interest.
name(character) The name of the metadata, or its index (cf.
UserMetadataconfiguration option).headers(list) Named-list of optional header parameters. See Details.
data(bytes or character) Raw data for request body. See Details.
Method post_studies_id_modify()
Modify study
Start a job that will modify 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#modification-of-studies-or-series
Arguments
id(character) Orthanc identifier of the study of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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.Force (logical): Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
Keep (list): Keep the original value of the specified tags, to be chosen among the
StudyInstanceUID,SeriesInstanceUIDandSOPInstanceUIDtags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.KeepSource (logical): If set to
FALSE, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.LossyQuality (numeric): 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 (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0PrivateCreator (character): The private creator to be used for private tags in
ReplaceRemove (list): List of tags that must be removed from the DICOM instances. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the
dcmodifycommand-line tool (wildcards are supported as well).RemovePrivateTags (logical): Remove the private tags from the DICOM instances (defaults to
FALSE)Replace (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Synchronous (logical): 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 (character): Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): User data that will travel along with the job.
Method get_studies_id_module()
Get study module
Get the study module of the DICOM study whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the study of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
ignore-length (array): Also include the DICOM tags that are provided in this list, even if their associated value is long
short (boolean): If present, report the DICOM tags in hexadecimal format
simplify (boolean): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)
Method get_studies_id_module_patient()
Get patient module of study
Get the patient module of the DICOM study whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the study of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
ignore-length (array): Also include the DICOM tags that are provided in this list, even if their associated value is long
short (boolean): If present, report the DICOM tags in hexadecimal format
simplify (boolean): If present, report the DICOM tags in human-readable format (using the symbolic name of the tags)
Method get_studies_id_patient()
Get parent patient
Get detailed information about the parent patient of the DICOM study whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the study of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method post_studies_id_reconstruct()
Reconstruct tags & optionally files of study
Reconstruct the main DICOM tags in DB of the study whose Orthanc identifier is provided in the URL. This is useful if child studies/series/instances have inconsistent values for higher-level tags, in order to force Orthanc to use the value from the resource of interest. Beware that this is a time-consuming operation, as all the children DICOM instances will be parsed again, and the Orthanc index will be updated accordingly.
Arguments
id(character) Orthanc identifier of the study of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
LimitToThisLevelMainDicomTags (logical): Only reconstruct this level MainDicomTags by re-reading them from a random child instance of the resource. This option is much faster than a full reconstruct and is useful e.g. if you have modified the 'ExtraMainDicomTags' at the Study level to optimize the speed of some C-Find. 'false' by default. (New in Orthanc 1.12.4)
ReconstructFiles (logical): Also reconstruct the files of the resources (e.g: apply IngestTranscoding, StorageCompression). 'false' by default. (New in Orthanc 1.11.0)
Method get_studies_id_series()
Get child series
Get detailed information about the child series of the DICOM study whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the study of interest.
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
expand (string): If false or missing, only retrieve the list of child series
full (boolean): If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)
requested-tags (string): If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requested-tags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
short (boolean): If present, report the DICOM tags in hexadecimal format
Method get_studies_id_shared_tags()
Get shared tags
Extract the DICOM tags whose value is constant across all the child instances of the DICOM study whose Orthanc identifier is provided in the URL
Arguments
id(character) Orthanc identifier of the study of interest.
params(list) Named-list of optional query parameters. See Details.
Method post_studies_id_split()
Split study
Start a new job so as to split the DICOM study whose
Orthanc identifier is provided in the URL, by taking some
of its children series or instances out of it and putting
them into a brand new study (this new study is created by
setting the StudyInstanceUID tag to a random identifier):
https://orthanc.uclouvain.be/book/users/anonymization.html#splitting
Arguments
id(character) Orthanc identifier of the study of interest.
json(list) Named-list for request body. See Details.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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.Instances (list): The list of instances to be separated from the parent study. These instances must all be children of the same source study, that is specified in the URI.
KeepLabels (logical): Keep the labels of all resources level (defaults to
FALSE)KeepSource (logical): If set to
TRUE, instructs Orthanc to keep a copy of the original series/instances in the source study. By default, the original series/instances are deleted from Orthanc.Permissive (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0Remove (list): List of tags that must be removed in the new study (from the same modules as in the
Replaceoption)Replace (list): Associative array to change the value of some DICOM tags in the new study. These tags must be part of the "Patient Module Attributes" or the "General Study Module Attributes", as specified by the DICOM 2011 standard in Tables C.7-1 and C.7-3.
Series (list): The list of series to be separated from the parent study. These series must all be children of the same source study, that is specified in the URI.
Synchronous (logical): 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.UserData (list): User data that will travel along with the job.
Method get_tools_accepted_sop_classes()
Get accepted SOPClassUID
Get the list of SOP Class UIDs that are accepted by Orthanc
C-STORE SCP. This corresponds to the configuration options
AcceptedSopClasses and RejectedSopClasses.
Method get_tools_accepted_transfer_syntaxes()
Get accepted transfer syntaxes
Get the list of UIDs of the DICOM transfer syntaxes that
are accepted by Orthanc C-STORE SCP. This corresponds to
the configuration options AcceptedTransferSyntaxes and
XXXTransferSyntaxAccepted.
Method put_tools_accepted_transfer_syntaxes()
Set accepted transfer syntaxes
Set the DICOM transfer syntaxes that accepted by Orthanc C-STORE SCP
Arguments
json(list) Named-list for request body. See Details.
data(bytes or character) Raw data for request body. See Details.
Method post_tools_bulk_anonymize()
Anonymize a set of resources
Start a job that will anonymize all the DICOM patients, studies,
series or instances whose identifiers are provided in the
Resources field.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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 (character): Version of the DICOM standard to be used for anonymization. Check out configuration option
DeidentifyLogsDicomVersionfor possible values.Force (logical): Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
Keep (list): 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
dcmodifycommand-line tool (wildcards are supported as well).KeepLabels (logical): Keep the labels of all resources level (defaults to
FALSE)KeepPrivateTags (logical): Keep the private tags from the DICOM instances (defaults to
FALSE)KeepSource (logical): If set to
FALSE, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.LossyQuality (numeric): 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 (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0PrivateCreator (character): The private creator to be used for private tags in
ReplaceRemove (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Replace (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Resources (list): List of the Orthanc identifiers of the patients/studies/series/instances of interest.
Synchronous (logical): 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 (character): Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): User data that will travel along with the job.
Method post_tools_bulk_content()
Describe a set of resources
Get the content all the DICOM patients, studies, series or
instances whose identifiers are provided in the Resources
field, in one single call.
Details
Request body JSON schema (application/json):
Full (logical): If set to
TRUE, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)Level (character): This optional argument specifies the level of interest (can be
Patient,Study,SeriesorInstance). Orthanc will loop over the items insideResources, and explore upward or downward in the DICOM hierarchy in order to find the level of interest.Metadata (logical): If set to
TRUE(default value), the metadata associated with the resources will also be retrieved.Resources (list): List of the Orthanc identifiers of the patients/studies/series/instances of interest.
Short (logical): If set to
TRUE, report the DICOM tags in hexadecimal format
Method post_tools_bulk_delete()
Delete a set of resources
Delete all the DICOM patients, studies, series or instances whose
identifiers are provided in the Resources field.
Method post_tools_bulk_modify()
Modify a set of resources
Start a job that will modify all the DICOM patients, studies,
series or instances whose identifiers are provided in the
Resources field.
Details
Request body JSON schema (application/json):
Asynchronous (logical): 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.Force (logical): Allow the modification of tags related to DICOM identifiers, at the risk of breaking the DICOM model of the real world
Keep (list): Keep the original value of the specified tags, to be chosen among the
StudyInstanceUID,SeriesInstanceUIDandSOPInstanceUIDtags. Avoid this feature as much as possible, as this breaks the DICOM model of the real world.KeepSource (logical): If set to
FALSE, instructs Orthanc to the remove original resources. By default, the original resources are kept in Orthanc.Level (character): Level of the modification (
Patient,Study,SeriesorInstance). If absent, the level defaults toInstance, but is set toPatientifPatientIDis modified, toStudyifStudyInstanceUIDis modified, or toSeriesifSeriesInstancesUIDis modified. (new in Orthanc 1.9.7)LossyQuality (numeric): 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 (logical): If
TRUE, ignore errors during the individual steps of the job. Default value isFALSE.Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is
0PrivateCreator (character): The private creator to be used for private tags in
ReplaceRemove (list): List of tags that must be removed from the DICOM instances. Starting with Orthanc 1.9.4, paths to subsequences can be provided using the same syntax as the
dcmodifycommand-line tool (wildcards are supported as well).RemovePrivateTags (logical): Remove the private tags from the DICOM instances (defaults to
FALSE)Replace (list): 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
dcmodifycommand-line tool (wildcards are supported as well).Resources (list): List of the Orthanc identifiers of the patients/studies/series/instances of interest.
Synchronous (logical): 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 (character): Transcode the DICOM instances to the provided DICOM transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): User data that will travel along with the job.
Method post_tools_count_resources()
Count local resources
This URI can be used to count the resources that are matching criteria on the content of the local Orthanc server, in a way that is similar to tools/find
Details
Request body JSON schema (application/json):
Full (logical): If set to
TRUE, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)Labels (list): List of strings specifying which labels to look for in the resources (new in Orthanc 1.12.0)
LabelsConstraint (character): Constraint on the labels, can be
All,Any, orNone(defaults toAll, new in Orthanc 1.12.0)Level (character): Level of the query (
Patient,Study,SeriesorInstance)MetadataQuery (list): Associative array containing the filter on the values of the metadata (new in Orthanc 1.12.5)
ParentPatient (character): Limit the reported resources to descendants of this patient (new in Orthanc 1.12.5)
ParentSeries (character): Limit the reported resources to descendants of this series (new in Orthanc 1.12.5)
ParentStudy (character): Limit the reported resources to descendants of this study (new in Orthanc 1.12.5)
Query (list): Associative array containing the filter on the values of the DICOM tags
Short (logical): If set to
TRUE, report the DICOM tags in hexadecimal format
Method get_tools_create_archive()
Create ZIP archive
Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument
Arguments
resources(character) A comma separated list of Orthanc resource identifiers to include in the ZIP archive..
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
lossy-quality (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)
transcode (string): If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
Method post_tools_create_archive()
Create ZIP archive
Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
Details
Request body JSON schema (application/json):
Asynchronous (logical): If
TRUE, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.Filename (character): Filename to set in the "Content-Disposition" HTTP header (including file extension)
LossyQuality (numeric): 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)
Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority.
Resources (list): The list of Orthanc identifiers of interest.
Synchronous (logical): If
TRUE, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option "SynchronousZipStream" is set to "false", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.Transcode (character): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): In asynchronous mode, user data that will be attached to the job.
Method post_tools_create_dicom()
Create one DICOM instance
Create one DICOM instance, and store it into Orthanc
Details
Request body JSON schema (application/json):
Content (character): This field can be used to embed an image (pixel data encoded as PNG or JPEG), a PDF, or a 3D manufactoring model (MTL/OBJ/STL) inside the created DICOM instance. The file to be encapsulated must be provided using its data URI scheme encoding. This field can possibly contain a JSON array, in which case a DICOM series is created containing one DICOM instance for each item in the
Contentfield.Encapsulate (logical): If set to
TRUE, encapsulate the binary data ofContentDataas such, using a compressed transfer syntax. Only applicable ifContentDatacontains a grayscale or color JPEG image in 8bpp, in which case the transfer syntax is set to "1.2.840.10008.1.2.4.50". (new in Orthanc 1.12.7)Force (logical): Avoid the consistency checks for the DICOM tags that enforce the DICOM model of the real-world. You can notably use this flag if you need to manually set the tags
StudyInstanceUID,SeriesInstanceUID, orSOPInstanceUID. Be careful with this feature.InterpretBinaryTags (logical): If some value in the
Tagsassociative array is formatted according to some data URI scheme encoding, whether this value is decoded to a binary value or kept as such (TRUEby default)Parent (character): If present, the newly created instance will be attached to the parent DICOM resource whose Orthanc identifier is contained in this field. The DICOM tags of the parent modules in the DICOM hierarchy will be automatically copied to the newly created instance.
PrivateCreator (character): The private creator to be used for private tags in
TagsTags (list): Associative array containing the tags of the new instance to be created
Method get_tools_create_media()
Create DICOMDIR media
Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument
Arguments
resources(character) A comma separated list of Orthanc resource identifiers to include in the DICOMDIR media..
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
lossy-quality (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)
transcode (string): If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
Method post_tools_create_media()
Create DICOMDIR media
Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
Details
Request body JSON schema (application/json):
Asynchronous (logical): If
TRUE, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.Extended (logical): If
TRUE, will include additional tags such asSeriesDescription, leading to a so-called extended DICOMDIR. Default value isFALSE.Filename (character): Filename to set in the "Content-Disposition" HTTP header (including file extension)
LossyQuality (numeric): 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)
Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority.
Resources (list): The list of Orthanc identifiers of interest.
Synchronous (logical): If
TRUE, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option "SynchronousZipStream" is set to "false", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.Transcode (character): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): In asynchronous mode, user data that will be attached to the job.
Method get_tools_create_media_extended()
Create DICOMDIR media
Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument
Arguments
resources(character) A comma separated list of Orthanc resource identifiers to include in the DICOMDIR media..
params(list) Named-list of optional query parameters. See Details.
Details
Optional query parameters (params):
filename (string): Filename to set in the "Content-Disposition" HTTP header (including file extension)
lossy-quality (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)
transcode (string): If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
Method post_tools_create_media_extended()
Create DICOMDIR media
Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
Details
Request body JSON schema (application/json):
Asynchronous (logical): If
TRUE, create the archive in asynchronous mode, which means that a job is submitted to create the archive in background.Extended (logical): If
TRUE, will include additional tags such asSeriesDescription, leading to a so-called extended DICOMDIR. Default value isTRUE.Filename (character): Filename to set in the "Content-Disposition" HTTP header (including file extension)
LossyQuality (numeric): 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)
Priority (numeric): In asynchronous mode, the priority of the job. The higher the value, the higher the priority.
Resources (list): The list of Orthanc identifiers of interest.
Synchronous (logical): If
TRUE, create the archive in synchronous mode, which means that the HTTP answer will directly contain the ZIP file. This is the default, easy behavior. However, if global configuration option "SynchronousZipStream" is set to "false", asynchronous transfers should be preferred for large amount of data, as the creation of the temporary file might lead to network timeouts.Transcode (character): If present, the DICOM files in the archive will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html
UserData (list): In asynchronous mode, user data that will be attached to the job.
Method get_tools_default_encoding()
Get default encoding
Get the default encoding that is used by Orthanc if parsing
a DICOM instance without the SpecificCharacterEncoding tag,
or during C-FIND. This corresponds to the configuration option
DefaultEncoding.
Method put_tools_default_encoding()
Set default encoding
Change the default encoding that is used by Orthanc if parsing
a DICOM instance without the SpecificCharacterEncoding tag,
or during C-FIND. This corresponds to the configuration option
DefaultEncoding.
Method get_tools_dicom_conformance()
Get DICOM conformance
Get the DICOM conformance statement of Orthanc
Method post_tools_dicom_echo()
Trigger C-ECHO SCU
Trigger C-ECHO SCU command against a DICOM modality described in
the POST body, without having to register the modality in some
/modalities/{id} (new in Orthanc 1.8.1)
Details
Request body JSON schema (application/json):
AET (character): AET of the remote DICOM modality
CheckFind (logical): Issue a dummy C-FIND command after the C-GET SCU, in order to check whether the remote modality knows about Orthanc. This field defaults to the value of the
DicomEchoChecksFindconfiguration option. New in Orthanc 1.8.1.Host (character): Host address of the remote DICOM modality (typically, an IP address)
LocalAet (character): Whether to override the default DicomAet in the SCU connection initiated by Orthanc to this modality
Manufacturer (character): Manufacturer of the remote DICOM modality (check configuration option
DicomModalitiesfor possible valuesPort (numeric): TCP port of the remote DICOM modality
Timeout (numeric): Whether to override the default DicomScuTimeout in the SCU connection initiated by Orthanc to this modality
UseDicomTls (logical): Whether to use DICOM TLS in the SCU connection initiated by Orthanc (new in Orthanc 1.9.0)
Method post_tools_execute_script()
Execute Lua script
Execute the provided Lua script by the Orthanc server. This is
very insecure for Orthanc servers that are remotely accessible.
Since Orthanc 1.5.8, this route is disabled by default and can be
enabled thanks to the ExecuteLuaEnabled configuration.
Method post_tools_find()
Look for local resources
This URI can be used to perform a search on the content of the local Orthanc server, in a way that is similar to querying remote DICOM modalities using C-FIND SCU: https://orthanc.uclouvain.be/book/users/rest.html#performing-finds-within-orthanc
Details
Request body JSON schema (application/json):
CaseSensitive (logical): Enable case-sensitive search for PN value representations (defaults to configuration option
CaseSensitivePN)Expand (logical): If set to "true", retrieve detailed information about the individual resources, not only their Orthanc identifiers
Full (logical): If set to
TRUE, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)Labels (list): List of strings specifying which labels to look for in the resources (new in Orthanc 1.12.0)
LabelsConstraint (character): Constraint on the labels, can be
All,Any, orNone(defaults toAll, new in Orthanc 1.12.0)Level (character): Level of the query (
Patient,Study,SeriesorInstance)Limit (numeric): Limit the number of reported resources
MetadataQuery (list): Associative array containing the filter on the values of the metadata (new in Orthanc 1.12.5)
OrderBy (list): Array of associative arrays containing the requested ordering (new in Orthanc 1.12.5)
ParentPatient (character): Limit the reported resources to descendants of this patient (new in Orthanc 1.12.5)
ParentSeries (character): Limit the reported resources to descendants of this series (new in Orthanc 1.12.5)
ParentStudy (character): Limit the reported resources to descendants of this study (new in Orthanc 1.12.5)
Query (list): Associative array containing the filter on the values of the DICOM tags
RequestedTags (list): A list of DICOM tags to include in the response (applicable only if "Expand" is set to true). The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return all Main Dicom Tags to keep backward compatibility with Orthanc prior to 1.11.0.
ResponseContent (list): Defines the content of response for each returned resource. (this field, if present, overrides the "Expand" field). Allowed values are
MainDicomTags,Metadata,Children,Parent,Labels,Status,IsStable,IsProtected,Attachments. If not specified, Orthanc will returnMainDicomTags,Metadata,Children,Parent,Labels,Status,IsStable,IsProtected.(new in Orthanc 1.12.5)Short (logical): If set to
TRUE, report the DICOM tags in hexadecimal formatSince (numeric): Show only the resources since the provided index (in conjunction with
Limit)
Method post_tools_invalidate_tags()
Invalidate DICOM-as-JSON summaries
Remove all the attachments of the type "DICOM-as-JSON"
that are associated will all the DICOM instances stored
in Orthanc. These summaries will be automatically
re-created on the next access. This is notably useful
after changes to the Dictionary configuration option.
https://orthanc.uclouvain.be/book/faq/orthanc-storage.html#storage-area
Method get_tools_labels()
Get all the used labels
List all the labels that are associated with any resource of the Orthanc database
Method get_tools_log_level_dicom()
Get log level for dicom
Get the log level of the log category dicom
Method put_tools_log_level_dicom()
Set log level for dicom
Set the log level of the log category dicom
Method get_tools_log_level_generic()
Get log level for generic
Get the log level of the log category generic
Method put_tools_log_level_generic()
Set log level for generic
Set the log level of the log category generic
Method get_tools_log_level_plugins()
Get log level for plugins
Get the log level of the log category plugins
Method put_tools_log_level_plugins()
Set log level for plugins
Set the log level of the log category plugins
Method get_tools_log_level_sqlite()
Get log level for sqlite
Get the log level of the log category sqlite
Method put_tools_log_level_sqlite()
Set log level for sqlite
Set the log level of the log category sqlite
Method post_tools_lookup()
Look for DICOM identifiers
This URI can be used to convert one DICOM identifier to a list of matching Orthanc resources
Method get_tools_metrics()
Are metrics collected?
Returns a Boolean specifying whether Prometheus metrics are
collected and exposed at /tools/metrics-prometheus
Method put_tools_metrics()
Enable collection of metrics
Enable or disable the collection and publication of metrics at
/tools/metrics-prometheus
Method get_tools_metrics_prometheus()
Get usage metrics
Get usage metrics of Orthanc in the Prometheus file format (OpenMetrics): https://orthanc.uclouvain.be/book/users/advanced-rest.html#instrumentation-with-prometheus
Method post_tools_reconstruct()
Reconstruct all the index
Reconstruct the index of all the tags of all the DICOM instances that are stored in Orthanc. This is notably useful after the deletion of resources whose children resources have inconsistent values with their sibling resources. Beware that this is a highly time-consuming operation, as all the DICOM instances will be parsed again, and as all the Orthanc index will be regenerated. If you have a large database to process, it is advised to use the Housekeeper plugin to perform this action resource by resource
Method get_tools_unknown_sop_class_accepted()
Is unknown SOP class accepted?
Shall Orthanc C-STORE SCP accept DICOM instances with an unknown SOP class UID?
Method put_tools_unknown_sop_class_accepted()
Set unknown SOP class accepted
Set whether Orthanc C-STORE SCP should accept DICOM instances with an unknown SOP class UID