Skip to content

Commit da108a1

Browse files
EXPEkeshethEXPEkesheth
authored
Revise SOPInstanceUid update request structure
Updated the request structure for SOPInstanceUid and added new attributes for changeDataset.
1 parent b5bdb58 commit da108a1

1 file changed

Lines changed: 63 additions & 10 deletions

File tree

‎articles/healthcare-apis/dicom/update-files.md‎

Lines changed: 63 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -103,17 +103,27 @@ For updating the UIDs, new UIDs have to be provided in the change dataset as fol
103103
```
104104
3. Use the request below to update the 'SOPInstanceUid' for a specific instance within a series. Note that a single instance is updated at a time, and both the 'studyInstanceUid' and 'seriesInstanceUid' must be provided along with the current 'sopInstanceUid' and the new value in the changeDataset.
105105

106+
```
106107
{
107-
"studyInstanceUid": "1.2.3.4",
108+
"studyInstanceUids": ["1.2.3.4"],
108109
"seriesInstanceUid": "5.6.7.8",
109-
"sopInstanceUid": "9.10.11.12",
110-
"changeDataset": {
111-
"00080018": {
112-
"vr": "UI",
113-
"Value": ["9.10.11.13"]
114-
}
110+
"sopInstanceUid": "9.10.11.12",
111+
"changeDataset": {
112+
"0020000D": {
113+
"vr": "UI",
114+
"Value": ["1.2.3.5"]
115+
},
116+
"0020000E": {
117+
"vr": "UI",
118+
"Value": ["5.6.7.9"]
119+
},
120+
"00080018": {
121+
"vr": "UI",
122+
"Value": ["9.10.11.13"]
123+
}
115124
}
116125
}
126+
```
117127

118128
#### Responses
119129
When a bulk update operation starts successfully, the API returns a `202` status code. The body of the response contains a reference to the operation.
@@ -217,13 +227,12 @@ The [change feed](change-feed-overview.md) records update actions in the same ma
217227

218228
## Summary of DICOM UID Update Behavior by Hierarchy Level
219229
This table outlines how bulk updates behave at different levels of the DICOM hierarchy—Study, Series, and Instance—highlighting when updates are allowed, whether a SOP Instance UID filter is required, how instances are moved, and the resulting impact on the UID hierarchy.
220-
✅ Allowed
221-
❌ Not allowed
230+
✅ Allowed ❌ Not allowed
222231
| Scenario | Study-Level Update | Series-Level Update | Instance-Level Update | SOP Instance UID Filter Applied | Movement of Instances | Resulting Action / Notes |
223232
| -------------------------------------------------- | ----------------- | ----------------- | ------------------- | ------------------------------ | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
224233
| Update patient demographic attributes only | ✅ | ✅ | ✅ |Not required | No movement | Attributes updated in place; original UID hierarchy preserved. |
225234
| Update Study Instance UID | ✅ | ❌ | ❌ | ❌ | Study → New Study | All instances in study get new Study UID; series and instance UIDs remain unless explicitly changed. |
226-
| Update Series Instance UID | ✅ | ✅ | ❌ | Not required | Series → New Series | All instances in series get new Series UID; Study UID remains unless updated; SOP Instance UID unchanged. |
235+
| Update Series Instance UID | ❌ | ✅ | ❌ | Not required | Series → New Series | All instances in series get new Series UID; Study UID remains unless updated; SOP Instance UID unchanged. |
227236
| Update SOP Instance UID | ❌ | ❌ | ✅ | Required | Instance → New Instance | Only the filtered SOP Instance(s) are updated; new SOP Instance UID assigned; Study/Series UID preserved. |
228237
| Update Study & Series UIDs | ✅ | ✅ | ❌ | Not required | Study → New Study → Series → New Series | Hierarchy updated; all instances in series adopt new UIDs. |
229238
| Update Study, Series, and SOP Instance UIDs | ✅ | ✅ | ✅ | Required | Study → New Study → Series → New Series → Instance → New Instance | Complete hierarchy updated with filtered SOP instance selection where applicable. |
@@ -294,4 +303,48 @@ The UID `1.3.6.1.4.1.311.129` is a registered under [Microsoft OID arc](https://
294303
| Accession Number | (0008,0050) | A RIS generated number that identifies the order for the Study |
295304
| Study Description | (0008,1030) | Institution-generated description or classification of the Study (component) performed |
296305

306+
307+
## Study module attributes
308+
309+
| Attribute Name | Tag | Description |
310+
|--------------------------------|------------|-----------------------------------------------------------------------------|
311+
| Accession Number | (0008,0050)| A RIS-generated number that identifies the order for the study |
312+
| Referring Physician's Name | (0008,0090)| Name of the patient's referring physician |
313+
| Study Description | (0008,1030)| Institution-generated description or classification of the study performed |
314+
| Study Date | (0008,0020)| Date the study started |
315+
| Study Time | (0008,0030)| Time the study started |
316+
| Study ID | (0020,0010)| User or equipment generated study identifier |
317+
| Admitting Diagnoses Description| (0008,1080)| Description of the admitting diagnosis |
318+
| Requested Procedure ID | (0040,1001)| Identifier that identifies the requested procedure in the Imaging Service Request |
319+
320+
## Series module attributes
321+
322+
| Attribute Name | Tag | Description |
323+
|----------------------|------------|-----------------------------------------------------------------------------|
324+
| Series Description | (0008,103E)| Description of the series |
325+
| Frame of Reference UID | (0020,0052)| Uniquely identifies the frame of reference for a series |
326+
| Series Number | (0020,0011)| A number that identifies the series |
327+
| Series Date | (0008,0021)| Date the series started |
328+
| Series Time | (0008,0031)| Time the series started |
329+
| Body Part Examined | (0018,0015)| Text description of the part of the body examined |
330+
| Laterality | (0020,0060)| Laterality of (paired) body part examined; Enumerated Values: R (right), L (left) |
331+
332+
## Instance module attributes
333+
334+
| Attribute Name | Tag | Description |
335+
|---------------------|------------|-----------------------------------------------------------------------------|
336+
| Instance Number | (0020,0013)| A number that identifies the instance |
337+
| Acquisition Date | (0008,0022)| The date the acquisition of data that resulted in this image started |
338+
| Acquisition Time | (0008,0032)| The time the acquisition of data that resulted in this image started |
339+
| Image Laterality | (0020,0062)| Laterality of (possibly paired) body part examined in the image; Enumerated Values: R (right), L (left), U (unpaired), B (both) |
340+
| Measurement Laterality | (0024,0113)| The laterality of the measurement |
341+
342+
## UID attributes
343+
344+
| Attribute Name | Tag | Description |
345+
|--------------------|------------|----------------------------------------------|
346+
| Study Instance UID | (0020,000D)| Unique identifier for the study |
347+
| Series Instance UID| (0020,000E)| Unique identifier for the series |
348+
| SOP Instance UID | (0008,0018)| Uniquely identifies the SOP Instance |
349+
297350
[!INCLUDE [DICOM trademark statements](../includes/healthcare-apis-dicom-trademark.md)]

0 commit comments

Comments
 (0)