Skip to content

Slot: Health-Layer Link Field (health_layer_link_field)

Name of the field in the target health-data layer that carries provenance_id. For OMOP this is external_exposure.exposure_source_value (the default); other layers name their own field.

Tier: recommended

Why this slot matters

This is the join key declaration: it names the exact field in the health-data layer that holds this record's provenance_id. Without it, exposure rows cannot be joined back to patients in the health data model, and a health-side row cannot resolve to its exposure provenance.

In plain terms

Think of the exposure record and the patient database as two spreadsheets that need to be matched up. This slot names the column in the patient-side spreadsheet that holds the matching ID, so anyone can connect the two tables without guessing.

URI: envar:slot/health_layer_link_field

Applicable Classes

Name Description Modifies Slot
HealthLayerLinkage Hooks the sidecar uses to be findable from a downstream health-data layer (OM... no

Properties

Type and Range

Property Value
Range String
Domain Of HealthLayerLinkage

Cardinality and Requirements

Property Value

Examples

Value
exposure_source_value

See Also

Identifier and Mapping Information

Annotations

property value
tier recommended
justification This is the join key declaration: it names the exact field in the health-data layer that holds this record's provenance_id. Without it, exposure rows cannot be joined back to patients in the health data model, and a health-side row cannot resolve to its exposure provenance.
explanation Think of the exposure record and the patient database as two spreadsheets that need to be matched up. This slot names the column in the patient-side spreadsheet that holds the matching ID, so anyone can connect the two tables without guessing.
covered_by None

Schema Source

Mappings

Mapping Type Mapped Value
self envar:health_layer_link_field
native envar:health_layer_link_field

LinkML Source

name: health_layer_link_field
annotations:
  tier:
    tag: tier
    value: recommended
  justification:
    tag: justification
    value: 'This is the join key declaration: it names the exact field in the health-data
      layer that holds this record''s `provenance_id`. Without it, exposure rows cannot
      be joined back to patients in the health data model, and a health-side row cannot
      resolve to its exposure provenance.'
  explanation:
    tag: explanation
    value: Think of the exposure record and the patient database as two spreadsheets
      that need to be matched up. This slot names the column in the patient-side spreadsheet
      that holds the matching ID, so anyone can connect the two tables without guessing.
  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 (the OMOP field that would
              carry a provenance id)
          note:
            tag: note
            value: 'The OMOP external_exposure.exposure_source_value field exists
              and is the natural provenance-id carrier, but gaia does not populate
              it with a sidecar provenance id. 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 declares no health-layer join field.
      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 declares no health-layer join field.
      cher:
        tag: cher
        annotations:
          extent:
            tag: extent
            value: partial
          status:
            tag: status
            value: asserted
          where:
            tag: where
            value: table_column_dictionary.reference_column_id (FK to a column in
              another resource, e.g. the health schema)
          note:
            tag: note
            value: 'C-HER models a cross-resource reference-column mechanism that
              could carry such a join, but declares no exposure-record-to-health-layer
              link field. 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: Health-layer join-field declaration is instance/integration-layer;
              out of scope for CODATA.
description: Name of the field in the target health-data layer that carries `provenance_id`.
  For OMOP this is `external_exposure.exposure_source_value` (the default); other
  layers name their own field.
title: Health-Layer Link Field
examples:
- value: exposure_source_value
  description: the OMOP `external_exposure` field that carries `provenance_id`
from_schema: https://w3id.org/linkml/microschemas/envar
see_also:
- https://ohdsi.github.io/CommonDataModel/
rank: 1000
domain_of:
- HealthLayerLinkage
range: string