Slot: Record Identifier (provenance_id)
Stable identifier for this sidecar / record (ULID recommended). This is the value the downstream health-data layer's source-value field carries to link a row back to its provenance (for OMOP, that field is external_exposure.exposure_source_value).
Tier: core
Why this slot matters
This identifier is what the downstream health-data layer's source-value field carries (for OMOP, external_exposure.exposure_source_value); it is the only hook that links an exposure value in the health layer back to its full spatial, temporal, and model provenance. Omit it and the value becomes untraceable — its metadata can never be recovered.
In plain terms
A unique serial number for this metadata document, like the tracking number on a parcel. Wherever the data value ends up, that number lets you look up exactly where it came from and how it was made.
URI: envar:slot/provenance_id
Applicable Classes
Properties
Type and Range
Cardinality and Requirements
| Property |
Value |
| Required |
Yes |
Examples
| Value |
| 01HFA7K8R3M6XP-daymet-deposit |
See Also
Annotations
| property |
value |
| tier |
core |
| justification |
This identifier is what the downstream health-data layer's source-value field carries (for OMOP, external_exposure.exposure_source_value); it is the only hook that links an exposure value in the health layer back to its full spatial, temporal, and model provenance. Omit it and the value becomes untraceable — its metadata can never be recovered. |
| explanation |
A unique serial number for this metadata document, like the tracking number on a parcel. Wherever the data value ends up, that number lets you look up exactly where it came from and how it was made. |
| covered_by |
None |
Schema Source
Mappings
| Mapping Type |
Mapped Value |
| self |
envar:provenance_id |
| native |
envar:provenance_id |
LinkML Source
name: provenance_id
annotations:
tier:
tag: tier
value: core
justification:
tag: justification
value: This identifier is what the downstream health-data layer's source-value
field carries (for OMOP, `external_exposure.exposure_source_value`); it is the
only hook that links an exposure value in the health layer back to its full
spatial, temporal, and model provenance. Omit it and the value becomes untraceable
— its metadata can never be recovered.
explanation:
tag: explanation
value: A unique serial number for this metadata document, like the tracking number
on a parcel. Wherever the data value ends up, that number lets you look up exactly
where it came from and how it was made.
covered_by:
tag: covered_by
annotations:
omop_gaia:
tag: omop_gaia
annotations:
extent:
tag: extent
value: partial
status:
tag: status
value: asserted
where:
tag: where
value: external_exposure.exposure_source_value (empty slot that could
carry a provenance id) + gaia_db data_source id
note:
tag: note
value: 'The OMOP source-value field exists as the natural carrier, but
gaia populates no per-sidecar stable record id into it. Conservative:
partial.'
degauss:
tag: degauss
annotations:
extent:
tag: extent
value: absent
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: DeGAUSS produces no sidecar and no stable per-record provenance
id.
amadeus:
tag: amadeus
annotations:
extent:
tag: extent
value: absent
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: Amadeus produces no stable per-record provenance id; only file
hashes for citation.
cher:
tag: cher
annotations:
extent:
tag: extent
value: partial
status:
tag: status
value: asserted
where:
tag: where
value: table_name reproducible resource identifier (org_dataset_..._version)
+ osti_id / ornl_res_pub_id
note:
tag: note
value: 'C-HER assigns each resource a reproducible identifier, but it
names the dataset resource, not an EnVar sidecar that a health layer''s
source-value field carries. Conservative: partial.'
codata:
tag: codata
annotations:
extent:
tag: extent
value: out_of_layer
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: A per-sidecar provenance id is packaging-layer; out of scope for
CODATA.
description: Stable identifier for this sidecar / record (ULID recommended). This
is the value the downstream health-data layer's source-value field carries to link
a row back to its provenance (for OMOP, that field is `external_exposure.exposure_source_value`).
title: Record Identifier
examples:
- value: 01HFA7K8R3M6XP-daymet-deposit
description: ULID-based sidecar identifier for the Daymet Tmax deposit
from_schema: https://w3id.org/linkml/microschemas/envar
see_also:
- https://github.com/ulid/spec
- https://ohdsi.github.io/CommonDataModel/
rank: 1000
domain_of:
- EnvironmentalExposureRecord
range: string
required: true