example-cius.xml

<?xml version="1.0" encoding="UTF-8"?>

<?xml-model href="../schema/ce-config.rnc"?>
<!-- This is an example CIUS with fictive examples not reflecting any real
  content. The sole purpose is too demonstrate the features of this XML
  structure -->
<!-- Fulfils criterium: instances shall be fully compliant see README.md for
  more details -->
<cius xmlns="urn:cen.eu:en16931:cius-extension:2018"
      xmlns:html="http://www.w3.org/1999/xhtml">
  <meta>
    <shortName>cius demonstration</shortName>
    <name>A demonstration of how to define a CIUS using this XML structure</name>
    <!-- Fulfils criterium: shall be uniquely identifiable and may include version information -->
    <id>cius:demonstrandum</id>
    <!-- Optional ID of CIUS that is been further extended -->
    <extends>cius:xxx</extends>
    <!-- Fulfils criterium: shall give a clear statement about its underlying specifications -->
    <specification>EN16931-1:2017</specification>
    <!-- Fulfils criterium: shall be uniquely identifiable and may include version information -->
    <version>0.3</version>
    <status>development</status>
    <date>2018-10-02</date>
    <!-- Fullfils criterium: give information on the publisher and governor -->
    <publisher>KoSIT</publisher>
    <!-- Fullfils criterium: give information on the publisher and governor -->
    <governor>all</governor>
    <contact>renzo.kottmann@finanzen.bremen.de</contact>
    <abstract xml:lang="en">This document serves the purpose to demonstrate how
      a EN16931-1:2017 compliant description of a CIUS is made possible by this
      XML structure as defined by an XSD</abstract>
    <link>https://github.com/itplr-kosit/ce-config/blob/cius-rule-and-bt-model/schema/ce-config.xsd</link>
    <review endDate="2019-05-30">
      CIUS is currently under the review. You can send your comments until May 30th, 2019 to
      email address <html:a href="mailto:cius-comments@example.com">cius-comments@example.com</html:a>. 
      Alternatively you can log your comments <html:a href="http://example.com/submit-cius-comment">using 
        electronic form</html:a>.
    </review>
  </meta>

  <!-- Fulfils criterium: give a clear statement on the business function or legal requirements -->
  <description xml:lang="en">The function of this CIUS demonstration instance is
    to describe how it fulfils all criteria, requirements and rules on defining
    an EN16931-1:2017 compliant CIUS. In addition "A CIUS may specify how it
    creates usage guidelines and restrictions within the core invoice model."
    All CIUSs can use this description on general usage guidelines. Restrictions
    within the core invoice model can be specified in "rules"
    section. </description>
  <!-- Examples demonstrating ALL allowed changes in reference to core
    information model -->

  <!-- Now describing business rules of CIUS -->
  <rules>
    <!-- Allowed change:  Add new non-conflicting business rule for existing element(s)-->
    <rule id="BR-XX-500" >
      <description xml:lang="en">Add a new non-conflicting business rule. It is
        semantically more restrictive on business term BT-318 and only allows
        values 1 2 3 4 from codelist-2</description>
      <restrictions>
        <codelist>
          <name>codelist-2</name>
          <term>BT-10</term>
          <value>1</value>
          <value>2</value>
          <value>3</value>
          <value>4</value>          
        </codelist>
      </restrictions>
    </rule>

    <!-- Allowed change: Make an existing business rule more restrictive  -->
    <rule id="BR-XX-501">
      <description xml:lang="en">Makes existing BR-1 rule more restrictive by
        restricting cardinality to maximum 1</description>
      <restrictions>
        <cardinality minOccurs="1" maxOccurs="1">
          <term>BT-301</term>
          <term>BT-444</term>
        </cardinality>
      </restrictions>
    </rule>

    <!-- Allowed change: Restrict text or byte array length -->
    <rule id="BR-XX-502" >
      <description xml:lang="en">restricting length</description>
      <restrictions>
        <value maxLength="10">
          <term>BT-10</term>
        </value>
      </restrictions>
    </rule>

    <!-- Allowed change: Require defined structured values -->
    <rule id="BR-XX-503" >
      <description xml:lang="en">Give a format description which is more
        restrictive on BT-10</description>
      <restrictions>
        <value pattern="[0-9]{10}">
          <term>BT-10</term>
        </value>
      </restrictions>
    </rule>

    <!-- Allowed change: Restrict allowed fraction digits -->
    <rule id="BR-XX-504" >
      <description xml:lang="en">Just being rigid</description>
      <restrictions>
        <value fractionDigits="1">
          <term>BT-10</term>
        </value>
      </restrictions>
    </rule>
    
    <!-- Allowed change: Add explanatory text -->
    <rule id="BR-XX-1001">
      <description xml:lang="en">Very explanatory additonal text
        here.</description>
      <restrictions>
        <other>
          <term>BT-303</term>
        </other>
      </restrictions>
    </rule>
    
    <!-- Allowed change: Make semantic definition narrower -->
    <rule id="BR-XX-1002"> 
      <description xml:lang="en">Only a specefic narrow Amount between 1 and 2 is
        allowed</description>
      <restrictions>
        <value minInclusive="1" maxInclusive="2">
          <term>BT-301</term>
        </value>
      </restrictions>
    </rule>
    
    <!-- Allowed change: Add synonyms  -->
    <rule id="BR-XX-1003">
      <description>Term BT-302 synonyms</description>
      <restrictions>
        <synonyms>
          <term>BT-302</term>
          <!-- Many synonyms are possible -->          
          <synonym xml:lang="en">Another name for BT-2</synonym>
          <synonym xml:lang="de">Yet another name for BT-2 in German language</synonym>  
        </synonyms>
      </restrictions>
    </rule>
    
  </rules>
</cius>