xBRL-XML: XML Mappings for the Open Information Model 1.0

Candidate Recommendation 02 May 2017

Copyright © XBRL International Inc., All Rights Reserved.

This version:
<http://www.xbrl.org/Specification/xbrl-xml/CR-2017-05-02/xbrl-xml-CR-2017-05-02.html>
Editors:
Paul Warren, XBRL International Inc. <pdw@xbrl.org>
Herm Fischer, Mark V Systems Limited <fischer@markv.com>

Status

Circulation of this Candidate Recommendation is unrestricted. This document is normative. Other documents may supersede this document. Recipients are invited to submit comments to oim@xbrl.org, and to submit notification of any relevant patent rights of which they are aware and provide supporting documentation.

Abstract

This document defines the mapping from the XML representation defined in XBRL v2.1 to the XBRL Open Information Model v1.0, a syntax-independent definition of the data represented by an XBRL v2.1 instance document.

Table of Contents

1 Introduction
1.1 Terminology
 1.2 Namespaces and namespace prefixes
2 XBRL Report Model (non-GL)
2.1 Aspects
 2.2 Footnotes

Appendices

A References
B Intellectual property status (non-normative)
C Document History (non-normative)
D Errata Corrections incorporated in this document

Table

1 Namespaces and namespace prefixes

Definitions

Concept Core Aspect (Mapping)
DTS Reference (Mapping)
Effective relationship
Entity Core Aspect (Mapping)
Fact (Mapping)
Fact context
Fact element
Fact footnote (Mapping)
Fact unit
Footnote (Mapping)
Footnote relationship
Language Core Aspect (Mapping)
Period Core Aspect (Mapping)
Report (Mapping)
Simple Fact (Mapping)
Taxonomy-defined Aspect (Mapping)
Text Footnote (Mapping)
Tuple Fact (Mapping)
Tuple Order Core Aspect (Mapping)
Tuple Parent Core Aspect (Mapping)
Unit Core Aspect (Mapping)

1 Introduction

1.1 Terminology

The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL, in this specification, are to be interpreted as described in [IETF RFC 2119].

The keywords base item datatype and numeric simple fact are to be interpreted as described in the Open Information Model specification [OIM].

1.2 Namespaces and namespace prefixes

Namespace prefixes [XML Names] will be used for elements and attributes in the form ns:name where ns is the namespace prefix and name is the local name. Throughout this specification, the mappings from namespace prefixes to actual namespaces are consistent with Table 1.

The prefix column in Table 1 is non normative. The namespace URI column is normative.

Table 1: Namespaces and namespace prefixes
Prefix Namespace URI
oim http://www.xbrl.org/CR/2017-05-02/oim
xsd http://www.w3.org/2001/XMLSchema
link http://www.xbrl.org/2003/linkbase
xlink http://www.w3.org/1999/xlink

2 XBRL Report Model (non-GL)

The section describes how each component defined in the Open Information Model is obtained from a valid XBRL instance document and its accompanying Discoverable Taxonomy Set. This document is intended to define a bi-directional mapping between the Open Information Model and an XML document. The transformation from model to XML is not explicitly described, but may be inferred from the XML to Model mappings, taken in conjunction with the constraints defined in the XBRL v2.1 [XBRL 2.1] and XBRL Dimensions v1.0 [DIMENSIONS] specifications.

The starting point of the model is the report component, which corresponds to an XBRL XML instance document. Other components are only included in the model where they are referenced, directly or indirectly, from the report component.

Mapping: Report
Properties:
{DTS references}
See DTS references
{facts}
A set of fact components corresponding to all fact elements present in the instance document.

A fact element is an XML element in the xbrli:item or xbrli:tuple substitution group.

Mapping: Fact

A fact component is represented by a fact element. This abstract component defines properties common to both simple facts and tuple facts, and is not instantiated directly in the model.

Properties:
{id}
The value of the @id attribute, if present. Property is absent otherwise.
{footnotes}
A list of footnote components, corresponding to the elements connected to the fact by footnote relationships. See the footnote component for details. Ordering MUST be preserved between footnotes that share the same values for the {group} and {footnote type} properties, but is otherwise implementation dependent.
Mapping: Simple Fact

A simple fact component is represented by an XML element in the xbrli:item substitution group.

Properties:
{aspects}
The set of aspect OIM components associated with the fact. These are described in Section 2.1.
{value}
The content of the element.
{accuracy}
For numeric simple facts, the value of the @decimals, if present, otherwise the value of decimals that may be inferred from the @precision attribute, as described in section 4.6.6 of [XBRL 2.1]. Absent for other facts.
{base datatype}
The base item datatype of the concept definition identified by the {concept} property of the fact’s concept core aspect.
Mapping: Tuple Fact
A tuple fact component is represented by an XML element in the xbrli:tuple substitution group.
Properties:
{aspects}
A set containing a single concept core aspect.

