Skip to content

Commit 130db68

Browse files
Coco-BenCoco-Ben
authored
[doc] Copyedit doc changes since previous copyedit pass (#101)
Previous copyedit commit id: 1295afb
1 parent a065d0e commit 130db68

File tree

4 files changed

+64
-47
lines changed

4 files changed

+64
-47
lines changed

‎docs/api/rest/dicomweb-stow.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,28 @@ SPDX-License-Identifier: Apache License 2.0
55

66
# DICOMWeb STOW-RS APIs
77

8-
The `dicomweb/` endpoint implements the specifications defined in section [6.6 STOW-RS Request/Response](https://dicom.nema.org/dicom/2013/output/chtml/part18/sect_6.6.html#sect_6.6.1.3.2.1.1) defined by the DICOM committee to provide the [DICOMWeb STOW-RS](https://www.dicomstandard.org/using/dicomweb/store-stow-rs) interface to enable the triggering of new workflows.
8+
The `dicomweb/` endpoint implements the specifications defined in [section 6.6 STOW-RS Request/Response](https://dicom.nema.org/dicom/2013/output/chtml/part18/sect_6.6.html#sect_6.6.1.3.2.1.1)
9+
defined by the DICOM committee to provide the [DICOMWeb STOW-RS](https://www.dicomstandard.org/using/dicomweb/store-stow-rs)
10+
interface for triggering new workflows.
911

1012

11-
The *STOW-RS* service provides the following two endpoints:
13+
The *STOW-RS* service provides the following two endpoints.
1214

1315
## POST /dicomweb/studies/[{study-instance-uid}]
1416

1517
Triggers a new workflow request with the uploaded DICOM dataset.
1618

1719
> [!IMPORTANT]
18-
> Each HTTP POST request triggers a new workflow request; the service *does not* support waiting for additional instances like the DIMSE service.
20+
> Each HTTP POST request triggers a new workflow request; the service *does not* support waiting
21+
for additional instances like the DIMSE service.
1922

2023
### Parameters
2124

2225
#### Query Parameters:
2326

2427
| Name | Type | Description |
2528
| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26-
| study-instance-uid | string | Optionally associate the DICOM dataset with a StudyInstanceUID. Note: the service records any mismatch in the StudyInstanceUID header to the provided value in the response with `Warning Reason (0008,1196)` = `B007`. |
29+
| study-instance-uid | string | (Optional) Associate the DICOM dataset with a StudyInstanceUID. Note that the service records any mismatch between the StudyInstanceUID header and the provided value in the response as `Warning Reason (0008,1196)` = `B007`. |
2730

2831
#### Request Body:
2932

@@ -36,14 +39,14 @@ Supported Content-Types:
3639

3740
Response Content Type: `JSON`
3841

39-
| Code | Data Type | Description |
40-
| ---- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
41-
| 200 | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored succesfully. |
42-
| 202 | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | ALl instances are received and stored with warnings. E.g. mismatch StudyInstanceUID. |
43-
| 204 | `none` | No data provided. |
44-
| 400 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Request contains invalid values. |
45-
| 415 | `none` | Unsupported media type. |
46-
| 500 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Server error. |
42+
| Code | Data Type | Description |
43+
| ---- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
44+
| 200 | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored succesfully. |
45+
| 202 | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored with warnings (e.g. for a mismatched StudyInstanceUID. |
46+
| 204 | `none` | No data is provided. |
47+
| 400 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Request contains invalid values. |
48+
| 415 | `none` | Unsupported media type |
49+
| 500 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Server error |
4750

4851
---
4952

@@ -62,7 +65,7 @@ Triggers the specified workflow with the uploaded DICOM dataset.
6265
| Name | Type | Description |
6366
| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
6467
| workflow-id | string | The unique identifier of the workflow registered with the Workflow Manager. |
65-
| study-instance-uid | string | Optionally associate the DICOM dataset with a StudyInstanceUID. Note: the service records any mismatch in the StudyInstanceUID header to the provided value in the response with `Warning Reason (0008,1196)` = `B007`. |
68+
| study-instance-uid | string | (Optional) Associate the DICOM dataset with a StudyInstanceUID. Note that the service records any mismatch between the StudyInstanceUID header and the provided value in the response as `Warning Reason (0008,1196)` = `B007`. |
6669

6770
#### Request Body:
6871

@@ -75,11 +78,11 @@ Supported Content-Types:
7578

7679
Response Content Type: `JSON`
7780

78-
| Code | Data Type | Description |
79-
| ---- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
80-
| 200 | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored succesfully. |
81-
| 202 | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | ALl instances are received and stored with warnings. E.g. mismatch StudyInstanceUID. |
82-
| 204 | `none` | No data provided. |
83-
| 400 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Request contains invalid values. |
84-
| 415 | `none` | Unsupported media type. |
85-
| 500 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Server error. |
81+
| Code | Data Type | Description |
82+
| ---- | --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
83+
| 200 | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored succesfully. |
84+
| 202 | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored with warnings (e.g. for a mismatched StudyInstanceUID. |
85+
| 204 | `none` | No data is provided. |
86+
| 400 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Request contains invalid values. |
87+
| 415 | `none` | Unsupported media type |
88+
| 500 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Server error |

‎docs/index.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,19 @@ The *DICOM SCU Service* enables users to export application-generated DICOM resu
4444
4545
### DICOMWeb STOW-RS
4646

47-
The *DICOMWeb STOW-RS* allows users to trigger a new workflow request by uploading a DICOM dataset. It provides options to trigger a workflow with or without specifying a workflow ID/name. See [DICOMWeb STOW-RS](./api/rest/dicomweb-stow.md) section for more information.
47+
The *DICOMWeb STOW-RS Service* allows users to trigger a new workflow request by uploading a DICOM dataset.
48+
It provides options to trigger a workflow with or without specifying a workflow ID/name. See the
49+
[DICOMWeb STOW-RS](./api/rest/dicomweb-stow.md) section for more information.
4850

4951
### ACR DSI API
5052

51-
The ACR DSI API allows users to trigger inference requests via RESTful calls, utilizing DICOMweb & FHIR to retrieve data specified in the request. Upon data retrieval, the Informatics Gateway uploads the data to the shared storage and generates an `md.workflow.request` event, which notifies the [MONAI Deploy Workflow Manager](https://github.com/Project-MONAI/monai-deploy-workflow-manager) for processing.
53+
The ACR DSI API allows users to trigger inference requests via RESTful calls, utilizing DICOMweb and FHIR to
54+
retrieve data specified in the request. Upon data retrieval, the Informatics Gateway uploads the data to the
55+
shared storage and generates an `md.workflow.request` event, which notifies the
56+
[MONAI Deploy Workflow Manager](https://github.com/Project-MONAI/monai-deploy-workflow-manager) for processing.
5257

5358
#### DICOMweb Export
5459

55-
A DICOMweb export agent can export any user-generated DICOM content to configured DICOM destinations. The agent subscribes to the `md.export.request.monaidicomweb` events generated by the [MONAI Deploy Workflow Manager](https://github.com/Project-MONAI/monai-deploy-workflow-manager) and then exports the data to user-configured DICOMweb destination(s).
60+
A DICOMweb export agent can export any user-generated DICOM content to configured DICOM destinations. The agent
61+
subscribes to the `md.export.request.monaidicomweb` events generated by the [MONAI Deploy Workflow Manager](https://github.com/Project-MONAI/monai-deploy-workflow-manager)
62+
and then exports the data to user-configured DICOMweb destination(s).

‎docs/setup/cli.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ SPDX-License-Identifier: Apache License 2.0
66

77
# Command-line Interface (CLI)
88

9-
The command-line interface (CLI) for Informatics Gateway allows users to configure settings and control the Informatics Gateway.
9+
The command-line interface (CLI) allows users to configure settings and
10+
control the Informatics Gateway.
1011

1112
## Available Commands
1213

13-
To see all available commands:
14+
Use the `mig-cli` command to see all available commands:
1415

1516
```bash
1617
> mig-cli
@@ -39,9 +40,9 @@ Commands:
3940

4041
## Help & Logging
4142

42-
The verbose switch `-v` and the help switch `-h` are available for all commands.
43+
The verbose switch `-v` and help switch `-h` are available for all commands.
4344

44-
For example:
45+
The following command gets help for the `aet add` command:
4546

4647
```bash
4748
> mig-cli aet add -h
@@ -66,7 +67,7 @@ Options:
6667

6768
## Controlling Informatics Gateway
6869

69-
Use the following commands to start, stop or restart the Informatics Gateway:
70+
Use the following commands to start, stop, or restart the Informatics Gateway:
7071

7172
```bash
7273
mig-cli start
@@ -76,7 +77,8 @@ mig-cli restart
7677

7778
## System Health
7879

79-
`mig-cli status` displays status of all running services inside the Informatics Gateway & number of active associations.
80+
The `mig-cli status` command displays the status of all running services inside the Informatics
81+
Gateway, as well as the number of active associations.
8082

8183
```bash
8284
> mig-cli status
@@ -93,7 +95,9 @@ info: payload Notification Service: Running
9395

9496
## Configure AE Titles
9597

96-
The CLI provides three commands to configure the listening AE Titles, sources and destinations. Each command allows you to add (`add`), delete (`rm`) and list (`list`) configured AE Titles. Use the `-h` switch for additional options.
98+
The CLI provides commands to configure the listening, source, and destination AE Titles. Each
99+
command allows you to add (`add`), delete (`rm`), and list (`list`) configured AE Titles. Use the
100+
`-h` switch for additional options.
97101

98102
### Listening AE Titles
99103

@@ -157,4 +161,4 @@ Commands:
157161
add Add a new DICOM destination
158162
del, rm Remove a DICOM destination
159163
list, ls List all DICOM destinations
160-
```
164+
```

0 commit comments

Comments
 (0)