RIXML Documentation

OrganizationID

RIXML 2.5 Element

Level OneRequired

Unique identifier for the publishing organization using UUID format. Requires idType attribute set to 'L1' for Level One compliance. The UUID value differs from productID, researchID, and resourceID.

An identifier used to identify the organization -- multiple are possible. For example, for a product distributed via multiple vendors, each vendor may require a different OrganizationID, with the idType for each OrganizationID identifying the name of the vendor in the manner specified by the vendor. The actual ID is stored as free text in the content of the OrganizationID node. A UUID can also be used as one of the IDs. This is to facilitate the unique identification of a particular organization. To ensure uniqueness it is recommended that a Universal Unique IDentifier (UUID) be used as the productID. UUIDs can be generated on any computer, regardless of platform or operating system. A UUID is a 128-bit (16-byte) integer that is virtually guaranteed to be unique in the world across space and time. The Open Software Foundation (OSF) created UUIDs, as part of their Distributed Computing Environment (DCE).

Usage

Required element within Organization, appearing exactly once. Must have idType='L1' attribute and contain UUID value. This UUID is organization-specific and distinct from other identifiers.

Business Context

Enables precise organization identification across research distribution systems, supporting publisher tracking, compliance monitoring, and content attribution workflows.

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

Specification Guide

Overview

OrganizationID carries a single identifier value for an Organization participating in a research workflow (typically the publisher), together with an idType attribute that names the identification scheme. It enables publishers, vendors and consumers to refer to the same organization consistently across distribution platforms, regulatory systems and internal databases, and supports UUID-based identification for guaranteed global uniqueness (sources: user-guide-2.1 p.17, user-guide-2.2 p.17, data-dictionary-2.4 p.26).

Usage

OrganizationID appears as a child of Organization. The value is free-text string content holding the actual identifier; the scheme is declared via the required idType attribute (e.g. VendorCode, CUSIP, UUID, or the special L1 value for Level One) (sources: user-guide-2.2 p.17, data-dictionary-2.4 p.26). Cardinality has changed across versions: - In RIXML 2.0–2.2, at least one OrganizationID was required per Organization, with multiples permitted (sources: data-dictionary-interactions-2.0 p.16, user-guide-2.1 p.17, user-guide-2.2 p.17). - From RIXML 2.3 onward in the full schema, the element was relaxed to optional (zero or more) within Organization, so publishers can omit it for internal workflows or destinations that do not require organization identifiers (sources: release-notes-2.3 p.2, best-practices-guide p.16, user-guide-2.3 p.17, user-guide-2.3.1 p.17, data-dictionary-2.4 p.26, data-dictionary-2.5.1 p.26). - Under Level One compliance (2.2 through 2.5), exactly one OrganizationID is required, its idType must equal L1, and its content must be a UUID for the publisher (sources: level-one-2.2 p.12, level-one-2.3 p.7, level-one-2.3.1 p.7, level-one-2.4 p.25, level-one-2.5 p.7). Multiple OrganizationID instances are typical when the same organization is distributed through several vendor platforms, each expecting its own identifier scheme (sources: user-guide-2.1 p.17, user-guide-2.2 p.17, user-guide-2.3 p.17, data-dictionary-2.5.1 p.26). A v3 draft restructures this into an OrganizationIDList container holding one or more OrganizationID children, but the element semantics — string value plus required idType — are unchanged [data-dictionary-v3-draft p.37].

Rules

  • MUSTEach OrganizationID MUST carry an idType attribute identifying the scheme of the identifier value.[RIXML User Guide v2.1 p.17] [RIXML User Guide v2.2 p.17] [RIXML Research Data Dictionary v2.4 p.26] [RIXML Research Suite Data Dictionary v3.0 (DRAFT) p.37]
  • MUSTIn RIXML 2.0–2.2, an Organization MUST contain at least one OrganizationID; multiple instances are permitted to support distribution through several vendors.[RIXML User Guide v2.1 p.17] [RIXML User Guide v2.2 p.17]
  • MAYFrom RIXML 2.3 onward (full schema), OrganizationID is optional within Organization and MAY be omitted when not required by the consumer or when used internally.[RIXML Release Notes v2.3 p.2] [Best Practices for Publishing RIXML p.16] [RIXML User Guide v2.3 p.17] [RIXML User Guide v2.3.1 p.17] [RIXML Research Data Dictionary v2.4 p.26] [RIXML Research Data Dictionary v2.5.1 p.26]
  • MUSTFor Level One compliance, Organization MUST contain exactly one OrganizationID whose idType is set to the special value L1.[RIXML Level One Addendum v2.2 p.12] [RIXML Level One Addendum v2.3 p.7] [RIXML Level One Addendum v2.3.1 p.7] [RIXML Level One Addendum v2.4 p.25] [RIXML Level One Addendum v2.5 p.7]
  • MUSTFor Level One compliance, the value of OrganizationID MUST be a UUID identifying the publisher organization.[RIXML Level One Addendum v2.2 p.12] [RIXML Level One Addendum v2.3 p.7] [RIXML Level One Addendum v2.3.1 p.7] [RIXML Level One Addendum v2.5 p.7]
  • MUSTIn Level One 2.5, the UUID used in OrganizationID MUST be distinct from the UUIDs used for researchID, productID and resourceID.[RIXML Level One Addendum v2.5 p.7]
  • SHOULDOutside Level One, publishers SHOULD include a UUID as one of the OrganizationID values to guarantee global uniqueness across systems and time.[RIXML User Guide v2.1 p.17] [RIXML User Guide v2.2 p.17] [RIXML User Guide v2.3 p.17]

