Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FIX] Deprecate ScanDate (PET) in favor of AcquisitionTime in scans.tsv files #798

Merged
merged 4 commits into from
Jul 13, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions src/04-modality-specific-files/09-positron-emission-tomography.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,15 +182,15 @@ which we divide into several categories:

#### Time

| **Key name** | **Requirement level** | **Data type** | **Description** |
| --------------- | --------------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| TimeZero | REQUIRED | [string][] | Time zero to which all scan and/or blood measurements have been adjusted to, in the unit "hh:mm:ss". This should be equal to `InjectionStart` or `ScanStart`. |
| ScanStart | REQUIRED | [number][] | Time of start of scan with respect to `TimeZero` in the default unit seconds. |
| InjectionStart | REQUIRED | [number][] | Time of start of injection with respect to `TimeZero` in the default unit seconds. This corresponds to DICOM Tag 0018, 1042 `Contrast/Bolus Start Time` converted to seconds relative to `TimeZero`. |
| FrameTimesStart | REQUIRED | [array][] of [numbers][] | Start times for all frames relative to `TimeZero` in default unit seconds. |
| FrameDuration | REQUIRED | [array][] of [numbers][] | Time duration of each frame in default unit seconds. This corresponds to DICOM Tag 0018, 1242 `Actual Frame Duration` converted to seconds. |
| ScanDate | RECOMMENDED | [string][] | Date of scan in the default unit `"YYYY-MM-DD[Z]"`, with the Z indicator being optional for indicating UTC timezone (see [Units](../02-common-principles.md#units)). |
| InjectionEnd | RECOMMENDED | [number][] | Time of end of injection with respect to `TimeZero` in the default unit seconds. |
| **Key name** | **Requirement level** | **Data type** | **Description** |
| --------------- | ------------------------ | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| TimeZero | REQUIRED | [string][] | Time zero to which all scan and/or blood measurements have been adjusted to, in the unit "hh:mm:ss". This should be equal to `InjectionStart` or `ScanStart`. |
| ScanStart | REQUIRED | [number][] | Time of start of scan with respect to `TimeZero` in the default unit seconds. |
| InjectionStart | REQUIRED | [number][] | Time of start of injection with respect to `TimeZero` in the default unit seconds. This corresponds to DICOM Tag 0018, 1042 `Contrast/Bolus Start Time` converted to seconds relative to `TimeZero`. |
| FrameTimesStart | REQUIRED | [array][] of [numbers][] | Start times for all frames relative to `TimeZero` in default unit seconds. |
| FrameDuration | REQUIRED | [array][] of [numbers][] | Time duration of each frame in default unit seconds. This corresponds to DICOM Tag 0018, 1242 `Actual Frame Duration` converted to seconds. |
| InjectionEnd | RECOMMENDED | [number][] | Time of end of injection with respect to `TimeZero` in the default unit seconds. |
| ScanDate | [DEPRECATED][deprecated] | [string][] | Date of scan in the format `"YYYY-MM-DD[Z]"`. This field is DEPRECATED, and this metadata SHOULD be recorded in the `acq_time` column of the corresponding [Scans file](../03-modality-agnostic-files.md#scans-file). |

We refer to the common principles for the standards for describing dates and timestamps, including possibilities for anonymization (see the [units section](../02-common-principles.md#units)).

Expand Down Expand Up @@ -413,3 +413,4 @@ time plasma_radioactivity whole_blood_radioactivity metabolite_parent_fraction m
[numbers]: https://www.w3schools.com/js/js_json_datatypes.asp
[boolean]: https://www.w3schools.com/js/js_json_datatypes.asp
[array]: https://www.w3schools.com/js/js_json_arrays.asp
[deprecated]: ../02-common-principles.md#definitions