ResourceLink
RIXML 2.5 Element
Creates associations between Issuer elements and specific Resource elements containing XBRL data within a RIXML document. Uses XML Schema keyref functionality to link issuers to their corresponding structured financial data resources through resource identifiers.
Usage
Used within Issuer elements when XBRL resources are included in the RIXML document. The idRef attribute must match a Resource element's resourceID attribute. The type attribute should be set to XBRL to indicate the expected data format. Enables one-to-many linking between issuers and resources.
Business Context
Critical for structured financial data integration, particularly when research includes machine-readable financial statements or filings. Enables automated processing of financial data while maintaining clear associations between issuers and their structured data representations.
Specification Guide
Overview
ResourceLink is an empty linking element that associates an Issuer with a specific Resource (typically containing XBRL data) elsewhere in the same RIXML document. It carries no content of its own; the connection is made by an idRef that points to a resourceID, with the resource's data format declared via type (from ResourceTypeEnum). The link is enforced at the schema level using XML Schema keyref constraints, ensuring referential integrity between the two elements (sources: data-dictionary-2.5.1 p.54, user-guide-2.2 p.36).
Usage
Place ResourceLink inside an Issuer when the RIXML document also embeds one or more Resource elements that pertain to that issuer — most commonly when delivering XBRL-formatted financial data alongside narrative research. Zero or more occurrences are permitted per issuer, allowing a single issuer to be linked to multiple resources (for example, several XBRL filings) (sources: release-notes-2.2 p.2, data-dictionary-2.4 p.51).
Both attributes are required:
- idRef must match the resourceID of an existing Resource in the same document.
- type declares the resource format using ResourceTypeEnum, typically XBRL (sources: user-guide-2.3.1 p.37, data-dictionary-2.5.1 p.54).
Rules
- MUSTidRef must reference the resourceID of a Resource element present in the same RIXML document; this is enforced by an XML Schema
keyrefconstraint.[RIXML User Guide v2.2 p.36] [RIXML Release Notes v2.2 p.2] [RIXML Research Data Dictionary v2.5.1 p.54] - MUSTtype must be supplied with a value from ResourceTypeEnum (typically
XBRL) indicating the format of the linked resource.[RIXML User Guide v2.3.1 p.37] [RIXML Research Data Dictionary v2.4 p.51] - INFORMATIVEResourceLink as a child of Issuer is not required by RIXML Level One; Level One profiles may omit it without breaking compliance.[RIXML Level One Addendum v2.3.1 p.12]
Relationships
- child-ofIssuer — ResourceLink appears as an optional, repeatable child of Issuer, scoping the link to that particular issuer.
- referencesResource — ResourceLink references a Resource element via its idRef pointing to resourceID, creating a schema-validated keyref linkage.
- constrainsResourceTypeEnum — The type attribute is constrained to values from ResourceTypeEnum, identifying the format of the linked Resource.
Where It Fits
Canonical Path
Definition
Example
<ResourceLink idRef="example"
type="Value" />Version History
Unchanged since introduction in RIXML 2.2
ResourceLink was introduced in RIXML 2.2 as a new child of Issuer, with required idRef and type attributes, specifically to associate issuers with embedded XBRL Resource elements [release-notes-2.2 p.2]. Its definition has remained substantively unchanged through 2.3.1, 2.4, and 2.5.1, continuing to rely on XML Schema keyref for referential integrity (sources: user-guide-2.3.1 p.37, data-dictionary-2.4 p.51, data-dictionary-2.5.1 p.54). RIXML Level One (2.3.1) treats it as not required, reflecting that simple issuer representations need not include resource linking [level-one-2.3.1 p.12].
Semantic Relationships
Requires1 relationship
Resource link identifier reference must match a valid resource identifier attribute to establish proper linkage
RIXML Research Data Dictionary v2.5.1, p.54— Elements and Attributes