• 1. Introduction
  • 1.1 Overview
  • 1.2 Workflow
  • 1.3 CT Image Requirements
• 2. RESTful API
  • 2.1 Bearer Token
  • 2.2 HTTP Request/Response Payload Syntax
  • 2.3 Request Analysis
    • POST /workitems?{AffectedSOPInstanceUID}
      • AffectedSOPInstanceUID requirements
    • Status codes
    • Required Keys
    • Request
    • Response
  • 2.4 Query Status
    • GET /workitems/{AffectedSOPInstanceUID}
    • Status codes
    • Request
    • Response
    • Cancellation
    • Completed
• 3. DICOM Transfer
  • Requirements
• 4. Free Trial Limitations

COVID-19 Detection Service is a SaaS application developed by KEYA MEDICAL LTD, aiming to detect COVID-19 disease based on chest CT images. The service can be integrated with workflow management system or worklist.

1. Send chest CT Images to COVID-19 Server
2. Trigger analysis request to COVID-19 Server
3. Wait for result...(~1 minute)
4. Query status from COVID-19 Server

1. Slice thickness MUST be less than or equal to 3mm
2. Number of Slices MUST be between 50 and 500

All APIs MUST be called with bearer token included in HTTP request headers, for example

POST /workitems?1.3.45.214 HTTP/1.1
Authorization: Bearer {token}

The definition of bearer token CAN be found in RFC 6750

1. Timeout: analysis doesn't finish in 10 minutes
2. No Data: analysis request scheduled but no data received in 2 hours

• API rate limit: 5 times per minute

• Response ETA: 1 minute

• MUST be composed with decimal numbers and dots
• MUST be encoded in UTF-8
• Length MUST be less than 64 characters long

POST /workitems?1.3.45.214 HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}

{
  "00741204": "COVID-19",
  "00404021": {
    "0020000D": "2.16.840.1.113662.2.1.99999.5175439602988854"
  }
}

HTTP/1.1 201 Created
Location: /workitems?1.3.45.214
Content-Type: application/json

• AffectedSOPInstanceUID requirements: see here

• API rate limit: 60 times per minute

• Response ETA: 1 second

GET /workitems/1.3.45.214 HTTP/1.1
Authorization: Bearer {token}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "00404005": {
    "Value": ["2020-03-26 05:21:35.67521964 +0000 UTC m=+8099.205393999"],
    "vr": "DT"
  },
  "00741000": {
    "Value": ["COMPLETED"],
    "vr": "CS"
  },
  "00741216": {
    "Value": [{
      "00400280": {
        "Value": ["Positive"],
        "vr": "ST"
      },
      "00404033": {
        "Value": [{
          "0020000D": {
            "Value": ["2.16.840.1.113662.2.1.1778.250300113532482162"],
            "vr": "UI"
          }
        }],
        "vr": "SQ"
      },
      "00404050": {
        "Value": ["2020-03-26 05:21:40.163982532 +0000 UTC m=+4981.844971167"],
        "vr": "DT"
      },
      "00404051": {
        "Value": ["2020-03-26 05:23:21.28836734 +0000 UTC m=+5082.969355969"],
        "vr": "DT"
      }
    }],
    "vr": "SQ"
  }
}

See here for key explanation

HTTP/1.1 200 OK
Content-Type: application/json

{
  "00741000": {
    "Value": ["CANCELED"],
    "vr": "CS"
  },
  "00741238": {
    "Value": ["Timeout"],
    "vr": "LT"
  }
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "00741000": {
    "Value": ["COMPLETED"],
    "vr": "CS"
  },
  "00741216": {
    "Value": [{
      "00400280": {
        "Value": ["Positive"],
        "vr": "ST"
      }
    }],
    "vr": "SQ"
  }
}

DICOM files SHOULD be sent to COVID-19 Server via DICOM C-STORE or C-MOVE command, for example

foo@bar:~$ dcmsend -v {ip} {port} -aec {target ae} -aet {source ae} +r +sd -nh /path/to/dicom

dcmsend can be found in DCMTK

• DICOM files SHOULD be de-identified before send to COVID-19 Server
• DICOM files MUST be transferred within 2 hours after analysis request triggered, otherwise the request will be canceled
• DICOM files will be cached for 24 hours by COVID-19 Detection Service

• The bearer token will be expired in 14 days
• DICOM communication bandwidth is 100Mbit/s
• AE title/ip/port of both sides MUST be exchanged and configured prior to the trial of this service

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119