Part of the WebMEM Protocol
Location: /specification/sdt/yaml-in-html/classes/indexfragment/
Last Updated: 2025-07-28
Overview
An IndexFragment is a structured fragment used to expose a scoped listing or navigational index of related entities within a dataset.
It is anchored to a specific entity (such as a county, state, or provider group) and typically includes plan or record IDs, canonical URLs, and derived metadata used for navigation, filtering, or retrieval.
Unlike a DataFragment, which expresses an individual fact, or a DerivedStatsFragment, which presents calculated metrics, the IndexFragment serves as a structured entry point into a memory set.
It plays a critical role in enabling agents and retrieval systems to surface, contextualize, and traverse entity-specific subsets of structured content.
Required Provenance Fields
| Field | Description |
|---|---|
ID |
Canonical provenance reference shared across related fragments. |
Title |
Human-readable dataset label (e.g., “2025 CMS Medicare Advantage Landscape”). |
Description |
Summary of the dataset contents and its relation to the index. |
Creator |
The dataset publisher (e.g., CMS). |
Home |
Canonical homepage (not the download link). |
License |
Dataset reuse terms (e.g., Public Domain, CC0). |
Published |
Publication date in ISO 8601 format. |
Retrieved |
Import or transformation date. |
Digest |
ID for the memory set the index belongs to. |
Entity |
Geographic or topical entity the index is scoped to. |
FragmentScope |
Scope indicator such as semantic-digest or index. |
Optional Provenance Fields
| Field | Description |
|---|---|
Scope |
Dataset structure: single-dataset, multi-dataset, derived. |
Archive |
Direct download link to dataset ZIP or XLSX. |
Format |
Format of the dataset (e.g., CSV, ZIP (XLSX)). |
Guidelines |
Regulatory or interpretive rules URL (e.g., CMS rules). |
GlossaryScope |
Glossary alignment ID (e.g., cms_landscape). |
Version |
Dataset version tag (e.g., v2025.1). |
Year |
Convenience field for time scoping. |
Checksum |
Cryptographic hash for verification. |
Tags |
List of semantic categories (e.g., cms, county, plan-index). |
Default fragment_scope
This fragment class defaults to semantic-digest. It should be used when exposing a structured index of fragments for a given entity (e.g., all plans in a county). This scope ensures the fragment participates in AI-indexable digest endpoints.