Relationships

Where It Fits

Canonical Path

Definition

Type
Namespacehttp://www.rixml.org/2017/9/RIXML
Min Occurs1
Max Occurs1
Content ModelText content (string)

Attributes

idTypestring

Indicates the type of ID used. Examples: CUSIP, VendorCode.

requiredSince 2.1

Children

Contains text content (type: string)

This element's value is its text content. Attributes provide additional context.

Example

<OrganizationID idType="example">ABC-123</OrganizationID>

Version History

Unchanged since introduction in RIXML 2.1

- 2.0: OrganizationID is defined as an optional, repeatable identifier element on Organization with a required idType; UUID is supported as one possible scheme [data-dictionary-interactions-2.0 p.16]. - 2.1–2.2: At least one OrganizationID is required per Organization; multiple instances are explicitly supported for multi-vendor distribution, and UUID is recommended as one of the values (sources: user-guide-2.1 p.17, user-guide-2.2 p.17). - 2.2: Level One profile introduces the requirement that the publisher Organization contain exactly one OrganizationID with idType='L1' and a UUID value [level-one-2.2 p.12]. - 2.3: Cardinality in the full schema relaxed from required (1..n) to optional (0..n), so publishers can omit the element for internal use or for consumers that do not need it (sources: release-notes-2.3 p.2, best-practices-guide p.16). Level One continues to require exactly one with idType='L1' and a UUID [level-one-2.3 p.7]. - 2.3.1 / 2.4 / 2.5: Full-schema behaviour unchanged (optional, repeatable). Level One restates the single-publisher rule, with 2.5 adding the explicit constraint that the publisher UUID must differ from those used for researchID, productID and resourceID (sources: level-one-2.3.1 p.7, level-one-2.4 p.25, level-one-2.5 p.7). - v3 draft: The element is moved under a new OrganizationIDList container which must hold one or more OrganizationID children; content remains an xs:string value qualified by idType [data-dictionary-v3-draft p.37].

Business Rules

MUST

For Level One compliance, Organization must contain exactly one OrganizationID element with idType set to L1

validationlevel-one-complianceidentifier-requirement
MUST

The OrganizationID element value must be a UUID identifying the publisher organization

validationidentifier-requirement
MUST

The UUID for OrganizationID must be different from the UUIDs used for researchID, productID, and resourceID

validationidentifier-requirement
MUST

The primary publisher must include an OrganizationID element with idType set to L1

level-one-restrictionpublisher-identification

Design Decisions

The idType attribute must be set to 'L1' for OrganizationID elements in Level One

To provide a specific identifier type designation for Level One compliance

RIXML Level One Addendum v2.5, p.7

Semantic Relationships

Constrains1 relationship

For Level One compliance, the Organization element must contain exactly one OrganizationID element

RIXML Level One Addendum v2.5, p.7Research.Product.Source.Organization.OrganizationID

Requires2 relationships

For Level One compliance, the OrganizationID idType attribute must be set to L1

RIXML Level One Addendum v2.5, p.7Research.Product.Source.Organization.OrganizationID

Level One requires the primary publisher to be identified with OrganizationID having idType L1

RIXML Level One Addendum v2.5, p.25Identifying the Publisher

Contrasts With2 relationships

The UUID for OrganizationID will not be the same as the one used for personID

RIXML Level One Addendum v2.5, p.7Research.Product.Source.Organization.OrganizationID

The UUID for personID will not be the same as the one used for OrganizationID

RIXML Level One Addendum v2.5, p.8Research.Product.Source.Organization.PersonGroupMember.Person

Triggers Action1 relationship

When an enumerated attribute is set to PublisherDefined, a companion element holds the custom value

RIXML Level One Addendum v2.5, p.26PublisherDefined