New ITS Datatypes Guide

Introduction

This document describes the rationale for the datatypes, and includes information that will be useful to those evaluating, implementing or maintaining the datatypes. It includes a description of the design principles followed in the development of the datatypes,and a discussion of each datatype.

Design philosophy

• design philosophy - why we did what we did, and some specific notes about things we did

The datatypes have been developed according to the following principles:

• Clarity of expression
• Ease of implementation
• Compatibility with datatypes from other specifications, in particular:
  • ISO 11404
  • HL7 V3 XML ITS datatypes R1
  • openEHR datatypes

The desire is to have a simple model, shared in common in both XML and UML. Either the UML or the XML can be used to understand the HL7 v3 messages, validate instances, generate code, etc. This is the "implementable model" that drives the implementation of HL7 v3 instances. Both the UML and Schema models are considered normative representations of the model.

The model represents the structure in as simple terms as possible, with a focus on commonly accepted o-o formalisms. In addition, invariant constraints are provided as either OCL or schematron constraints to further specify the many co-occurence constraints that exist in the HL7 v3 model.

\[Todo: this will be true\] The UML diagrams use stereotypes that define how the XML and schema re produced from the UML diagrams. These UML Stereotypes are not visible in the diagrams shown in this document, but will be found in the XMI and other UML files attached to this document. The UML profile used is that of David Carlson \[todo: David to give me the appropriate reference, and also reference his book and [1]\]

notes - things to rationalise:

• why short names not human understandable names

There is no discussion at the abstract level concerning the use of these attributes with null values. It is disallowed until use cases for it\’s support are accepted by HL7.

Implementers guide to ITS R2

• comparison between ITS 1 and ITS 2, and notes for implementors

Keith to complete

Things to talk about

• what happened to null Flavors TRC, QS, NINF, PINF, OTH
• introduction of properties on ANY
• changing the inheritance hierarchy (CO, ED/ST, GTS/IVL)
• specific of differences between abstract specification and ISO datatypes
  • no updateMode, History or nullFlavor on inner properties
  • new properties on PQ (accuracy, magnitude, specialValue)
  • no translations on qualifiers
  • GTS.literal
  • translation purpose
  • II.type & use
  • uncustomised xml for SLIST
  • An explicit "data" component has been added for ED
  • Addition of "Term" and "Data" classes
  • XML attributes are used for address and name part categories rather than XML element names
  • Explicit XML elements were created for sets, bags and lists
• why only one templateId

Relationship with HL7v3 datatypes release 1 (abstract and XML ITS)

(from new ITS doc, status Draft)

The following summarizes the most significant changes proposed to the data types. These are fully documented in the separate datatypes proposal document.

• Null flavor values are reduced in number
• An IdentifierUse attribute has been added to II
• Encapsulated Data (ED) has been restructured to be a sibling of String (ST), rather than a child
• An explicit "data" component has been added for ED
• XML attributes are used for address and name part categories rather than XML element names
• "Group" was added to Coded Data (CD) to support post coordinated SNOMED terms
• Explicit XML elements were created for sets, bags and lists

In addition, at this time there are a significant number of open data type shange proposals on the HL7 wiki. It is proposed that these be reviewed, and all those that will not be addressed in this release cycle be explicitly deferred to avoid implementer confusion.

Examples

• examples with discussion

Requirements

• requirements as they are collected

old stuff

Old Introduction

This is the reference package for the UML ITS. It consists of representations of the basic datatypes, infrastructural types, and structural vocabularies defined by the V3 methodology to support the UML ITS. The rationale and design philosophy are documented in the UML ITS

This package to support a specific ITS, an implementation of the V3 abstract data types, and some parts of the RIM and the structural vocabulary. It provides a particular way to implement the V3 specifications. Implementers should be aware that not all the features provided by this ITS reference package are able to be used in all contexts, and implementers must consult the V3 modeling layer (RIM, Vocabulary Definitions, Abstract Data Types, and other models) to fully implement the V3 standard correctly.