Skip to content

[doc] Copyedit doc changes since previous copyedit pass #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 14, 2022
Merged

[doc] Copyedit doc changes since previous copyedit pass #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 24 additions & 21 deletions docs/api/rest/dicomweb-stow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,28 @@ SPDX-License-Identifier: Apache License 2.0

# DICOMWeb STOW-RS APIs

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.
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 for triggering new workflows.


The *STOW-RS* service provides the following two endpoints:
The *STOW-RS* service provides the following two endpoints.

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

Triggers a new workflow request with the uploaded DICOM dataset.

> [!IMPORTANT]
> Each HTTP POST request triggers a new workflow request; the service *does not* support waiting for additional instances like the DIMSE service.
> Each HTTP POST request triggers a new workflow request; the service *does not* support waiting
for additional instances like the DIMSE service.

### Parameters

#### Query Parameters:

| Name | Type | Description |
| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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`. |
| 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`. |

#### Request Body:

Expand All @@ -36,14 +39,14 @@ Supported Content-Types:

Response Content Type: `JSON`

| Code | Data Type | Description |
| ---- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| 200 | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored succesfully. |
| 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. |
| 204 | `none` | No data provided. |
| 400 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Request contains invalid values. |
| 415 | `none` | Unsupported media type. |
| 500 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Server error. |
| Code | Data Type | Description |
| ---- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| 200 | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored succesfully. |
| 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. |
| 204 | `none` | No data is provided. |
| 400 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Request contains invalid values. |
| 415 | `none` | Unsupported media type |
| 500 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Server error |

---

Expand All @@ -62,7 +65,7 @@ Triggers the specified workflow with the uploaded DICOM dataset.
| Name | Type | Description |
| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| workflow-id | string | The unique identifier of the workflow registered with the Workflow Manager. |
| 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`. |
| 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`. |

#### Request Body:

Expand All @@ -75,11 +78,11 @@ Supported Content-Types:

Response Content Type: `JSON`

| Code | Data Type | Description |
| ---- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| 200 | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored succesfully. |
| 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. |
| 204 | `none` | No data provided. |
| 400 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Request contains invalid values. |
| 415 | `none` | Unsupported media type. |
| 500 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Server error. |
| Code | Data Type | Description |
| ---- | --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| 200 | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored succesfully. |
| 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. |
| 204 | `none` | No data is provided. |
| 400 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Request contains invalid values. |
| 415 | `none` | Unsupported media type |
| 500 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Server error |
13 changes: 10 additions & 3 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,19 @@ The *DICOM SCU Service* enables users to export application-generated DICOM resu

### DICOMWeb STOW-RS

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.
The *DICOMWeb STOW-RS Service* 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 the
[DICOMWeb STOW-RS](./api/rest/dicomweb-stow.md) section for more information.

### ACR DSI API

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.
The ACR DSI API allows users to trigger inference requests via RESTful calls, utilizing DICOMweb and 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.

#### DICOMweb Export

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).
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).
20 changes: 12 additions & 8 deletions docs/setup/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ SPDX-License-Identifier: Apache License 2.0

# Command-line Interface (CLI)

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

## Available Commands

To see all available commands:
Use the `mig-cli` command to see all available commands:

```bash
> mig-cli
Expand Down Expand Up @@ -39,9 +40,9 @@ Commands:

## Help & Logging

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

For example:
The following command gets help for the `aet add` command:

```bash
> mig-cli aet add -h
Expand All @@ -66,7 +67,7 @@ Options:

## Controlling Informatics Gateway

Use the following commands to start, stop or restart the Informatics Gateway:
Use the following commands to start, stop, or restart the Informatics Gateway:

```bash
mig-cli start
Expand All @@ -76,7 +77,8 @@ mig-cli restart

## System Health

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

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

## Configure AE Titles

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.
The CLI provides commands to configure the listening, source, and destination AE Titles. Each
command allows you to add (`add`), delete (`rm`), and list (`list`) configured AE Titles. Use the
`-h` switch for additional options.

### Listening AE Titles

Expand Down Expand Up @@ -157,4 +161,4 @@ Commands:
add Add a new DICOM destination
del, rm Remove a DICOM destination
list, ls List all DICOM destinations
```
```
Loading