Download OpenAPI specification:Download
WADO-URI, WADO-RS, QIDO-RS, STOW-RS and UPS-RS RESTful services implementation
The URI Service, also known as WADO-URI, enables a user agent to retrieve representations of Instances using HTTP. The URI Service has two transactions:
application/dicom media type.These two transactions have the same "requestType" type but are differentiated by their Selected Media Type.
If there is no "contentType" Query Parameter and the Accept header field is */*, then the Selected Media Type
defaults to image/jpeg media type and the transaction defaults to Retrieve Rendered Instance.
| requestType required | string Example: requestType=WADO This parameter specifies that this is a URI service request. The parameter name shall be "requestType", and the value shall be "WADO". If the value is other than "WADO", and the origin server does not support the value, the response shall be 400 (Bad Request), and may include a payload containing an appropriate error message. |
| studyUID required | string <Unique Identifier (UI)> The value of this parameter is a Study Instance UID. |
| seriesUID required | string <Unique Identifier (UI)> The value of this parameter is a Series Instance UID. |
| objectUID required | string <Unique Identifier (UI)> The value of this parameter is a SOP Instance UID. |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| character-set | string <character-set> The Character Set Query Parameter value is a comma-separated list of one or more character set identifiers. See PS3.18 8.3.3.2 |
| frameNumber | integer >= 1 This parameter specifies a single frame within a multi-frame image Instance, as defined in PS3.3 that shall be returned. Its name is "frameNumber" and its value shall be a positive integer (i.e., starts at 1 not 0). This parameter applyed only to Retrieve Rendered Instance transaction. |
| annotation | stringpatient|technique This parameter specifies that the rendered images or video will have annotations. See PS3.18 8.3.2.1.1. This parameter applyed only to Retrieve Rendered Instance transaction. |
| quality | integer [ 1 .. 100 ] The "quality" parameter specifies the requested quality of the rendered images or video. The "quality" parameter is only supported for media types that allow lossy compression. See PS3.13 8.3.5.1.2. This parameter applyed only to Retrieve Rendered Instance transaction. |
| rows | integer <int64> >= 1 This parameter specifies the height, in pixels, of the returned image. If this parameter present, the "columns" parameter shall be present. This parameter applyed only to Retrieve Rendered Instance transaction. |
| columns | integer <int64> >= 1 This parameter specifies the width, in pixels, of the returned image. If this parameter present, the "rows" parameter shall be present. This parameter applyed only to Retrieve Rendered Instance transaction. |
| region | Array of numbers <float> = 4 items [ items <float > ] Example: region=0.1,0.1,0.9,0.8 This parameter specifies a rectangular region of the Target resource. Its values shall be a comma-separated list of four positive decimal numbers:
The region is specified using a normalized coordinate system relative to the size of the original image matrix, measured in rows and columns, where:
This parameter when used in conjunction with "row" and "columns" parameters, allows the user agent to map a selected area of the source image into its viewport. This parameter applyed only to Retrieve Rendered Instance transaction. |
| windowCenter | number <DS (Decimal String)> This parameter specifies the Window Center of the returned image as defined in PS3.3. The Windowing parameters (Window Center and Window Width) are optional; however, if either is present, both shall be present. This parameter applyed only to Retrieve Rendered Instance transaction. |
| windowWidth | number <DS (Decimal String)> This parameter specifies the Window Width of the returned image as defined in PS3.3. The Windowing parameters (Window Center and Window Width) are optional; however, if either is present, both shall be present. This parameter applyed only to Retrieve Rendered Instance transaction. |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
One or more required parameters are missed
Searches the entire service for Studies that match the search parameters, and returns a list of matching Studies, including the default and requested Attributes that are supported for each Study.
object One or more DICOM Attribute/Values pairs specify the matching criteria for the search. See PS3.18 8.3.4.1 | |
| StudyInstanceUID | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| 0020000D | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| fuzzymatching | boolean Default: false A single parameter specifies whether Fuzzy Matching of Person Names is to be performed. See PS3.18 8.3.4.2 |
| includefield | string <^(all|\w(,\w)+)$> A parameter specifies the Attributes that should be included in the response. See PS3.18 8.3.4.3 |
| limit | integer <int64> >= 0 A single parameter specifies the maximum number of matches the origin server shall return in a single response. See PS3.18 8.3.4.4 |
| offset | integer <int64> >= 0 Default: 0 A single parameter specifies the number of matches the origin server shall skip before the first returned match. See PS3.18 8.3.4.4 |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
[- {
- "Study Date": "string",
- "Study Time": "string",
- "Accession Number": "string",
- "Instance Availability": "string",
- "Modalities in Study": "string",
- "Referring Physician's Name": "string",
- "Timezone Offset From UTC": "string",
- "Retrieve URL": "string",
- "Patient's Name": "string",
- "Patient ID": "string",
- "Patient's Birth Date": "string",
- "Patient's Sex": "string",
- "Study Instance UID": "string",
- "Study ID": "string",
- "Number of Study Related Series": "string",
- "Number of Study Related Instances": "string"
}
]Searches for all Series in the specified Study that match the search parameters, and returns a list of matching Series, including the default and requested Attributes that are supported for each Series.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
object One or more DICOM Attribute/Values pairs specify the matching criteria for the search. See PS3.18 8.3.4.1 | |
| SeriesInstanceUID | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| 0020000E | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| fuzzymatching | boolean Default: false A single parameter specifies whether Fuzzy Matching of Person Names is to be performed. See PS3.18 8.3.4.2 |
| includefield | string <^(all|\w(,\w)+)$> A parameter specifies the Attributes that should be included in the response. See PS3.18 8.3.4.3 |
| limit | integer <int64> >= 0 A single parameter specifies the maximum number of matches the origin server shall return in a single response. See PS3.18 8.3.4.4 |
| offset | integer <int64> >= 0 Default: 0 A single parameter specifies the number of matches the origin server shall skip before the first returned match. See PS3.18 8.3.4.4 |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
[- {
- "Modality": "string",
- "Series Description": "string",
- "Instance Availability": "string",
- "Retrieve URL": "string",
- "Series Instance UID": "string",
- "Series Number": "string",
- "Number of Series Related Instances": "string",
- "Scheduled Procedure Step ID": "string",
- "Requested Procedure ID": "string"
}
]Searches the entire service for Series that match the search parameters, and returns a list of matching Series, including the default and requested Attributes that are supported for each Series.
object One or more DICOM Attribute/Values pairs specify the matching criteria for the search. See PS3.18 8.3.4.1 | |
| StudyInstanceUID | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| 0020000D | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
object One or more DICOM Attribute/Values pairs specify the matching criteria for the search. See PS3.18 8.3.4.1 | |
| SeriesInstanceUID | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| 0020000E | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| fuzzymatching | boolean Default: false A single parameter specifies whether Fuzzy Matching of Person Names is to be performed. See PS3.18 8.3.4.2 |
| includefield | string <^(all|\w(,\w)+)$> A parameter specifies the Attributes that should be included in the response. See PS3.18 8.3.4.3 |
| limit | integer <int64> >= 0 A single parameter specifies the maximum number of matches the origin server shall return in a single response. See PS3.18 8.3.4.4 |
| offset | integer <int64> >= 0 Default: 0 A single parameter specifies the number of matches the origin server shall skip before the first returned match. See PS3.18 8.3.4.4 |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
[- {
- "Study Date": "string",
- "Study Time": "string",
- "Accession Number": "string",
- "Instance Availability": "string",
- "Modalities in Study": "string",
- "Referring Physician's Name": "string",
- "Timezone Offset From UTC": "string",
- "Retrieve URL": "string",
- "Patient's Name": "string",
- "Patient ID": "string",
- "Patient's Birth Date": "string",
- "Patient's Sex": "string",
- "Study Instance UID": "string",
- "Study ID": "string",
- "Number of Study Related Series": "string",
- "Number of Study Related Instances": "string",
- "Modality": "string",
- "Series Description": "string",
- "Series Instance UID": "string",
- "Series Number": "string",
- "Number of Series Related Instances": "string",
- "Scheduled Procedure Step ID": "string",
- "Requested Procedure ID": "string"
}
]Searches for all Instances in the specified Study and Series that match the search parameters, and returns a list of matching Instances, including the default and requested Attributes that are supported for each Series
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| InstanceNumber | string <Integer String (IS)> A pair of Attribute/Value specify the matching criteria for the search. |
| SOPClassUID | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| SOPInstanceUID | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
[- {
- "SOP Class UID": "string",
- "SOP Instance UID": "string",
- "Instance Number": "string",
- "Number of Frames": "string",
- "Instance Availability": "string",
- "Retrieve URL": "string"
}
]Searches for all Instances in the specified Study that match the search parameters, and returns a list of matching Instances, including the default and requested Attributes that are supported for each Instance.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
object One or more DICOM Attribute/Values pairs specify the matching criteria for the search. See PS3.18 8.3.4.1 | |
| SeriesInstanceUID | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| 0020000E | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| InstanceNumber | string <Integer String (IS)> A pair of Attribute/Value specify the matching criteria for the search. |
| SOPClassUID | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| SOPInstanceUID | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| fuzzymatching | boolean Default: false A single parameter specifies whether Fuzzy Matching of Person Names is to be performed. See PS3.18 8.3.4.2 |
| includefield | string <^(all|\w(,\w)+)$> A parameter specifies the Attributes that should be included in the response. See PS3.18 8.3.4.3 |
| limit | integer <int64> >= 0 A single parameter specifies the maximum number of matches the origin server shall return in a single response. See PS3.18 8.3.4.4 |
| offset | integer <int64> >= 0 Default: 0 A single parameter specifies the number of matches the origin server shall skip before the first returned match. See PS3.18 8.3.4.4 |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
[- {
- "Study Date": "string",
- "Study Time": "string",
- "Accession Number": "string",
- "Instance Availability": "string",
- "Modalities in Study": "string",
- "Referring Physician's Name": "string",
- "Timezone Offset From UTC": "string",
- "Retrieve URL": "string",
- "Patient's Name": "string",
- "Patient ID": "string",
- "Patient's Birth Date": "string",
- "Patient's Sex": "string",
- "Study Instance UID": "string",
- "Study ID": "string",
- "Number of Study Related Series": "string",
- "Number of Study Related Instances": "string",
- "Modality": "string",
- "Series Description": "string",
- "Series Instance UID": "string",
- "Series Number": "string",
- "Number of Series Related Instances": "string",
- "Scheduled Procedure Step ID": "string",
- "Requested Procedure ID": "string",
- "SOP Class UID": "string",
- "SOP Instance UID": "string",
- "Instance Number": "string",
- "Number of Frames": "string"
}
]Searches the entire service for Instances that match the search parameters, and returns a list of matching Instances, including the default and requested Attributes that are supported for each Series.
object One or more DICOM Attribute/Values pairs specify the matching criteria for the search. See PS3.18 8.3.4.1 | |
| StudyInstanceUID | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| 0020000D | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
object One or more DICOM Attribute/Values pairs specify the matching criteria for the search. See PS3.18 8.3.4.1 | |
| SeriesInstanceUID | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| 0020000E | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| InstanceNumber | string <Integer String (IS)> A pair of Attribute/Value specify the matching criteria for the search. |
| 00200013 | string <Integer String (IS)> A pair of Attribute/Value specify the matching criteria for the search. |
| SOPClassUID | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| 00080016 | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| SOPInstanceUID | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| 00080018 | Array of strings <Unique Identifier (UI)> A comma-separated list of UIDs. |
| fuzzymatching | boolean Default: false A single parameter specifies whether Fuzzy Matching of Person Names is to be performed. See PS3.18 8.3.4.2 |
| includefield | string <^(all|\w(,\w)+)$> A parameter specifies the Attributes that should be included in the response. See PS3.18 8.3.4.3 |
| limit | integer <int64> >= 0 A single parameter specifies the maximum number of matches the origin server shall return in a single response. See PS3.18 8.3.4.4 |
| offset | integer <int64> >= 0 Default: 0 A single parameter specifies the number of matches the origin server shall skip before the first returned match. See PS3.18 8.3.4.4 |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
[- {
- "Study Date": "string",
- "Study Time": "string",
- "Accession Number": "string",
- "Instance Availability": "string",
- "Modalities in Study": "string",
- "Referring Physician's Name": "string",
- "Timezone Offset From UTC": "string",
- "Retrieve URL": "string",
- "Patient's Name": "string",
- "Patient ID": "string",
- "Patient's Birth Date": "string",
- "Patient's Sex": "string",
- "Study Instance UID": "string",
- "Study ID": "string",
- "Number of Study Related Series": "string",
- "Number of Study Related Instances": "string",
- "Modality": "string",
- "Series Description": "string",
- "Series Instance UID": "string",
- "Series Number": "string",
- "Number of Series Related Instances": "string",
- "Scheduled Procedure Step ID": "string",
- "Requested Procedure ID": "string",
- "SOP Class UID": "string",
- "SOP Instance UID": "string",
- "Instance Number": "string",
- "Number of Frames": "string"
}
]Stores a set of representations that may have different Study Instance UIDs.
| Content-Type | string <media-type> The DICOM Media Type of the request payload. |
| Content-Length | integer <int64> >= 0 Shall be present if a content encoding has not been applied to the payload |
| Content-Encoding | string <encoding> Shall be present if a content encoding has been applied to the payload |
"string"Stores a set of representations that belong to the same Study, i.e., each representation shall have the same Study Instance UID.
| study required | string <Unique Identifier (UI)> Study UID |
| Content-Type | string <media-type> The DICOM Media Type of the request payload. |
| Content-Length | integer <int64> >= 0 Shall be present if a content encoding has not been applied to the payload |
| Content-Encoding | string <encoding> Shall be present if a content encoding has been applied to the payload |
"string"The Study resource references a single Study.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
The Series resource references a single Series.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
The Instance resource references a single Instance.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| instance required | string <Unique Identifier (UI)> The SOP Instance UID of an Instance contained within a Series resource. |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
The Study Metadata resource references the Metadata of a Study.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| character-set | string <character-set> The Character Set Query Parameter value is a comma-separated list of one or more character set identifiers. See PS3.18 8.3.3.2 |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
"string"The Series Metadata resource contains the Metadata of a Series in a Study.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| character-set | string <character-set> The Character Set Query Parameter value is a comma-separated list of one or more character set identifiers. See PS3.18 8.3.3.2 |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
"string"The Instance Metadata resource contains the Metadata of an Instance.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| instance required | string <Unique Identifier (UI)> The SOP Instance UID of an Instance contained within a Series resource. |
| character-set | string <character-set> The Character Set Query Parameter value is a comma-separated list of one or more character set identifiers. See PS3.18 8.3.3.2 |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
"string"The Rendered Study resource references a Study to be rendered.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| annotation | stringpatient|technique This parameter specifies that the rendered images or video will have annotations. See PS3.18 8.3.2.1.1 |
| quality | integer [ 1 .. 100 ] The "quality" parameter specifies the requested quality of the rendered images or video. The "quality" parameter is only supported for media types that allow lossy compression. See PS3.13 8.3.5.1.2 |
| viewport | string^\d+,\d+(,\d*,\d*,\d*,\d*)?$ Specifies a rectangular region of the source image(s) or video to be cropped, and a rectangular region corresponding to the size of the user agent's viewport to which the cropped image or video should be scaled. See PS3.18 8.3.2.1.3 |
| window | string^\d+,\d+,(linear|linear-exact|sigmoid)$ Controls the windowing of the images or video. See PS 8.13 8.3.5.1.4 |
| iccprofile | string^(no|yes|srgb|adobergb|rommrgb)$ Specifies the color characteristics of, and inclusion of an ICC Profile in, the rendered images. See PS3.18 8.3.5.1.5 |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
The Rendered Series resource references a Series to be rendered.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| annotation | stringpatient|technique This parameter specifies that the rendered images or video will have annotations. See PS3.18 8.3.2.1.1 |
| quality | integer [ 1 .. 100 ] The "quality" parameter specifies the requested quality of the rendered images or video. The "quality" parameter is only supported for media types that allow lossy compression. See PS3.13 8.3.5.1.2 |
| viewport | string^\d+,\d+(,\d*,\d*,\d*,\d*)?$ Specifies a rectangular region of the source image(s) or video to be cropped, and a rectangular region corresponding to the size of the user agent's viewport to which the cropped image or video should be scaled. See PS3.18 8.3.2.1.3 |
| window | string^\d+,\d+,(linear|linear-exact|sigmoid)$ Controls the windowing of the images or video. See PS 8.13 8.3.5.1.4 |
| iccprofile | string^(no|yes|srgb|adobergb|rommrgb)$ Specifies the color characteristics of, and inclusion of an ICC Profile in, the rendered images. See PS3.18 8.3.5.1.5 |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
The Rendered Instance resource references an Instance to be rendered.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| instance required | string <Unique Identifier (UI)> The SOP Instance UID of an Instance contained within a Series resource. |
| annotation | stringpatient|technique This parameter specifies that the rendered images or video will have annotations. See PS3.18 8.3.2.1.1 |
| quality | integer [ 1 .. 100 ] The "quality" parameter specifies the requested quality of the rendered images or video. The "quality" parameter is only supported for media types that allow lossy compression. See PS3.13 8.3.5.1.2 |
| viewport | string^\d+,\d+(,\d*,\d*,\d*,\d*)?$ Specifies a rectangular region of the source image(s) or video to be cropped, and a rectangular region corresponding to the size of the user agent's viewport to which the cropped image or video should be scaled. See PS3.18 8.3.2.1.3 |
| window | string^\d+,\d+,(linear|linear-exact|sigmoid)$ Controls the windowing of the images or video. See PS 8.13 8.3.5.1.4 |
| iccprofile | string^(no|yes|srgb|adobergb|rommrgb)$ Specifies the color characteristics of, and inclusion of an ICC Profile in, the rendered images. See PS3.18 8.3.5.1.5 |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
The Rendered Frames resource references an ordered collection of frames of a single multi-frame Instance, to be rendered.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| instance required | string <Unique Identifier (UI)> The SOP Instance UID of an Instance contained within a Series resource. |
| frames required | Array of integers <int32> [ items <int32 > ] A comma-separated list of frame numbers, in ascending order, contained within an Instance. |
| annotation | stringpatient|technique This parameter specifies that the rendered images or video will have annotations. See PS3.18 8.3.2.1.1 |
| quality | integer [ 1 .. 100 ] The "quality" parameter specifies the requested quality of the rendered images or video. The "quality" parameter is only supported for media types that allow lossy compression. See PS3.13 8.3.5.1.2 |
| viewport | string^\d+,\d+(,\d*,\d*,\d*,\d*)?$ Specifies a rectangular region of the source image(s) or video to be cropped, and a rectangular region corresponding to the size of the user agent's viewport to which the cropped image or video should be scaled. See PS3.18 8.3.2.1.3 |
| window | string^\d+,\d+,(linear|linear-exact|sigmoid)$ Controls the windowing of the images or video. See PS 8.13 8.3.5.1.4 |
| iccprofile | string^(no|yes|srgb|adobergb|rommrgb)$ Specifies the color characteristics of, and inclusion of an ICC Profile in, the rendered images. See PS3.18 8.3.5.1.5 |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
The Study Thumbnail resource references a thumbnail image of a Study.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| viewport | string^\d+,\d+(,\d*,\d*,\d*,\d*)?$ Specifies a rectangular region of the source image(s) or video to be cropped, and a rectangular region corresponding to the size of the user agent's viewport to which the cropped image or video should be scaled. See PS3.18 8.3.2.1.3 |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
The Series Thumbnail resource references a thumbnail image of a Series.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| viewport | string^\d+,\d+(,\d*,\d*,\d*,\d*)?$ Specifies a rectangular region of the source image(s) or video to be cropped, and a rectangular region corresponding to the size of the user agent's viewport to which the cropped image or video should be scaled. See PS3.18 8.3.2.1.3 |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
The Instance Thumbnail resource references a thumbnail image of an Instance.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| instance required | string <Unique Identifier (UI)> The SOP Instance UID of an Instance contained within a Series resource. |
| viewport | string^\d+,\d+(,\d*,\d*,\d*,\d*)?$ Specifies a rectangular region of the source image(s) or video to be cropped, and a rectangular region corresponding to the size of the user agent's viewport to which the cropped image or video should be scaled. See PS3.18 8.3.2.1.3 |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
The Frame Thumbnail resource references a thumbnail image for frames within an Instance.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| instance required | string <Unique Identifier (UI)> The SOP Instance UID of an Instance contained within a Series resource. |
| frames required | Array of integers <int32> [ items <int32 > ] A comma-separated list of frame numbers, in ascending order, contained within an Instance. |
| viewport | string^\d+,\d+(,\d*,\d*,\d*,\d*)?$ Specifies a rectangular region of the source image(s) or video to be cropped, and a rectangular region corresponding to the size of the user agent's viewport to which the cropped image or video should be scaled. See PS3.18 8.3.2.1.3 |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
The Instance Bulkdata resource references the Bulkdata of a Instance.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| instance required | string <Unique Identifier (UI)> The SOP Instance UID of an Instance contained within a Series resource. |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
The Instance Pixel Data resource references the Pixel Data of a Instance.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| instance required | string <Unique Identifier (UI)> The SOP Instance UID of an Instance contained within a Series resource. |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
The Frames resource references an ordered collection of frames in a single multi-frame Instance.
| study required | string <Unique Identifier (UI)> The Study Instance UID of a Study managed by the Studies Service. |
| series required | string <Unique Identifier (UI)> The Series Instance UID of a Series contained within a Study resource. |
| instance required | string <Unique Identifier (UI)> The SOP Instance UID of an Instance contained within a Series resource. |
| frames required | Array of integers <int32> [ items <int32 > ] A comma-separated list of frame numbers, in ascending order, contained within an Instance. |
| accept | string <media-type> The Accept Query Parameter has the same syntax as the Accept header field, except that it shall not have wildcards ( |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
Create Unified Procedure Worklist.
| AffectedSOPInstanceUID | string <Unique Identifier (UI)> the SOP Instance UID of a Workitem. |
| 00001000 | string <Unique Identifier (UI)> the SOP Instance UID of a Workitem. |
| SOPInstanceUID | string <Unique Identifier (UI)> the SOP Instance UID of a Workitem. |
| 00080018 | string <Unique Identifier (UI)> the SOP Instance UID of a Workitem. |
| Content-Type | string <media-type> The DICOM Media Type of the request payload. |
| Content-Length | integer <int64> >= 0 Shall be present if a content encoding has not been applied to the payload |
| Content-Encoding | string <encoding> Shall be present if a content encoding has been applied to the payload |
Searches the entire service for Worklist that match the search parameters, and returns a list of matching Worklists, including the default and requested Attributes that are supported for each UPS.
object One or more DICOM Attribute/Values pairs specify the matching criteria for the search. See PS3.18 8.3.4.1 | |
| fuzzymatching | boolean Default: false A single parameter specifies whether Fuzzy Matching of Person Names is to be performed. See PS3.18 8.3.4.2 |
| includefield | string <^(all|\w(,\w)+)$> A parameter specifies the Attributes that should be included in the response. See PS3.18 8.3.4.3 |
| limit | integer <int64> >= 0 A single parameter specifies the maximum number of matches the origin server shall return in a single response. See PS3.18 8.3.4.4 |
| offset | integer <int64> >= 0 Default: 0 A single parameter specifies the number of matches the origin server shall skip before the first returned match. See PS3.18 8.3.4.4 |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
Update Unified Procedure Worklist.
| workitem required | string <Unique Identifier (UI)> the SOP Instance UID of a Workitem. |
| TransactionUID | string <Unique Identifier (UI)> the Transaction UID of a Workitem. |
| 00081195 | string <Unique Identifier (UI)> the Transaction UID of a Workitem. |
| Content-Type | string <media-type> The DICOM Media Type of the request payload. |
| Content-Length | integer <int64> >= 0 Shall be present if a content encoding has not been applied to the payload |
| Content-Encoding | string <encoding> Shall be present if a content encoding has been applied to the payload |
Search for worklist with specified UID.
| workitem required | string <Unique Identifier (UI)> the SOP Instance UID of a Workitem. |
| Accept | string <media-type> The Acceptable Media Types for the response payload. See PS3.18 8.4.1.1 |
| Accept-Charset | string <charset> The Acceptable Character Sets of the response payload. See PS3.18 8.8 |
Changing Unified Procedure Worklist State.
| workitem required | string <Unique Identifier (UI)> the SOP Instance UID of a Workitem. |
| Content-Type | string <media-type> The DICOM Media Type of the request payload. |
| Content-Length | integer <int64> >= 0 Shall be present if a content encoding has not been applied to the payload |
| Content-Encoding | string <encoding> Shall be present if a content encoding has been applied to the payload |