The fact context is the <xbrli:context> element with an @id attribute that corresponds to the @contextRef attribute on the element representing a simple fact.

Mapping: DTS Reference

A DTS reference component is represented by either a <link:schemaRef> or <link:linkbaseRef> element.

Properties:
{href}
The value of the @xlink:href attribute.
{type}
The value schema if the element is a <link:schemaRef> or linkbase if the element is <link:linkbaseRef> .

2.1 Aspects

Mapping: Concept Core Aspect
Properties:
{name}
The expanded name corresponding to oim:concept
{value}
The name of the XML elementing representing the fact.
Mapping: Entity Core Aspect
Properties:
{name}
The expanded name corresponding to oim:entity
{scheme}
The value of the @scheme attribute on the xbrli:entity/xbrli:identifier element within the fact context.
{identifier}
The value of the xbrli:entity/xbrli:identifier element within the fact context.
Mapping: Period Core Aspect
Properties:
{name}
The expanded name corresponding to oim:period
{interval}

The value of the interval property is determined by the contents of the <xbrli:period> within the fact context as follows:

  • If the <xbrli:period> element contains an <xbrli:instant> element, then {interval} is a zero-length duration, starting and ending at the time specified.
  • Otherwise, if the <xbrli:period> element contains the element <xbrli:forever> , then {interval} is forever.
  • Otherwise, the duration starting at the time specified by the <xbrli:startDate> element and ending at the time specified by the <xbrli:endDate> element.

Note: If <xbrli:startDate> , <xbrli:endDate> , and <xbrli:instant> elements are specified with no time component, then they are to be interpreted as per section 4.7.2 of the XBRL v2.1 specification [XBRL 2.1]. This amounts to treating dates in an <xbrli:startDate> element as referring to midnight at the start of that day, and dates in <xbrli:endDate> and <xbrli:instant> elements as referring to midnight at the end of that day.

The fact unit is the <xbrli:unit> element with an @id attribute that corresponds to the @unitRef attribute on the element representing a simple fact, if present.

Mapping: Unit Core Aspect
Properties:
{name}
The expanded name corresponding to oim:unit
{numerators}
If the fact unit contains an <xbrli:divide> element, then {numerators} is the unordered list of values of the xbrli:divide/xbrli:unitNumerator elements. Otherwise, {numerators} is the unordered list of values of the xbrli:measure elements.
{denominators}
If the fact unit contains an <xbrli:divide> element, then {denominators} is the unordered list of values of the xbrli:divide/xbrli:unitDenominator elements. Otherwise, {denominators} is an empty list.
Mapping: Tuple Parent Core Aspect
Properties:
{name}
The expanded name corresponding to oim:tupleParent
{parent}
The tuple fact component corresponding to the tuple fact element in which this fact appears, if any. This aspect should be absent otherwise.
Mapping: Tuple Order Core Aspect
Properties:
{name}
The expanded name corresponding to oim:tupleOrder
{order}
For a fact appearing within a tuple fact, the position of the element amongst its siblings. This value is 1-based (the first sibling has order value "1"). This aspect MUST be present if the tuple parent core aspect is present, and MUST be absent otherwise.
Mapping: Language Core Aspect
The language core aspect may only be present on simple facts with a base item datatype of stringItemType or normalizedStringItemType, and is optional on such facts.
Properties:
{name}
The expanded name corresponding to oim:language
{language}
The language identified by any @xml:lang declaration that is in scope, as described in section 2.12 of [XML], for the element representing the simple fact. If there is no such declaration in scope, or if the in-scope declaration is the empty string, then this aspect is absent from the simple fact. Only language declarations within the XML document may be used: the language MUST NOT be taken from external transport protocols, as allowed for by [XML].
Mapping: Taxonomy-defined Aspect
A simple fact will have one taxonomy-defined aspect for each <xbrldi:explicitMember> or <xbrldi:typedMember> element in the <xbrli:segment> or <xbrli:scenario> elements of the fact context.
Properties:
{name}
The value of the @dimension attribute of the <xbrldi:explicitMember> or <xbrldi:typedMember> element that represents this aspect.
{value}
The value of the <xbrldi:explicitMember> element, or the value of the single child of the <xbrldi:typedMember> element representing this aspect.
{base datatype}
If the aspect is represented by an <xbrldi:explicitMember> the expanded name corresponding to xsd:QName. Otherwise, the XML Schema 1.0 simple type that is the datatype of the single child of the <xbrldi:typedMember> element, or is the one from which it is derived.

