Amazon HealthImaging · JSON Structure

Healthimaging Image Set Properties Structure

The image set properties.

Type: object Properties: 8 Required: 3
HealthcareHIPAAMachine LearningMedical ImagingDICOM

ImageSetProperties is a JSON Structure definition published by Amazon HealthImaging, describing 8 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

imageSetId versionId imageSetState ImageSetWorkflowStatus createdAt updatedAt deletedAt message

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-healthimaging/refs/heads/main/json-schema/healthimaging-image-set-properties-schema.json",
  "name": "ImageSetProperties",
  "type": "object",
  "required": [
    "imageSetId",
    "versionId",
    "imageSetState"
  ],
  "properties": {
    "imageSetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImageSetId"
        },
        {
          "description": "The image set identifier."
        }
      ]
    },
    "versionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImageSetExternalVersionId"
        },
        {
          "description": "The image set version identifier."
        }
      ]
    },
    "imageSetState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImageSetState"
        },
        {
          "description": "The image set state."
        }
      ]
    },
    "ImageSetWorkflowStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImageSetWorkflowStatus"
        },
        {
          "description": "The image set workflow status."
        }
      ]
    },
    "createdAt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Date"
        },
        {
          "description": "The timestamp when the image set properties were created."
        }
      ]
    },
    "updatedAt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Date"
        },
        {
          "description": "The timestamp when the image set properties were updated."
        }
      ]
    },
    "deletedAt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Date"
        },
        {
          "description": "The timestamp when the image set properties were deleted."
        }
      ]
    },
    "message": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Message"
        },
        {
          "description": "The error message thrown if an image set action fails."
        }
      ]
    }
  },
  "description": "The image set properties."
}