v1

latestOpenAPI 3.0.02026-07-132990743.4 KB
System

Create one DICOM instance

Create one DICOM instance, and store it into Orthanc

post/tools/create-dicom

Request body

Contentstring

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 Content field.

Encapsulateboolean

If set to true, encapsulate the binary data of ContentData as such, using a compressed transfer syntax. Only applicable if ContentData contains 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)

Forceboolean

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, or SOPInstanceUID. Be careful with this feature.

InterpretBinaryTagsboolean

If some value in the Tags associative array is formatted according to some data URI scheme encoding, whether this value is decoded to a binary value or kept as such (true by default)

Parentstring

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.

PrivateCreatorstring

The private creator to be used for private tags in Tags

Tagsobject

Associative array containing the tags of the new instance to be created

Response

IDstring

Orthanc identifier of the newly created instance

Pathstring

Path to access the instance in the REST API