Skip to content

Commit

Permalink
Adding table for clarification
Browse files Browse the repository at this point in the history
  • Loading branch information
adam2392 committed Oct 26, 2021
1 parent a68699c commit 047deb2
Show file tree
Hide file tree
Showing 7 changed files with 41 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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"]) }}
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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"]
}
```

Expand Down
6 changes: 6 additions & 0 deletions src/04-modality-specific-files/02-magnetoencephalography.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions src/04-modality-specific-files/03-electroencephalography.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,4 +160,9 @@ of any `*_<physio>.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.")
}
) }}
<!-- Link Definitions -->
Original file line number Diff line number Diff line change
Expand Up @@ -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.")
}
) }}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 047deb2

Please sign in to comment.