RIXML Documentation

StatusInfo

RIXML 2.5 Element

Level OneRequired

Tracks the lifecycle state of research products through mandatory statusType, statusDateTime, and currentStatusIndicator attributes. Multiple instances can exist to maintain historical status changes, but only one should be marked as current.

Describes the status of the product. Multiple StatusInfo elements are permitted. Each time the product status changes, and the publisher adds a StatusInfo element, the statusDateTime must be set to reflect the point of change, and the currentStatusIndicator must be updated so that only one StatusInfo is marked as current.

Usage

Include one or more StatusInfo elements per Product. Use statusType from StatusTypeEnum like Published or Revised, timestamp changes with statusDateTime, and ensure only one element has currentStatusIndicator set to Yes. Update when product status changes.

Business Context

Critical for research lifecycle management, enabling platforms to track publication workflows, manage content states, and provide audit trails for compliance and operational monitoring.

Source:level-one-2.5
Schema:RIXML-Common-2_5.xsd:2255

Specification Guide

Overview

StatusInfo tracks the lifecycle status of research products and resources throughout their publication workflow. This element maintains a chronological history of status changes with timestamps, supporting states such as pending, published, revised, recalled, or deleted. Multiple StatusInfo elements can exist per product to preserve audit trails, but only one can be marked as current at any time through the currentStatusIndicator attribute.

Usage

StatusInfo is required within Product elements and optional within Resource elements. It can appear multiple times (maxOccurs unbounded) to track status history. Each instance requires three mandatory attributes: statusType from StatusTypeEnum, statusDateTime for timestamp tracking, and currentStatusIndicator to designate the active status. When adding new status entries, update the statusDateTime and ensure only the latest status has currentStatusIndicator set to 'Yes'. The element may contain an optional Version child element for internal versioning support.

Rules

  • MUSTOnly one StatusInfo element can have currentStatusIndicator set to 'Yes' at any time, even when multiple status entries exist[RIXML Level One Addendum v2.3.1 p.24] [RIXML User Guide v2.2 p.48] [RIXML User Guide v2.1 p.46]
  • MUSTStatusInfo elements must include statusType, statusDateTime, and currentStatusIndicator attributes[RIXML Research Data Dictionary v2.5.1 p.69] [RIXML User Guide v2.3.1 p.49]
  • INFORMATIVEStatusInfo as a child of Resource is not required by Level One compliance[RIXML Level One Addendum v2.4 p.10] [RIXML Level One Addendum v2.3 p.10]
  • MUSTstatusDateTime must be updated when adding new status information to reflect the exact moment of status change[RIXML Research Data Dictionary v2.5.1 p.69] [RIXML Level One Addendum v2.3.1 p.23]

Relationships

  • qualifiesProductStatusInfo provides publication status context and lifecycle state information for research products
  • qualifiesResourceStatusInfo can provide status tracking for individual resources within research products
  • supportsRosterUpdateStatusInfo indicates whether roster updates represent add, update, or delete operations for analyst roster management
  • supportsCoverageUpdateStatusInfo indicates whether coverage updates represent addition, update, or deletion operations for analyst coverage tracking

Where It Fits

Canonical Path

Research/Product/StatusInfo

Definition

Type
Namespacehttp://www.rixml.org/2017/9/RIXML
Min Occurs1
Max Occurs1

Attributes

statusTypeStatusTypeEnum

Indicates the status of the product or resource.

requiredSince 2.1

Indicates the date and time at which the status was assigned. It is expressed using ISO 8601 as refined by the World Wide Web Consortium's note http://www.w3.org/TR/NOTE-datetime. In addition, RIXML requires the use of Zulu time or Z-time (GMT +/- n hours:minute:seconds). All times are absolute and easier to compute, rather than using a relative (i.e. 08:30 +5) time.

requiredSince 2.1

Indicates whether or not the statusType is current -- i.e. the most recent. Note that while a product can have multiple statuses, only one of them can be current.

requiredSince 2.1

Children

Versionstring0..1

Support for internal versioning of a given product.

optionalSince 2.1

Example

<StatusInfo statusType="Published"
             statusDateTime="2024-01-15T09:30:00Z"
             currentStatusIndicator="Yes" />

Version History

Unchanged since introduction in RIXML 2.1

StatusInfo has been present since RIXML 2.1 as part of the Utility Package. The core structure and required attributes (statusType, statusDateTime, currentStatusIndicator) have remained consistent across versions 2.1 through 2.5. The element's usage within both Product and Resource contexts has been maintained throughout all versions, though Level One compliance specifications have consistently excluded StatusInfo from Resource elements to maintain implementation simplicity.

Business Rules

MUST

When multiple StatusInfo elements exist, each time the product status changes, the statusDateTime must reflect the point of change and currentStatusIndicator must be updated so only one StatusInfo is marked as current

status-managementtemporal-consistency
MUST

When multiple StatusInfo elements exist, exactly one must have currentStatusIndicator set to Yes

validationuniqueness-constraint

Design Decisions

The statusDateTime attribute was made required and configured to use ISO 8601 with mandatory Zulu time format

Accurate timestamping of status changes is essential for tracking product lifecycle events, and standardized absolute time format ensures consistent temporal processing across different systems and time zones

RIXML Research Data Dictionary v2.5.1, p.69

Semantic Relationships

Constrains4 relationships

Only one StatusInfo element can have currentStatusIndicator set to Yes, constraining which statusType is marked as the most recent

RIXML Research Data Dictionary v2.5.1, p.11RIXML file extension is .XML

StatusInfo statusType attribute must take values from StatusTypeEnum enumeration

RIXML Level One Addendum v2.5, p.24Research.Product.StatusInfo

Only one StatusInfo element may have currentStatusIndicator set to Yes at any time

RIXML Level One Addendum v2.5, p.24Research.Product.StatusInfo

This enumeration value specifically guides the statusType attribute to indicate metadata-only updates

RIXML Release Notes v2.5, p.6When only the tags are changed, not the payload

Triggers Action1 relationship

When adding a new StatusInfo element with an updated statusDateTime, the currentStatusIndicator must be updated so only one StatusInfo remains marked as current

RIXML Research Data Dictionary v2.5.1, p.69StatusInfo

Requires2 relationships

Roster updates must include status information to indicate whether the update is an add, update, or delete operation for tracking changes to research analyst rosters

RIXML Research Data Dictionary v2.5.1, p.135RosterUpdate

Coverage updates must contain status information to indicate whether the coverage change is an addition, update, or deletion for analyst coverage tracking

RIXML Research Data Dictionary v2.5.1, p.137CoverageUpdate

Qualifies1 relationship

ProductMUST

Publication status qualifies the product state and indicates whether it has been released, revised, or deleted

RIXML Implementation Guide v2.5.1, p.17Level One