# Surgical video manifest field dictionary

Operavue | Version 1.0 | October 18, 2026
Reference: https://operavue.com/resources

Use and adapt this original planning template. Attribution is appreciated.
The accompanying CSV contains two invented rows. No media or clinical data is
included. References beginning with "example" do not point to real files,
permissions, or completed reviews. Blank checksums must be replaced for a real
release. This is an example convention, not an industry standard.

One row describes one delivered video file. This example uses separate stereo
files. For packed stereo or files with multiple streams, extend the schema to
record stream identifiers, packing, and the raster of each extracted view.

| Field | Definition and check |
| --- | --- |
| release_id | Version of the delivery. Keep immutable releases traceable. |
| case_id | Project-specific source-procedure identifier shared by all derived files. No patient names or medical record numbers. Pseudonyms alone do not establish de-identification. |
| pair_group_id | Groups corresponding left and right files. For restarts or segments, use a separate group and preserve case_id. |
| split | Assigned train, validation, test, or unassigned partition. Related cases may need grouping beyond case_id. |
| file_path | Relative path within the delivery. Must resolve to the actual delivered file. |
| view | left, right, or mono. Record the convention in the release notes. |
| width_px / height_px | Positive integer dimensions of the delivered view, not a marketing resolution label. |
| fps_nominal | Nominal frames/second. Variable frame-rate content still needs actual per-frame timestamps. |
| duration_s | Decoded duration in seconds. Reconcile against the media, not filenames. |
| time_origin | Relative clock origin. case_relative_zero is an example. Describe resets and offsets. Avoid unnecessary absolute clinical dates. |
| timestamp_unit | Unit of timestamps in accompanying frame metadata. ms means milliseconds. |
| pairing_method | Reference to the synchronization/pairing method. A shared pair_group_id alone does not prove frame synchronization. |
| calibration_ref | Versioned calibration document, or an explicit not-applicable/unknown status. Must describe the delivered geometry. |
| annotation_ref | Versioned label file and annotation guide reference, or explicit none. |
| transform_ref | Record of cropping, resizing, rectification, redaction, and other transformations. |
| rights_review_ref | Pointer to a controlled-access permissions/release record. Do not put contracts or sensitive details into the manifest itself. |
| sha256 | 64-character lowercase hexadecimal SHA-256 of the delivered file. Intentionally blank in this example because no media exists. |
| synthetic_example | true only for illustrative rows. Remove invented rows before producing an actual release. |

## Review before release
1. Every file path exists; every real file has a matching checksum.
2. Paired files retain left/right identity and a documented timing relationship.
3. All derivatives of a source case belong to the intended evaluation partition.
4. Timing, calibration, annotation, and transform references resolve correctly.
5. The rights review reference maps to the intended files and permitted use.
6. No example references, sensitive identifiers, or unexplained missing values remain.

This minimal example does not contain patient-level or site-level split groups,
per-frame timestamps, clinical outcomes, or dense annotations. Add only the
fields your approved protocol needs, with documented access and meanings.