Skip to content

Commit f3ace80

Browse files
prmerger-automator[bot]prmerger-automator[bot]
authored
Merge pull request #285241 from gunjitchhhatwal/main
Added details of wildcard support in UPS-RS (search workitems)
2 parents ec86153 + 4be9628 commit f3ace80

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

‎articles/healthcare-apis/dicom/dicom-services-conformance-statement-v2.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The Medical Imaging Server for DICOM® supports a subset of the DICOMweb Stan
3030
* [Request Cancellation](#request-cancellation)
3131
* [Search Workitems](#search-workitems)
3232

33-
Additionally, these nonstandard API(s) are supported:
33+
Additionally, these nonstandard APIs are supported:
3434

3535
* [Change Feed](change-feed-overview.md)
3636
* [Extended Query Tags](dicom-extended-query-tags-overview.md)
@@ -69,11 +69,11 @@ This transaction uses the POST or PUT method to store representations of studies
6969

7070
Parameter `study` corresponds to the DICOM attribute StudyInstanceUID. If specified, any instance that doesn't belong to the provided study is rejected with a `43265` warning code.
7171

72-
The following `Accept` header(s) for the response are supported:
72+
The following is the only response `Accept` header supported:
7373

7474
* `application/dicom+json`
7575

76-
The following `Content-Type` header(s) are supported:
76+
The following `Content-Type` headers are supported:
7777

7878
* `multipart/related; type="application/dicom"`
7979
* `application/dicom`
@@ -309,7 +309,7 @@ This Retrieve Transaction offers support for retrieving stored studies, series,
309309

310310
#### Retrieve instances within study or series
311311

312-
The following `Accept` header(s) are supported for retrieving instances within a study or a series:
312+
The following `Accept` headers are supported for retrieving instances within a study or a series:
313313

314314

315315
* `multipart/related; type="application/dicom"; transfer-syntax=*`
@@ -320,7 +320,7 @@ The following `Accept` header(s) are supported for retrieving instances within a
320320

321321
#### Retrieve an Instance
322322

323-
The following `Accept` header(s) are supported for retrieving a specific instance:
323+
The following `Accept` headers are supported for retrieving a specific instance:
324324

325325
* `application/dicom; transfer-syntax=*`
326326
* `multipart/related; type="application/dicom"; transfer-syntax=*`
@@ -387,7 +387,7 @@ Cache validation is supported using the `ETag` mechanism. In the response to a m
387387

388388
### Retrieve rendered image (for instance or frame)
389389

390-
The following `Accept` header(s) are supported for retrieving a rendered image an instance or a frame:
390+
The following `Accept` headers are supported for retrieving a rendered image an instance or a frame:
391391

392392
- `image/jpeg`
393393
- `image/png`
@@ -440,7 +440,7 @@ Query based on ID for DICOM Objects (QIDO) enables you to search for studies, se
440440
| GET | ../studies/{study}/instances?... | Search for instances in a study |
441441
| GET | ../studies/{study}/series/{series}/instances?... | Search for instances in a series |
442442

443-
The following `Accept` header(s) are supported for searching:
443+
The following is the only `Accept` header supported for searching:
444444

445445
* `application/dicom+json`
446446

@@ -456,7 +456,7 @@ An attribute can be corrected in the following ways:
456456

457457
The following parameters for each query are supported:
458458

459-
| Key | Support Value(s) | Allowed Count | Description |
459+
| Key | Support values | Allowed Count | Description |
460460
| :--------------- | :------------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
461461
| `{attributeID}=` | `{value}` | 0...N | Search for attribute/ value matching in query. |
462462
| `includefield=` | `{attributeID}`<br/>`all` | 0...N | The other attributes to return in the response. Both, public and private tags are supported.<br/>When `all` is provided, refer to [Search Response](#search-response) for more information.<br/>If a mixture of `{attributeID}` and `all` is provided, the server defaults to using `all`. |
@@ -751,7 +751,7 @@ The request payload might include Action Information as [defined in the DICOM St
751751

752752
| Code | Description |
753753
| :----------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
754-
| `202 (Accepted)` | The request was accepted by the server, but the Target Workitem state isn't changed yet. |
754+
| `202 (Accepted)` | Server has accepted the request, but the Target Workitem state isn't changed yet. |
755755
| `400 (Bad Request)` | There was a problem with the syntax of the request. |
756756
| `401 (Unauthorized)` | The client isn't authenticated. |
757757
| `403 (Forbidden)` | The user isn't authorized. |
@@ -892,15 +892,15 @@ This transaction enables you to search for Workitems by attributes.
892892
| :----- | :------------ | :------------------- |
893893
| GET | ../workitems? | Search for Workitems |
894894

895-
The following `Accept` header(s) are supported for searching:
895+
The following is the only `Accept` header supported for searching:
896896

897897
* `application/dicom+json`
898898

899899
#### Supported Search Parameters
900900

901901
The following parameters for each query are supported:
902902

903-
| Key | Support Value(s) | Allowed Count | Description |
903+
| Key | Support values | Allowed Count | Description |
904904
| :--------------- | :------------------------ | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
905905
| `{attributeID}=` | `{value}` | 0...N | Search for attribute/ value matching in query. |
906906
| `includefield=` | `{attributeID}`<br/>`all` | 0...N | The other attributes to return in the response. Only top-level attributes can be included - not attributes that are part of sequences. Both public and private tags are supported. When `all` is provided, see [Search Response](#search-response) for more information about which attributes are returned for each query type. If a mixture of `{attributeID}` and `all` is provided, the server defaults to using 'all'. |
@@ -937,6 +937,7 @@ We support these matching types:
937937
| Range Query | `Scheduled​Procedure​Step​Start​Date​Time` | `{attributeID}={value1}-{value2}`. For date/time values, we support an inclusive range on the tag. This range is mapped to `attributeID >= {value1} AND attributeID <= {value2}`. If `{value1}` isn't specified, all occurrences of dates/times prior to and including `{value2}` is matched. Likewise, if `{value2}` isn't specified, all occurrences of `{value1}` and subsequent dates/times are matched. However, one of these values must be present. `{attributeID}={value1}-` and `{attributeID}=-{value2}` are valid, however, `{attributeID}=-` isn't valid. |
938938
| Exact Match | All supported attributes | `{attributeID}={value1}` |
939939
| Fuzzy Match | `PatientName` | Matches any component of the name that starts with the value. |
940+
| WildCard Match | `PatientID`, <br/> `ReferencedRequestSequence.AccessionNumber`, <br/> `ReferencedRequestSequence.RequestedProcedureID`, <br/> `ProcedureStepState`, <br/> `ScheduledStationNameCodeSequence.CodeValue`, <br/> `ScheduledStationClassCodeSequence.CodeValue`, <br/> `ScheduledStationGeographicLocationCodeSequence.CodeValue` | Following wildcard characters are supported: <br/> `*` - Matches zero or more characters. For example - `{attributeID}={val*}` matches "val", "valid", "value" but not "evaluate". <br/> `?` - Matches a single character. For example - `{attributeID}={valu?}` matches "value", "valu1" but not "valued" or "valu" |
940941

941942
> [!NOTE]
942943
> Although we don't support full sequence matching, we do support exact match on the attributes listed that are contained in a sequence.
@@ -987,4 +988,4 @@ The query API doesn't return `413 (request entity too large)`. If the requested
987988
* Matching is case insensitive and accent sensitive for other string VR types.
988989
* If there's a scenario where canceling a Workitem and querying the same happens at the same time, then the query most likely excludes the Workitem that's getting updated and the response code is `206 (Partial Content)`.
989990

990-
[!INCLUDE [DICOM trademark statement](../includes/healthcare-apis-dicom-trademark.md)]
991+
[!INCLUDE [DICOM trademark statement](../includes/healthcare-apis-dicom-trademark.md)]

0 commit comments

Comments
 (0)