Skip to documentation
ReferencePatient

Patient

Images and studies

Attach a named visual result and its interpretation.

Format definition

Package portable media with acquisition context and separate interpretations.

Portable format · Suite implementation support

Parameters

assets[].id

ID

Required

Stable asset reference used by results and outputs.

assets[].path

relative POSIX path

Required

Path under assets/ within the package. Reject absolute paths, .. segments, symlinks, duplicate paths, and external fetches.

assets[].mediaType

MIME string

Required

Declared content type must match decoded asset type; unsupported active content is rejected.

assets[].sha256

64 lowercase hexadecimal characters

Required

Digest verified against bytes before use; integrity does not prove safety or authorship.

assets[].description

string

Required

Accessible description of the learner-visible content without hidden diagnostic explanation.

assets[].license

string

Required

Reuse terms for this asset, with attribution in a separate field.

assets[].attribution

string

Required

Creator and source credit.

assets[].transcriptAssetId

Asset ID

Required for spoken audio/video

Packaged accessible transcript; role filtering matches the original media.

resources[].diagnostic.acquisition

{ bodyRegion?: string, view?: string, technique?: string }

Optional; omitted means unspecified

Study-specific context independent of report interpretation.

Behavior and validation

  • Package media locally for offline playback; external links can be citations but are not runtime asset dependencies. A package must fail validation when a required asset is missing or its hash is wrong.
  • Results reference asset IDs and separate learner/facilitator interpretations. File names, alt text, and transcripts must be reviewed for unintended answer disclosure.

Shared format conventions · All format elements · Download specification