7 General XML Schema Definition Language Conventions
8.7 Identifier Scheme XML Schema Files
8.7.2 Common Identifier Scheme XML Schema Components3109
CIS are universally defined for all contexts and maintained by standards bodies. CIS 3110
XML Schema Files will be imported into the context specific namespaces that use 3111
them.
3112
8.7.2.1 Namespace Name for Common Identifier Scheme 3113
The namespace name for a CIS is somewhat unique in order to convey some of the 3114
Supplementary Components rather than including them as attributes. Specifically, 3115
the namespace structure for an identifier scheme extends the earlier rules for 3116
namespace names to include the identifier scheme name in the namespace.
3117
[R 9CCF]
Identifier scheme XML Schema File namespaces MUST use the following pattern:
URN: urn:<organization>:<organization hierarchy>[:<organization hierarchy
level>]*:identifierscheme:common:<major>
:<status>:<name>
URL: http://<organization>/<organization hierarchy>[/<organization hierarchy
level>]*/identifierscheme/common/<major>
/<status>/<name>
Where:
organization – Identifier of the organization providing the standard.
org hierarchy – The first level of the hierarchy within the organization providing the standard.
org hierarchy level – Zero to n level hierarchy of the organization providing the standard.
identifierscheme – A fixed value token for common identifier schemes.
common – A fixed value token for common identifier schemes.
major – The Major version number of the identifier scheme.
status – The status of the schema as: draft|standard name – The name of the XML Schema File (using upper
camel case) with periods, spaces, or other separators and the words XML Schema File removed.
o Identifier scheme names are further defined as:
<Identifier Scheme Agency Identifier>
<divider><Identifier Scheme Identifier>
Where:
Identifier Scheme Agency Identifier – The identifier for the agency that identifier scheme is from.
Divider – The divider character for URN is : the divider character for URL is /.
Identifier Scheme Identifer – The identifier for the given identifier scheme.
3
Example 8-51 shows an identifier scheme namespace where the status of the 3118
identifier scheme is in draft status.
3119
Example 8-51: Identifier scheme namespace name with an agency and a 3120
identifer scheme identifier at draft status 3121
"urn:un:unece:uncefact:identifierscheme:common:D.04A:draft:8:GTIN: "
3122
where
3123
D.04A = the version of the UN/CEFACT directory
3124
8 = the value for GS1 in UN/CEFACT data element 3055 representing
3125
the Identifier. Scheme Agency. Identifier
3126
GTIN = GS1 data element tag for Global Trade Identification Number representing
3127
the Identifier. Scheme. Identifier
3128
While the versioning of identifier schemes published by external organisations is 3129
outside of the control of UN/CEFACT, UN/CEFACT published code lists expressed 3130
in XML Schema Files will follow the rules expressed in this specification.
3131
8.7.2.2 XML Schema Namespace Token for Common Identifier Schemes 3132
A unique token will be defined for each namespace for common identifier schemes.
3133
The token is constructed based on the identifier of the agency maintaining the 3134
identifier scheme and the identifier of the specific identifier scheme as issued by the 3135
maintenance agency.
3136
The agency maintaining the identifier scheme will be identified by the agency code 3137
as specified in data element 3055 in the UN/CEFACT Code List directory or some 3138
other unique identifier for the agency. The identifier of the specific identifier scheme 3139
will be the data element tag of the corresponding list in the UN/CEFACT directory, or 3140
some other unique identifier for the scheme.
3141
[R B2BC]
Each UN/CEFACT maintained CIS XML Schema File MUST be represented by a unique token constructed as follows:
clm<Identifier Scheme Agency Identifier><Identifier Scheme
Identifier><Identifier Scheme Version Identifier>
Such that any repeated words are eliminated.
Where:
Identifier Scheme Agency Identifier – The identifier for the agency that the identifier scheme is from.
Identifier Scheme Identifier – The identifier for the given identifier scheme.
Identifier Scheme Version Identifier – The version identifier for the identifier scheme.
2
[Note:]
3142
Developers are encouraged to follow the above rules when customizing XML 3143
Schema for Identifier Schemes to ensure that there are no namespace conflicts.
3144
Example 8-52 shows an identifier scheme token.
3145 3146
Example 8-52: Identifier scheme token with an agency and an identifier 3147
scheme identifier 3148
The identifier scheme token for Global Trade Identification Number Identier is
3149
ism8gtin200912
3150
where
3151
8 = the value for GS1 in UN/CEFACT data element 3055 representing
3152
the Identifier Scheme. Agency. Identifier
3153
gtin = GS1 data element tag for Global Trade Identification Number representing
3154
the Identifier Scheme. Identification. Identifier
3155
=200912 = the version
3156
8.7.2.3 Imports and Includes 3157
UN/CEFACT CIS XML Schema Files are standalone XML Schema Files and will not 3158
import or include any other XML Schema Files.
3159
[R A6C0] CIS XML Schema Files MUST NOT import or include any other
XML Schema Files. 1
8.7.2.4 Type Definitions 3160
Each CIS XML Schema file will have a single xsd:simpleType defined. This type 3161
definition will have an xsd:restriction element whose base type is the 3162
xsd:token XML Schema built-in data type.
3163
[R 9DDA]
Each CIS XML Schema File xsd:simpleType MUST use an xsd:restriction element whose base attribute value = xsd:token.
1
Example 8-53 shows an CIS simpleType definition.
3164
Example 8-53: CIS xsd:simpleType definition 3165
<xsd:simpleType name="GlobalTradeIdentificationNumberContentType">
3166
<xsd:restriction base="xsd:token"/>
3167
</xsd:simpleType>
3168
A CIS XML Schema File is only identifying the metadata about the identifier scheme, 3169
it is not defining the actual scheme itself since that information is publicly available.
3170
8.7.2.5 Annotation 3171
8.7.2.5.1 Annotation Documentation 3172
CIS XML Schema documentation follows the same structure as defined in section 3173
8.6.1.5.1 Annotation Documentation of this specification.
3174
8.7.2.5.2 Annotation Application Information (AppInfo) 3175
Common identifier schemes are applicable to all context and therefore do not have 3176
context specified within xsd:appInfo. Common identifier schemes are devoid of 3177
business rules and therefor do not have business rules specified within 3178
xsd:appInfo.
3179
8.7.3 Business Identifier Scheme XML Schema Components