Schemas / Clinic

rig.clinic.study

v1.0.0 · stable maturity: draft 5 fields 2 required

Fields

FieldTypeMeaning
subject entity required Person (or other) the images are of
studyUid string required Study Instance UID
seriesUid string optional Optional. Series Instance UID
modality string optional Optional. DICOM modality as written (CT, MR)
asset entity optional Optional. Image or document rig.media.asset_ref

One imaging study or series. Format when present.

Field meanings follow DICOM Study / Series Instance UID. This schema is those identifiers - not a DICOM file, and not the pixels.

subject and studyUid are required.

Another series is another entity with the same studyUid. Pixels stay on the asset file. Do not invent a pixel buffer here.

JSON Schema

Resolves at https://rig.works/schemas/rig.clinic.study.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.clinic.study.schema.json",
  "title": "rig.clinic.study",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "subject": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "studyUid": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "seriesUid": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "modality": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "asset": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    }
  },
  "required": [
    "subject",
    "studyUid"
  ],
  "description": "One imaging study or series. DICOM UIDs. Pixels stay on the asset file.",
  "x-rig-maturity": "draft"
}

Seen in

record-care.json