Skip to content

Commit b0db166

Browse files
committed
Id for entities other than BIDS URI
1 parent 32f80c7 commit b0db166

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

src/modality-agnostic-files/provenance.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -449,12 +449,17 @@ The identifier of an entity describing a BIDS file inside a BIDS dataset MUST be
449449
!!! note
450450
The use of BIDS URIs may require to define the `DatasetLinks` object in [`dataset_description.json`](dataset-description.md#dataset_descriptionjson).
451451

452+
For other cases listed in the [Entities](#entities) section, the identifier of an entity described in a BIDS dataset `<dataset>` SHOULD have the following form, where `<label>` is a human readable name for coherently identifying the record and `<uid>` is a unique group of chars.
453+
454+
```text
455+
bids:<dataset>:prov#<label>-<uid>
456+
```
457+
452458
!!! example "Examples of identifiers for entities"
453459
- `bids:ds001734:sub-002/anat/sub-02_T1w.nii` - an entity describing a T1w file for subject `sub-002` in the `ds001734` dataset;
454460
- `bids::sub-014/func/sub-014_task-MGT_run-01_events.tsv` - an entity describing an events file for subject `sub-014` in the current dataset;
455-
- `bids:fmriprep:sub-001/func/sub-001_task-MGT_run-01_bold_space-MNI152NLin2009cAsym_preproc.nii.gz` - an entity describing a bold file for subject `sub-001` in the `fmriprep` dataset.
456-
457-
For other cases listed in the [Entities](#entities) section, the identifier of an entity described in a BIDS dataset `<dataset>` SHOULD have the following form, where `<label>` is a human readable name for coherently identifying the record and `<uid>` is a unique group of chars.
461+
- `bids:fmriprep:sub-001/func/sub-001_task-MGT_run-01_bold_space-MNI152NLin2009cAsym_preproc.nii.gz` - an entity describing a bold file for subject `sub-001` in the `fmriprep` dataset;
462+
- `bids::prov#entity-acea8093` - an entity describing a file that is not available in the dataset.
458463

459464
### Identifiers for other provenance records
460465

0 commit comments

Comments
 (0)