Searching for DICOM instances in HealthImaging - AWS HealthImaging

Searching for DICOM instances in HealthImaging

Use the SearchDICOMInstances API to search for DICOM instances in a HealthImaging data store. You can search for DICOM instances in HealthImaging by constructing a URL that includes supported DICOM data elements (attributes). The Instance results are returned in JSON format, ordered by ascending (oldest to latest).

To search for DICOM instances

  1. Collect HealthImaging region and datastoreId values. For more information, see Getting data store properties.

  2. Collect values for StudyInstanceUID and SeriesInstanceUID. For more information, see Getting image set metadata.

  3. Construct a URL for the request, including all applicable search elements. To view the entire URL path in the following example, scroll over the Copy button. The URL is of the form:

    GET https://dicom-medical-imaging.region.amazonaws.com/datastore/datastoreId/studies/StudyInstanceUID/series/SeriesInstanceUID/instances[?query]
    Instance elements for SearchDICOMInstances
    DICOM element tag DICOM element name
    (0008,0016) SOP Class UID
    (0008,0018) SOP Instance UID
    (0008,1196) WarningReason

    HealthImaging uses the DICOM element (0008,1196) to persist import warning codes. The import warning codes are searchable at the instance level. Import warning codes may be searched with wildcard or specific warning codes. See HealthImaging Warning Codes.

  4. Prepare and send your request. SearchDICOMInstances uses a HTTP GET request with AWS Signature Version 4 signing protocol. The following example uses the curl command line tool to search for information about DICOM instances.

    curl
    curl --request GET \
  "https://dicom-medical-imaging.us-east-1.amazonaws.com/datastore/datastoreId/studies/StudyInstanceUID/series/SeriesInstanceUID/instances[?query]"
  --aws-sigv4 'aws:amz:us-east-1:medical-imaging' \
  --user "$AWS_ACCESS_KEY_ID:$AWS_SECRET_ACCESS_KEY" \
  --header "x-amz-security-token:$AWS_SESSION_TOKEN" \
  --header 'Accept: application/dicom+json' \
  --output results.json

    Instance search results are returned in JSON format, ordered by Instance Number (0020,0013) in ascending order (oldest to latest)