From 047deb2374c8503ec6488800a1b78ca9ac868d79 Mon Sep 17 00:00:00 2001 From: Adam Li Date: Tue, 26 Oct 2021 11:54:39 -0400 Subject: [PATCH] Adding table for clarification --- .../01-magnetic-resonance-imaging-data.md | 17 +++++++++++------ .../02-magnetoencephalography.md | 6 ++++++ .../03-electroencephalography.md | 6 ++++++ .../04-intracranial-electroencephalography.md | 6 ++++++ ...iological-and-other-continuous-recordings.md | 5 +++++ .../07-behavioral-experiments.md | 1 + .../09-positron-emission-tomography.md | 6 ++++++ 7 files changed, 41 insertions(+), 6 deletions(-) diff --git a/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md b/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md index 59a674bf16..3fb2ed39d1 100644 --- a/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md +++ b/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md @@ -188,6 +188,16 @@ When adding additional metadata please use the CamelCase version of whenever possible. See also [recommendations on JSON files](../02-common-principles.md#keyvalue-files-dictionaries). +### Source Filename + +Similar to [derivatives](../05-derivatives/02-common-data-types.md), it is OPTIONAL to include ``Sources`` as a key in the sidecar JSON, specifying the filename(s) of the source file used to generate this dataset. If the filename(s) contains patient identifiable information, then it should not be stored in ``Sources``. + +{{ MACROS___make_metadata_table( + { + "Sources": ("OPTIONAL", "URI of source file used to generate the current file. Care should be taken not to leak patient identifiable information for publicly shared datasets.") + } +) }} + ## Anatomy imaging data {{ MACROS___make_filename_template(datatypes=["anat"]) }} @@ -492,10 +502,6 @@ combined image rather than an image from each coil. ### Other RECOMMENDED metadata -#### Source Filename - -Similar to [derivatives](../05-derivatives/02-common-data-types.md), it is OPTIONAL to include ``Sources`` as a key in the sidecar JSON, specifying the filename(s) of the source file used to generate this dataset. If the filename(s) contains patient identifiable information, then it should not be stored in ``Sources``. - #### Timing Parameters {{ MACROS___make_metadata_table( @@ -566,8 +572,7 @@ Example: "InstitutionName": "Stanford University", "InstitutionAddress": "450 Serra Mall, Stanford, CA 94305-2004, USA", "DeviceSerialNumber": "11035", - "B0FieldSource": ["phasediff_fmap0", "pepolar_fmap0"], - "Sources": ["dicom01", "dicom02", ..., "dicom150"] + "B0FieldSource": ["phasediff_fmap0", "pepolar_fmap0"] } ``` diff --git a/src/04-modality-specific-files/02-magnetoencephalography.md b/src/04-modality-specific-files/02-magnetoencephalography.md index e7904d2728..55290aa39d 100644 --- a/src/04-modality-specific-files/02-magnetoencephalography.md +++ b/src/04-modality-specific-files/02-magnetoencephalography.md @@ -171,6 +171,12 @@ SHOULD be present: Similar to [derivatives](../05-derivatives/02-common-data-types.md), it is OPTIONAL to include ``Sources`` as a key in the sidecar JSON, specifying the filename(s) of the source file used to generate this dataset. If the filename(s) contains patient identifiable information, then it should not be stored in ``Sources``. +{{ MACROS___make_metadata_table( + { + "Sources": ("OPTIONAL", "URI of source file used to generate the current file. Care should be taken not to leak patient identifiable information for publicly shared datasets.") + } +) }} + Example: ```JSON diff --git a/src/04-modality-specific-files/03-electroencephalography.md b/src/04-modality-specific-files/03-electroencephalography.md index 5fca62872a..61d7b3673e 100644 --- a/src/04-modality-specific-files/03-electroencephalography.md +++ b/src/04-modality-specific-files/03-electroencephalography.md @@ -150,6 +150,12 @@ SHOULD be present: Similar to [derivatives](../05-derivatives/02-common-data-types.md), it is OPTIONAL to include ``Sources`` as a key in the sidecar JSON, specifying the filename(s) of the source file used to generate this dataset. If the filename(s) contains patient identifiable information, then it should not be stored in ``Sources``. +{{ MACROS___make_metadata_table( + { + "Sources": ("OPTIONAL", "URI of source file used to generate the current file. Care should be taken not to leak patient identifiable information for publicly shared datasets.") + } +) }} + Example: ```JSON diff --git a/src/04-modality-specific-files/04-intracranial-electroencephalography.md b/src/04-modality-specific-files/04-intracranial-electroencephalography.md index 16b1421929..c150aa3d60 100644 --- a/src/04-modality-specific-files/04-intracranial-electroencephalography.md +++ b/src/04-modality-specific-files/04-intracranial-electroencephalography.md @@ -169,6 +169,12 @@ Specific iEEG fields MAY be present: Similar to [derivatives](../05-derivatives/02-common-data-types.md), it is OPTIONAL to include ``Sources`` as a key in the sidecar JSON, specifying the filename(s) of the source file used to generate this dataset. If the filename(s) contains patient identifiable information, then it should not be stored in ``Sources``. +{{ MACROS___make_metadata_table( + { + "Sources": ("OPTIONAL", "URI of source file used to generate the current file. Care should be taken not to leak patient identifiable information for publicly shared datasets.") + } +) }} + Example: ```JSON diff --git a/src/04-modality-specific-files/06-physiological-and-other-continuous-recordings.md b/src/04-modality-specific-files/06-physiological-and-other-continuous-recordings.md index 124a7312a6..ebadd0a681 100644 --- a/src/04-modality-specific-files/06-physiological-and-other-continuous-recordings.md +++ b/src/04-modality-specific-files/06-physiological-and-other-continuous-recordings.md @@ -160,4 +160,9 @@ of any `*_.tsv.gz` file. Similar to [derivatives](../05-derivatives/02-common-data-types.md), it is OPTIONAL to include ``Sources`` as a key in the sidecar JSON, specifying the filename(s) of the source file used to generate this dataset. If the filename(s) contains patient identifiable information, then it should not be stored in ``Sources``. +{{ MACROS___make_metadata_table( + { + "Sources": ("OPTIONAL", "URI of source file used to generate the current file. Care should be taken not to leak patient identifiable information for publicly shared datasets.") + } +) }} diff --git a/src/04-modality-specific-files/07-behavioral-experiments.md b/src/04-modality-specific-files/07-behavioral-experiments.md index 61f8f22fda..4bf7595467 100644 --- a/src/04-modality-specific-files/07-behavioral-experiments.md +++ b/src/04-modality-specific-files/07-behavioral-experiments.md @@ -43,5 +43,6 @@ Similar to [derivatives](../05-derivatives/02-common-data-types.md), it is OPTIO "InstitutionName": "RECOMMENDED", "InstitutionAddress": "RECOMMENDED", "InstitutionalDepartmentName": "RECOMMENDED", + "Sources": ("OPTIONAL", "URI of source file used to generate the current file. Care should be taken not to leak patient identifiable information for publicly shared datasets.") } ) }} diff --git a/src/04-modality-specific-files/09-positron-emission-tomography.md b/src/04-modality-specific-files/09-positron-emission-tomography.md index 798fa7d2a0..3846d88d1a 100644 --- a/src/04-modality-specific-files/09-positron-emission-tomography.md +++ b/src/04-modality-specific-files/09-positron-emission-tomography.md @@ -239,6 +239,12 @@ All reconstruction-specific parameters that are not specified, but one wants to Similar to [derivatives](../05-derivatives/02-common-data-types.md), it is OPTIONAL to include ``Sources`` as a key in the sidecar JSON, specifying the filename(s) of the source file used to generate this dataset. If the filename(s) contains patient identifiable information, then it should not be stored in ``Sources``. +{{ MACROS___make_metadata_table( + { + "Sources": ("OPTIONAL", "URI of source file used to generate the current file. Care should be taken not to leak patient identifiable information for publicly shared datasets.") + } +) }} + #### Example (`*_pet.json`) ```JSON