DECOR-project

Last revision date: Oct 22, 2012

General

The project element captures all generic information on the project/domain. It occurs exactly once in a DECOR file

Attributes

@id

required. Static OID for the project. Any project specific identifiers will be assigned under this OID. Examples include dataset concept ids and rules/templates.

The project/@id SHOULD be in a well known OID Registry

@prefix

required. Static prefix for the project. Format: 1 to 79 characters and a trailing hyphen, e.g. project-. This is the display name for the @id in many cases. It is used for the naming of various derived artifacts including but not limited to HTML pages and Schematron files. Note: the project prefix MAY match the symbolic name for the project/@id

@defaultLanguage

required. Principal language for the project. Format: ISO 639 alpha 2 (lower case)-ISO-3166 alpha 2 (upper case), e.g. "en-EN" or "en-US". Many elements support multiple languages through an attribute @language. The default language when choices exist will be this language.

Example fragment:

<project id="2.16.840.1.113883.2.4.3.99.999.10" prefix="elga-" defaultLanguage="en-EN">

Elements

name

1..*. Principal name for the project. Format: string without markup. Supports @language, see @defaultLanguage. You are encouraged to keep this name rather short (< 60 characters) as it is used as the title.

Example fragment:

<name language="nl-NL">Project Name</name>

desc

0..*. Description for the project. Format: string with optional HTML tagging (XHTML). Supports @language, see @defaultLanguage.

Example fragment:

<desc language="en-EN">
   <p>This project covers the following topics: 
    <ul>
     <li>Topic 1</li>
     <li>Topic 2</li>
    </ul>
   </p>
</desc>

copyright

1..*. Copyright for the project. Contains references to all organizations/persons that own copyright in some way.

Example fragment:

<copyright years="2008 2009 2010 2011 2012" by="Organization name" logo="ourLogo.jpg">
   <addrLine>5, Middle Road</addrLine>
   <addrLine>Washington, MD 34053</addrLine>
   <addrLine>T +1 70 317 3450</addrLine>
   <addrLine>F +1 70 320 74 37</addrLine>
</copyright>

copyright/@years

required. Enumeration of the years the copyright applies to.

copyright/@by

required. Organization/person that the copyright belongs to

copyright/@logo

required. Relative path+name of the logo file for the organization/person. Could be a transparent file. Logo file MUST be a web browser supported format, e.g. jpg, gif, or png. Logo file MUST be in a directory "project/@prefix-logos" that is next to the DECOR file itself.

copyright/addrLine

0..*. Contains address line for reaching the copyright organization/person. Address line is broad concept here. It may hold physical address lines, but also phone, fax, or URL.

author

0..*. Contains a project author. Typically this is a person, rather than an organization.

Example fragment:

<author id="1" username="kheitmann" email="user@info.org">dr Kai U. Heitmann</author>

author/@id

required. Sequence number for the author. Note that this sequence number is used in the association of DECOR-issues so sequence numbers SHOULD NOT be reused.

author/@username

optional. User name for the author. This value MAY be used for authorization of the author when he authors the DECOR file through a UI like ART.

author/@email

optional. Email address for this author. This is an optional item.

reference

0..1. Permalink (URL) for the specification. This is primarily used for creating references to the specifications from Schematron messages. If there is no reference element, there will be no @see references in generated Schematron that guide the user to the specification that the particular report or assert is based on.

Example fragment:

<reference url="http://elga.art-decor.org/"/>

restURI

0..* Used to point to services for RESTful retrieval of artifacts inside this specification. Example of these artifacts are value sets. There are two attributes @for that holds the type of artifact, and @format that holds the structure, and the URL for retrieval goes into the text node of the element.

The URI should have placeholders that maybe replaced with actual values of the artifact when retrieving is done:

• __ID__ - this is replaced by the value of @id of the artifact
• __ED__ - this is replaced by the value of @effectiveDate of the artifact

Example fragment for value set retrieval in XML:

<restURI for="VS" format="XML">http://art-decor.org/services/RetrieveValueSet?id=__ID__&amp;effectiveDate=__ED__&amp;format=xml</restURI>

restURI/@for

required. Holds the type of artifact that the URL points to. Possible values are:

1. DS - dataset
2. DE - dataset concept
3. SC - scenario
4. TR - transaction in scenario
5. AC - actor in scenario
6. VS - value set
7. IS - issue
8. RL - rule or template for instances
9. TM - template
10. CL - concept list in dataset
11. EL - element in template
12. SX - test scenario
13. TX - test transaction
14. EX - test element
15. QX - test profile

restURI/@format

required. The format of the artifact that may be retrieved from the URL. This format is not predefined. Common types are XML (raw retrieval), HTML (pre formatted rendering of the artifact), and CSV (flattened for import in Excel or database)

defaultElementNamespace

0..*.

contact

0..*.

version

0..*.

release

0..*.