2.2 Footnotes

Mapping: Footnote

This abstract component defines properties common to both text footnotes and fact footnotes, and is not instantiated directly in the model.

A footnote exists for a fact for each target of a footnote relationship for which the fact is the source.

Properties:
{group}
The value of the @xlink:role attribute on the <link:footnoteLink> element containing <link:footnoteArc> elements that defines this footnote.
{footnote type}
The value of the @xlink:arcrole attribute on the <link:footnoteArc> element that defines this footnote.

A footnote relationship is an effective relationship defined by a <link:footnoteArc> element.

An effective relationship is a relationship present in the set of networks resulting from applying the rules of prohibiting and overriding relationships, as defined in section 3.5.3.9.7.5 of [XBRL 2.1].

Mapping: Text Footnote
A text footnote is represented by a <link:footnote> element. A text footnote inherits the common properties of the footnote component.
Properties:
{language}
The value of the @xml:lang declaration applicable to the <link:footnote> element, as described in section 2.12 of [XML].
{role}
The value of the @xlink:role attribute on the <link:footnote> element.
{value}
The content of the <link:footnote> element.
Mapping: Fact footnote
A fact footnote exists where the target of a footnote relationship is a fact element. A fact footnote inherits the common properties of the footnote component.
Properties:
{fact}
The fact component that is the target of the footnote relationship that defines this footnote.

Appendix A References

DIMENSIONS
XBRL International Inc.. "XBRL Dimensions 1.0"
Ignacio Hernández-Ros, and Hugh Wallis.
(See http://www.xbrl.org/Specification/XDT-REC-2006-09-18.htm)
IETF RFC 2119
IETF (Internet Engineering Task Force). "RFC 2119: Key words for use in RFCs to Indicate Requirement Levels"
Scott Bradner.
(See http://www.ietf.org/rfc/rfc2119.txt)
OIM
XBRL International Inc.. "XBRL Open Information Model"
Paul Warren.
(See http://www.xbrl.org/Specification/tbd/tbd.html)
XBRL 2.1
XBRL International Inc.. "Extensible Business Reporting Language (XBRL) 2.1 Includes Corrected Errata Up To 2013-02-20"
Phillip Engel, Walter Hamscher, Geoff Shuetrim, David vun Kannon, and Hugh Wallis.
(See http://www.xbrl.org/Specification/XBRL-2.1/REC-2003-12-31/XBRL-2.1-REC-2003-12-31+corrected-errata-2013-02-20.html)
XML
W3C (World Wide Web Consortium). "Extensible Markup Language (XML) 1.0 (Fifth Edition)"
Tim Bray, Jean Paoli, C. M. Sperberg-McQueen, Eve Maler, and François Yergeau.
(See http://www.w3.org/TR/REC-xml/)
XML Names
W3C (World Wide Web Consortium). "Namespaces in XML 1.0 (Third Edition)"
(See http://www.w3.org/TR/2009/REC-xml-names-20091208)

Appendix B Intellectual property status (non-normative)

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to XBRL International or XBRL organizations, except as required to translate it into languages other than English. Members of XBRL International agree to grant certain licenses under the XBRL International Intellectual Property Policy (www.xbrl.org/legal).

This document and the information contained herein is provided on an "AS IS" basis and XBRL INTERNATIONAL DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

The attention of users of this document is directed to the possibility that compliance with or adoption of XBRL International specifications may require use of an invention covered by patent rights. XBRL International shall not be responsible for identifying patents for which a license may be required by any XBRL International specification, or for conducting legal inquiries into the legal validity or scope of those patents that are brought to its attention. XBRL International specifications are prospective and advisory only. Prospective users are responsible for protecting themselves against liability for infringement of patents. XBRL International takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Members of XBRL International agree to grant certain licenses under the XBRL International Intellectual Property Policy (www.xbrl.org/legal).

Appendix C Document History (non-normative)

DateAuthorDetails
03 January 2016

First Public Working Draft

14 December 2016

Candidate Recommendation

02 May 2017Paul Warren

Second Candidate Recommendation

Appendix D Errata Corrections incorporated in this document

This appendix contains a list of the errata that have been incorporated into this document. This represents all those errata corrections that have been approved by the XBRL International Specification Maintenance Working Group (SWG) up to and including 02 May 2017. Hyperlinks to relevant e-mail threads may only be followed by those who have access to the relevant mailing lists. Access to internal XBRL mailing lists is restricted to members of XBRL International Inc.

No errata have been incorporated into this document.