Revision as of 05:53, 13 March 2007

This page will be the area in which collected datatype XML ITS Examples are stored prior to documenting and comparing

All XML ITS Examples should have provenance notes and if possible a link to the source document.

Basic Data Types

BL (Boolean)

XML ITS Example

<contextConductionInd value="true"/>

<seperatableInd value="false"/>

<seperatableInd nullFlavor="UNK"/>

Provenance: CfH MIM v6.1.00 Datatypes section

UML ITS Equivalents

<contextConductionInd value="true"/>

<seperatableInd value="false"/>

<seperatableInd nullFlavor="UNK"/>

Comparison Notes

BL is identical

BN (Boolean Non Null)

XML ITS Example

<contextConductionInd value="true"/>

<seperatableInd value="false"/>

Provenance: CfH MIM v6.1.00 Datatypes section

UML ITS Equivalents

<contextConductionInd value="true"/>

<seperatableInd value="false"/>

Comparison Notes

BN is identical. In fact, the ISO datatypes do not have a BN, all uses are mapped to BL with a constraint nullFlavor = null

Text And Content Data Types

ED (Encapsulated Data)

XML ITS Example

Encapsulated Data Plain Text (f)

<value>Some plain text</value>

Encapsulated Data Text and Line Breaks (f)

<.....>

Encapsulated Data Limited HTML (f)

<value mediaType="text/x-h7uk-html" >
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.w3.org/1999/xhtml ..\dt\xhtmlNPfIT.xsd">
<head>
   <title>Diagnostic Imaging Procedure Report</title>
</head>
<body>
   <p>The lung fields are clear. Heart size is enlarged with slight unfolding of the aorta.</p>
   <p>CTR = 18/35 cm</p>
   <p>The right hemi-diaphragm is raised</p>
</body>
</html>
</value>

Encapsulated Data Attachment Reference (f)

<value>
    <reference value="http://www.nhsia.nhs.uk/MIMv3.0/index.htm"/>
</value>

Encapsulated Data Attachment (f)

<!-- To indicate attachment data (in an observation class "value" attribute)  -->
<value encoding="B64" mediaType="text/plain">[BASE64REPRESENTATIONOFTHEDATA]</value>

Provenance: CfH MIM 6.1.00 Datatypes section

UML ITS Equivalents

<value value="Some plain text"/>

<value mediaType="text/x-h7uk-html" >
<xml>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.w3.org/1999/xhtml ..\dt\xhtmlNPfIT.xsd">
<head>
   <title>Diagnostic Imaging Procedure Report</title>
</head>
<body>
   <p>The lung fields are clear. Heart size is enlarged with slight unfolding of the aorta.</p>
   <p>CTR = 18/35 cm</p>
   <p>The right hemi-diaphragm is raised</p>
</body>
</html>
</xml>
</value>

 <value>
    <reference value="http://www.nhsia.nhs.uk/MIMv3.0/index.htm"/>
</value>

 <!-- To indicate attachment data (in an observation class "value" attribute)  -->
<value encoding="B64" mediaType="text/plain"><value>[BASE64REPRESENTATIONOFTHEDATA]</value></value>

Comparison Notes

The main difference is the introduction of the value attribute of the and <xml> tags to organise the data and simplify the schema and data banding process. There is a consequence to this, which is that the stream formats for ST and ED are no longer equivalent for non-text content.

ST (Character String)

XML ITS Example

<text>Some plain text</text>

<value nullFlavor="UNK"/>

Provenance: CfH MIM 6.1.00 Datatypes section

UML ITS Equivalents

<text value="Some plain text"/>

<value nullFlavor="UNK"/>

Comparison Notes

the content has moved from the text of the node to a value attribute.

SC (Coded String)

XML ITS Example

<softwareName>NHAIS</softwareName>

<softwareName code="1" codeSystem="2.16.840.1.113883.2.1.3.2.9999" displayName="NHAIS">NHAIS</softwareName>

<softwareName nullFlavor="UNK"/>

Provenance: CfH MIM 6.1.00 Datatypes section

UML ITS Equivalents

<softwareName value="NHAIS"/>

<softwareName value="NHAIS"><displayName value="NHAIS"></softwareName>

<softwareName nullFlavor="UNK"/>

Comparison Notes

This is different because SC has the code as a CD type, and the CD type has display name as a ST in order to convey language.

Coded Data Types

CD (Concept Descriptor)

XML ITS Example

<value code="11" codeSystem="2.16.840.1.113883.2.1.3.2.4.17.42" displayName="NHS Number confirmed"/>

Provenance: CfH MIM Version 6.1.00 Datatypes Section

UML ITS Equivalents

<value code="11" codeSystem="2.16.840.1.113883.2.1.3.2.4.17.42"><displayName value="NHS Number confirmed"/></value>

Comparison Notes

This is different because displayName is an ST not a String in order to allow language to be conveyed.

CE (Coded With Equivalents)

XML ITS Example

<code code=".H43." codeSystem="2.16.840.1.113883.6.28" displayName="asthma">
   <originalText>currently suffering from asthma</originalText>
   <translation code="195967001" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="asthma"/>
</code>

Provenance:

UML ITS Equivalents

<code code=".H43." codeSystem="2.16.840.1.113883.6.28"><displayName value="asthma"/>
   <originalText value="currently suffering from asthma"/>
   <translation code="195967001" codeSystem="2.16.840.1.113883.2.1.3.2.4.15"><displayName value="asthma"/></translation>
</code>

Comparison Notes

Previously noted differences in displayName and originalText (as an ST)

CO (Coded Ordinal)

XML ITS Example

<.......>

Provenance:

UML ITS Equivalents

<.......>

Comparison Notes

CS (Coded Simple Value)

XML ITS Example

<.......>

Provenance:

UML ITS Equivalents

<.......>

Comparison Notes

Miscellaneous Data Types

II (Instance Identifier)

XML ITS Example

<!-- To indicate a DCE UUID for an "id" class attribute -->
<id root="BBBBE26A-A9D1-A411-F824-9F7A00A33757"/>

<!-- To indicate an identifier for an "id" class attribute (in this case a NHS number)  -->
<id root="2.16.840.1.113883.2.1.4.1" extension="9999999484"/>

Provenance:

UML ITS Equivalents

<.......>

Comparison Notes

TEL (Telecommunication Address)

XML ITS Example

<.......>

Provenance:

UML ITS Equivalents

<.......>

<.......>

Comparison Notes

PN (Person Name)

XML ITS Example

<!-- To indicate an unstructured usual person name -->
<name use="L">John Smith</name>

<!-- To indicate an unstructured alias person name with a validity date interval -->
<name use="A">John Smith
    <validTime>
         <low value="19990401"/>
         <high value="20040331"/>
    </validTime>
</name

<!-- To indicate a structured usual person name with title, two forenames, family name and suffix  -->
<name use="L">
    <prefix>Mr</prefix>
    <given>John</given>
    <given>Paul</given>
    <family>Smith</family>
    <suffix>Snr</suffix>
</name>

<!-- To indicate a structured usual person name with title, two forenames, family name and suffix, with a validity date interval -->
<name use="A">
    <prefix>Mr</prefix>
    <given>John</given>
    <given>Paul</given>
    <family>Smith</family>
    <suffix>Snr</suffix>
    <validTime>
         <low value="19990401"/>
         <high value="20040331"/>
    </validTime>
</name>

Provenance:

UML ITS Equivalents

<!-- To indicate an unstructured usual person name -->
<name use="L"><part>John Smith</part></name>

<!-- To indicate an unstructured alias person name with a validity date interval -->
<name use="A">
  <part>John Smith</part>
  <validTime>
     <low value="19990401"/>
     <high value="20040331"/>
  </validTime>
</name

<!-- To indicate a structured usual person name with title, two forenames, family name and suffix  -->
<name use="L">
    <part type="PFX">Mr</part>
    <part type="GIV">John</part>
    <part type="GIV">Paul</part>
    <part type="FAM">Smith</part>
    <part type="SFX">Snr</part>
</name>

<!-- To indicate a structured usual person name with title, two forenames, family name and suffix, with a validity date interval -->
<name use="A">
    <part type="PFX">Mr</part>
    <part type="GIV">John</part>
    <part type="GIV">Paul</part>
    <part type="FAM">Smith</part>
    <part type="SFX">Snr</part>
    <validTime>
         <low value="19990401"/>
         <high value="20040331"/>
    </validTime>
</name>

Comparison Notes

The primary difference is that the type of the part is no longer indicated in the element name, but in the type parameter.

ON (Organization Name)

XML ITS Example

<!-- To indicate an unstructured organization name  -->
<name>Good Health Hospital</name>

<!-- To indicate an unstructured organization name with a validity date interval -->
<name>Good Health Hospital
    <validTime>
         <low value="19990401"/>
         <high value="20040331"/>
    </validTime>
</name>

Provenance:

UML ITS Equivalents

<!-- To indicate an unstructured organization name  -->
<name><part>Good Health Hospital</part></name>

<!-- To indicate an unstructured organization name with a validity date interval -->
<name>
    <part>Good Health Hospital</part>
    <validTime>
         <low value="19990401"/>
         <high value="20040331"/>
    </validTime>
</name>

Comparison Notes

The primary difference is that the type of the part is no longer indicated in the element name, but in the type parameter.

AD (Address)

XML ITS Example

<!-- To indicate a home address with unstructured address lines  -->
<addr use="H">
    <streetAddressLine>Hexagon House</streetAddressLine>
    <streetAddressLine>Pynes Hill</streetAddressLine>
    <streetAddressLine>Rydon Lane</streetAddressLine>
    <streetAddressLine>Exeter</streetAddressLine>
    <streetAddressLine>Devon</streetAddressLine>
    <postalCode>EX2 5SE</postalCode>
    <addressKey>12345678</addressKey>
</addr>

<!-- To indicate a temporary address with unstructured address lines and a description and dates -->
<addr use="TMP">
    <streetAddressLine>AQUEOUS II</streetAddressLine>
    <streetAddressLine>ASTON CROSS</streetAddressLine>
    <streetAddressLine>ROCKY LANE</streetAddressLine>
    <streetAddressLine>ASTON</streetAddressLine>
    <streetAddressLine>BIRMINGHAM</streetAddressLine>
    <postalCode>B6 5RQ</postalCode>
    <addressKey>23456789</addressKey>
    <desc>Holiday home</desc>
    <useablePeriod>
         <low value="20040716"/>
         <high value="20040831"/>
    </useablePeriod>
</addr>

<addr use="H">
    <houseNumber>Hexagon House</houseNumber>
    <streetName>Pynes Hill</streetName>
    <streetName>Rydon Lane</streetName>
    <city>Exeter</city>
    <county>Devon</county>
    <postalCode>EX2 5SE</postalCode>
    <addressKey>12345678</addressKey>
</addr>

Provenance: UK...?

UML ITS Equivalents

<!-- To indicate a home address with unstructured address lines  -->
<addr use="H">
    <part type="SAL">Hexagon House</part>
    <part type="SAL">Pynes Hill</part>
    <part type="SAL">Rydon Lane</part>
    <part type="SAL">Exeter</part>
    <part type="SAL">Devon</part>
    <part type="ZIP">EX2 5SE</part>
    <part type="KEY">12345678</part>
</addr>

<!-- To indicate a temporary address with unstructured address lines and a description and dates -->
<addr use="TMP">
    <part type="SAL">AQUEOUS II</part>
    <part type="SAL">ASTON CROSS</part>
    <part type="SAL">ROCKY LANE</part>
    <part type="SAL">ASTON</part>
    <part type="SAL">BIRMINGHAM</part>
    <part type="ZIP">B6 5RQ</part>
    <part type="KEY">23456789</part>
    <part type="DESC">Holiday home</part>
    <useablePeriod>
       <item>
         <low value="20040716"/>
         <high value="20040831"/>
       </item>
    </useablePeriod>
</addr>

<addr use="H">
    <part type="BNR">Hexagon House</part>
    <part type="STR">Pynes Hill</part>
    <part type="STR">Rydon Lane</part>
    <part type="CTY">Exeter</part>
    <part type="CNT">Devon</part>
    <part type="ZIP">EX2 5SE</part>
    <part type="KEY">12345678</part>
</addr>

Comparison Notes

KEY and DESC are UK extensions.

The primary difference is that the type of the part is no longer indicated in the element name, but in the type parameter.

There is also a difference in the GTS type.

Quantities

QTY (Quantity)

XML ITS Example

<.......>

Provenance:

UML ITS Equivalents

<.......>

Comparison Notes

INT (Integer)

XML ITS Example

<repeatNumber value="1"/>

<sequenceNumber nullFlavor="UNK"/>

Provenance: CfH MIM v6.1.00 Datatypes section

UML ITS Equivalents

<repeatNumber value="1"/>

<sequenceNumber nullFlavor="UNK"/>

Comparison Notes

No difference

REAL (Real)

XML ITS Example

<value value="2.3"/>

<value nullFlavor="UNK"/>

Provenance: CfH MIM v6.1.00 Datatypes section

UML ITS Equivalents

<value value="2.3"/>

<value nullFlavor="UNK"/>

Comparison Notes

No difference

RTO (Ratio)

XML ITS Example

<.......>

Provenance:

UML ITS Equivalents

<.......>

Comparison Notes

PQ (Physical Quantity)

XML ITS Example

<!-- To indicate a percentage for the "value" attribute of an observation class  -->
<value value="92.55" unit="%"/>

<!-- To indicate a measured quantity in alternative units of 30 grams -->
<quantity value="30" unit="gram">
   <translation value="30" code="258682000" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="gram"/>
</quantity>

<!-- To indicate a counted quantity in alternative units of 100 tablets  -->
<quantity value="100" unit="1">
     <translation value="100" code="3319411000001109" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="tablet"/>
</quantity>

<!-- To indicate a counted quantity in arbitrary units -->
<value value="6" unit="1">
    <translation value="6">
         <originalText>packets each containing 21 tablets of A and 7 tablets of B</originalText>
    </translation>
</value>

Provenance:

UML ITS Equivalents

<!-- To indicate a percentage for the "value" attribute of an observation class  -->
<value value="92.55" unit="%"/>

<!-- To indicate a measured quantity in alternative units of 30 grams -->
<quantity value="30" unit="gram">
   <translation value="30" code="258682000" codeSystem="2.16.840.1.113883.2.1.3.2.4.15"><displayName value="gram"/></translation>
</quantity>

<!-- To indicate a counted quantity in alternative units of 100 tablets  -->
<quantity value="100" unit="1">
     <translation value="100" code="3319411000001109" codeSystem="2.16.840.1.113883.2.1.3.2.4.15"><displayName value="tablet"/></translation>
</quantity>

<!-- To indicate a counted quantity in arbitrary units -->
<value value="6" unit="1">
    <translation value="6">
         <originalText value="packets each containing 21 tablets of A and 7 tablets of B"/>
    </translation>
</value>

Comparison Notes

<.......>

Comparison Notes

IVL (Interval)

XML ITS Example

<!-- To indicate an effective time of  12:05 on 25/06/2004 -->
<effectiveTime>

</effectiveTime>

<!-- To indicate an effective time between of  12:05 and 12:20 on 25/06/2004  -->
<effectiveTime>
    <low value="200406251205"/>
    <high value="200406251220"/>
</effectiveTime>

<!-- To indicate an effective time after  12:05 on 25/06/2004 -->
<effectiveTime>
    <low value="200406251205"/>
</effectiveTime>

<!-- To indicate an effective time before  25/06/2004 -->
<effectiveTime>
    <high value="20040625"/>
</effectiveTime>

<!-- To indicate an effective time of one month duration -->
<effectiveTime>
    <width value="1" unit="mo"/>
</effectiveTime>

<!-- To indicate an effective time with a 24 hour duration centred on  15/06/2002  -->
<effectiveTime>

    <width value="24" unit="h"/>
</effectiveTime>

Provenance: CfH MIM v6.1.00 Datatypes section

UML ITS Equivalents

<!-- To indicate an effective time of  12:05 on 25/06/2004 -->
<effectiveTime>
    <low value="200406251205"/>
    <high value="200406251205"/>
</effectiveTime>

<!-- To indicate an effective time between of  12:05 and 12:20 on 25/06/2004  -->
<effectiveTime>
    <low value="200406251205"/>
    <high value="200406251220"/>
</effectiveTime>

<!-- To indicate an effective time after  12:05 on 25/06/2004 -->
<effectiveTime>
    <low value="200406251205"/>
</effectiveTime>

<!-- To indicate an effective time before  25/06/2004 -->
<effectiveTime>
    <high value="20040625"/>
</effectiveTime>

<!-- To indicate an effective time of one month duration -->
<effectiveTime>
    <width xsi:type="PQ" value="1" unit="mo"/>
</effectiveTime>

<!-- To indicate an effective time with a 24 hour duration centred on  15/06/2002  -->
<effectiveTime>
    <low value="200206141200"/>
    <high value="200206151200"/>
</effectiveTime>

Comparison Notes

Center is banned - have to replace with low and high

width is a QTY - have to use xsi:type with it.

HIST (History)

XML ITS Example

<.......>

Provenance:

UML ITS Equivalents

<.......>

Comparison Notes

Timing Specifications

PIVL (PeriodicInterval)

XML ITS Example

<.......>

Provenance:

UML ITS Equivalents

<.......>

Comparison Notes

EIVL (Event-Related Periodic Interval of Time)

XML ITS Example

<.......>

Provenance:

UML ITS Equivalents

<.......>

Comparison Notes

GTS (General Timing Specification)

XML ITS Example

<! To indicate Two times a day at institution specified time, at 0800 and 1600, on Sunday and Thursday between 29th March and 8th April 2004>
<effective_time xsi:type='SXCM_TS'  xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='urn:hl7-org:v3'>
    <comp xsi:type='SXCM_TS'>
      <comp xsi:type='PIVLS_TS'>
        <phase>
          <low value='2001-07-01T0800' inclusive='True'/>
          <high value='2001-07-01T0800' inclusive='True'/>
        </phase>
        <period value='1' unit='wk'/>
      </comp>
      <comp xsi:type='PIVLS_TS' operator='I'>
        <phase>
          <low value='2001-07-01T1600' inclusive='True'/>
          <high value='2001-07-01T1600' inclusive='True'/>
        </phase>
        <period value='1' unit='wk'/>
      </comp>
      <comp xsi:type='PIVLS_TS' operator='I'>
        <phase>
          <low value='2001-11-01T0800' inclusive='True'/>
          <high value='2001-11-01T0800' inclusive='True'/>
        </phase>
        <period value='1' unit='wk'/>
      </comp>
      <comp xsi:type='PIVLS_TS' operator='I'>
        <phase>
          <low value='2001-11-01T1600' inclusive='True'/>
          <high value='2001-11-01T1600' inclusive='True'/>
        </phase>
        <period value='1' unit='wk'/>
      </comp>
    </comp>
    <comp xsi:type='SXCM_TS' operator='A'>
      <comp xsi:type='IVLS_TS'>
        <low value='2004-03-29T0000' inclusive='True'/>
        <high value='2004-04-08T0000' inclusive='True'/>
      </comp>
    </comp>
</effective_time>

Comment from Grahame: does this really say what it claims? Firstly, a couple of technical issues,
  PIVL_TS not PIVLS_TS, and the timestamp should be 200107010800 not 2001-07-01T0800. But it's a
  very complex way to say the concept.

<! To indicate every 6 hours at 00:00, 06:00, 12:00 and 18:00 between March 29 and April 8, 2004
<effective_time xsi:type='SXCM_TS'  xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='urn:hl7-org:v3'>
  <comp xsi:type='SXCM_TS'>
    <comp xsi:type='PIVLS_TS'>
      <phase>
        <low value='2007-03-05T0000' inclusive='True'/>
        <high value='2007-03-05T0000' inclusive='True'/>
      </phase>
      <period value='1' unit='d'/>
    </comp>
    <comp xsi:type='PIVLS_TS' operator='I'>
      <phase>
        <low value='2007-03-05T0600' inclusive='True'/>
        <high value='2007-03-05T0600' inclusive='True'/>
      </phase>
      <period value='1' unit='d'/>
    </comp>
    <comp xsi:type='PIVLS_TS' operator='I'>
      <phase>
        <low value='2007-03-05T1200' inclusive='True'/>
        <high value='2007-03-05T1200' inclusive='True'/>
      </phase>
      <period value='1' unit='d'/>
    </comp>
    <comp xsi:type='PIVLS_TS' operator='I'>
      <phase>
        <low value='2007-03-05T1800' inclusive='True'/>
        <high value='2007-03-05T1800' inclusive='True'/>
      </phase>
      <period value='1' unit='d'/>
    </comp>
  </comp>
  <comp xsi:type='SXCM_TS' operator='A'>
    <comp xsi:type='IVLS_TS'>
      <low value='2004-03-29T0000' inclusive='True'/>
      <high value='2004-04-08T0000' inclusive='True'/>
    </comp>
  </comp>
</effective_time>

Provenance: Effective Timing Tool Created By: Rob Landry, Todd Kinnee, Mike Cleghorn

UML ITS Equivalents

Actually, these ones can't be done right now - need to do some work with GTS.

Comparison Notes

@@ Line 22: / Line 22: @@
 Provenance: CfH MIM v6.1.00 Datatypes section
-===UML ITS Generated Example===
+===UML ITS Equivalents===
-<.......>
+ ''<contextConductionInd value="true"/>''
+ ''<seperatableInd value="false"/>''
+ ''<seperatableInd nullFlavor="UNK"/>''
 ===Comparison Notes===
+BL is identical
@@ Line 44: / Line 48: @@
 Provenance: CfH MIM v6.1.00 Datatypes section
-===UML ITS Generated Example===
+===UML ITS Equivalents===
+ ''<contextConductionInd value="true"/>''
-<.......>
+ ''<seperatableInd value="false"/>''
+===Comparison Notes===
+BN is identical. In fact, the ISO datatypes do not have a BN,
-===Comparison Notes===
+all uses are mapped to BL with a constraint nullFlavor = null
 ----
@@ Line 103: / Line 109: @@
 Provenance: CfH MIM 6.1.00 Datatypes section
-===UML ITS Generated Example===
+===UML ITS Equivalents===
+ ''<value value="Some plain text"/>''
+ <value mediaType="text/x-h7uk-html" >
+ <xml>
+ <html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.w3.org/1999/xhtml ..\dt\xhtmlNPfIT.xsd">
+ <head>
+    <title>Diagnostic Imaging Procedure Report</title>
+ </head>
+ <nowiki><body></nowiki>
+ <nowiki>   <p>The lung fields are clear. Heart size is enlarged with slight unfolding of the aorta.</p></nowiki>
+ <nowiki>   <p>CTR = 18/35 cm</p></nowiki>
+ <nowiki>   <p>The right hemi-diaphragm is raised</p></nowiki>
+ </body>
+ </html>
+ </xml>
+ </value>
+  <value>
+     <nowiki><reference value="http://www.nhsia.nhs.uk/MIMv3.0/index.htm"/></nowiki>
+ </value>
-<.......>
+  <nowiki><!-- To indicate attachment data (in an observation class "value" attribute)  --></nowiki>
+ <value encoding="B64" mediaType="text/plain"><value>[BASE64REPRESENTATIONOFTHEDATA]</value></value>
 ===Comparison Notes===
+The main difference is the introduction of the value attribute of the <data>
+and <xml> tags to organise the data and simplify the schema and data banding
+process. There is a consequence to this, which is that the stream formats for
+ST and ED are no longer equivalent for non-text content.
 ----
@@ Line 120: / Line 153: @@
   ''<value nullFlavor="UNK"/>''
+Provenance: CfH MIM 6.1.00 Datatypes section
-Provenance: CfH MIM 6.1.00 Datatypes section
+===UML ITS Equivalents===
-===UML ITS Generated Example===
+ ''<text value="Some plain text"/>''
-<.......>
+ ''<value nullFlavor="UNK"/>''
 ===Comparison Notes===
+the content has moved from the text of the node to a value attribute.
 ----
@@ Line 143: / Line 179: @@
+Provenance: CfH MIM 6.1.00 Datatypes section
+===UML ITS Equivalents===
-Provenance: CfH MIM 6.1.00 Datatypes section
+ ''<softwareName value="NHAIS"/>''
-===UML ITS Generated Example===
+ ''<softwareName value="NHAIS"><code code="1" codeSystem="2.16.840.1.113883.2.1.3.2.9999"><displayName value="NHAIS"></code></softwareName>''
-<.......>
+ ''<softwareName nullFlavor="UNK"/>''
 ===Comparison Notes===
+This is different because SC has the code as a CD type, and the CD type has
+display name as a ST in order to convey language.
 ----
@@ Line 167: / Line 209: @@
 Provenance: CfH MIM Version 6.1.00 Datatypes Section
-===UML ITS Generated Example===
+===UML ITS Equivalents===
-<.......>
+ <value code="11" codeSystem="2.16.840.1.113883.2.1.3.2.4.17.42"><displayName value="NHS Number confirmed"/></value>
 ===Comparison Notes===
+This is different because displayName is an ST not a String in order to allow language to be conveyed.
 ----
@@ Line 179: / Line 223: @@
 ===XML ITS Example===
   <nowiki><code code=".H43." codeSystem="2.16.840.1.113883.6.28" displayName="asthma"></nowiki>
-     <originalText>currently suffering from asthma""</originalText>
+     <originalText>currently suffering from asthma</originalText>
      <translation code="195967001" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="asthma"/>
   <nowiki></code></nowiki>
@@ Line 187: / Line 231: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
-<.......>
+ <nowiki><code code=".H43." codeSystem="2.16.840.1.113883.6.28"><displayName value="asthma"/></nowiki>
+    <originalText value="currently suffering from asthma"/>
+    <translation code="195967001" codeSystem="2.16.840.1.113883.2.1.3.2.4.15"><displayName value="asthma"/></translation>
+ <nowiki></code></nowiki>
 ===Comparison Notes===
+Previously noted differences in displayName and originalText (as an ST)
 ----
@@ Line 204: / Line 253: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 221: / Line 270: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 229: / Line 278: @@
 =Miscellaneous Data Types=
@@ Line 245: / Line 294: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 261: / Line 310: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 282: / Line 331: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 299: / Line 348: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 316: / Line 365: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 333: / Line 382: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 350: / Line 399: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 398: / Line 447: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
+ <nowiki><!-- To indicate an unstructured usual person name --></nowiki>
+ <name use="L"><part>John Smith</part></name>
+ <nowiki><!-- To indicate an unstructured alias person name with a validity date interval --></nowiki>
+ <name use="A">
+   <part>John Smith</part>
+   <validTime>
+      <low value="19990401"/>
+      <high value="20040331"/>
+   </validTime>
+ </name
+ <nowiki><!-- To indicate a structured usual person name with title, two forenames, family name and suffix  --></nowiki>
+ <name use="L">
+     <part type="PFX">Mr</part>
+     <part type="GIV">John</part>
+     <part type="GIV">Paul</part>
+     <part type="FAM">Smith</part>
+     <part type="SFX">Snr</part>
+ </name>
+ <nowiki><!-- To indicate a structured usual person name with title, two forenames, family name and suffix, with a validity date interval --></nowiki>
+ <name use="A">
+     <part type="PFX">Mr</part>
+     <part type="GIV">John</part>
+     <part type="GIV">Paul</part>
+     <part type="FAM">Smith</part>
+     <part type="SFX">Snr</part>
+     <validTime>
+          <low value="19990401"/>
+          <high value="20040331"/>
+     </validTime>
+ </name>
-<.......>
 ===Comparison Notes===
+The primary difference is that the type of the part is no longer indicated in
+the element name, but in the type parameter.
 ----
-==PN (Organization Name)==
+==ON (Organization Name)==
@@ Line 421: / Line 506: @@
       </validTime>
   </name>
+Provenance:
+===UML ITS Equivalents===
+ <nowiki><!-- To indicate an unstructured organization name  --></nowiki>
+ <name><part>Good Health Hospital</part></name>
+ <nowiki><!-- To indicate an unstructured organization name with a validity date interval --></nowiki>
+ <name>
+     <part>Good Health Hospital</part>
+     <validTime>
+          <low value="19990401"/>
+          <high value="20040331"/>
+     </validTime>
+ </name>
+===Comparison Notes===
+The primary difference is that the type of the part is no longer indicated in
+the element name, but in the type parameter.
+----
+== AD (Address)==
+===XML ITS Example===
   <nowiki><!-- To indicate a home address with unstructured address lines  --></nowiki>
@@ Line 460: / Line 574: @@
   </addr>
-Provenance:
+Provenance: UK...?
+===UML ITS Equivalents===
+ <nowiki><!-- To indicate a home address with unstructured address lines  --></nowiki>
+ <addr use="H">
+     <part type="SAL">Hexagon House</part>
+     <part type="SAL">Pynes Hill</part>
+     <part type="SAL">Rydon Lane</part>
+     <part type="SAL">Exeter</part>
+     <part type="SAL">Devon</part>
+     <part type="ZIP">EX2 5SE</part>
+     <part type="KEY">12345678</part>
+ </addr>
+ <nowiki><!-- To indicate a temporary address with unstructured address lines and a description and dates --></nowiki>
+ <addr use="TMP">
+     <part type="SAL">AQUEOUS II</part>
+     <part type="SAL">ASTON CROSS</part>
+     <part type="SAL">ROCKY LANE</part>
+     <part type="SAL">ASTON</part>
+     <part type="SAL">BIRMINGHAM</part>
+     <part type="ZIP">B6 5RQ</part>
+     <part type="KEY">23456789</part>
+     <part type="DESC">Holiday home</part>
+     <useablePeriod>
+        <item>
+          <low value="20040716"/>
+          <high value="20040831"/>
+        </item>
+     </useablePeriod>
+ </addr>
-===UML ITS Generated Example===
+<nowiki> <!-- To indicate a home address with structured address lines --></nowiki>
+ <addr use="H">
+     <part type="BNR">Hexagon House</part>
+     <part type="STR">Pynes Hill</part>
+     <part type="STR">Rydon Lane</part>
+     <part type="CTY">Exeter</part>
+     <part type="CNT">Devon</part>
+     <part type="ZIP">EX2 5SE</part>
+     <part type="KEY">12345678</part>
+ </addr>
-<.......>
 ===Comparison Notes===
+KEY and DESC are UK extensions.
+The primary difference is that the type of the part is no longer indicated in
+the element name, but in the type parameter.
+There is also a difference in the GTS type.
 ----
@@ Line 483: / Line 643: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 503: / Line 663: @@
 Provenance: CfH MIM v6.1.00 Datatypes section
-===UML ITS Generated Example===
+===UML ITS Equivalents===
+ ''<repeatNumber value="1"/>''
+ ''<sequenceNumber nullFlavor="UNK"/>''
-<.......>
 ===Comparison Notes===
+No difference
 ----
@@ Line 523: / Line 688: @@
 Provenance: CfH MIM v6.1.00 Datatypes section
-===UML ITS Generated Example===
+===UML ITS Equivalents===
-<.......>
+ ''<value value="2.3"/>''
+ ''<value nullFlavor="UNK"/>''
 ===Comparison Notes===
+No difference
 ----
@@ Line 540: / Line 709: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 576: / Line 745: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
+ <nowiki><!-- To indicate a percentage for the "value" attribute of an observation class  --></nowiki>
+ <value value="92.55" unit="%"/>
+ <nowiki><!-- To indicate a measured quantity in alternative units of 30 grams --></nowiki>
+ <quantity value="30" unit="gram">
+    <translation value="30" code="258682000" codeSystem="2.16.840.1.113883.2.1.3.2.4.15"><displayName value="gram"/></translation>
+ </quantity>
+ <nowiki><!-- To indicate a counted quantity in alternative units of 100 tablets  --></nowiki>
+ <quantity value="100" unit="1">
+      <translation value="100" code="3319411000001109" codeSystem="2.16.840.1.113883.2.1.3.2.4.15"><displayName value="tablet"/></translation>
+ </quantity>
+ <nowiki><!-- To indicate a counted quantity in arbitrary units --></nowiki>
+ <value value="6" unit="1">
+     <translation value="6">
+          <originalText value="packets each containing 21 tablets of A and 7 tablets of B"/>
+     </translation>
+ </value>
-<.......>
 ===Comparison Notes===
+Differences are in enclosed ED and CD types.
 ----
@@ Line 592: / Line 782: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 609: / Line 799: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 626: / Line 816: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 636: / Line 826: @@
 =Collections=
@@ Line 648: / Line 838: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 665: / Line 855: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 682: / Line 872: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 698: / Line 888: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 715: / Line 905: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 728: / Line 918: @@
 ===XML ITS Example===
   <nowiki><!-- To indicate an effective time of  12:05 on 25/06/2004 --></nowiki>
   <effectiveTime>
       <center value="200406251205"/>
@@ Line 762: / Line 952: @@
 Provenance: CfH MIM v6.1.00 Datatypes section
-===UML ITS Generated Example===
+===UML ITS Equivalents===
-<.......>
+ <nowiki><!-- To indicate an effective time of  12:05 on 25/06/2004 --></nowiki>
+ <effectiveTime>
+     <low value="200406251205"/>
+     <high value="200406251205"/>
+ </effectiveTime>
+ <nowiki><!-- To indicate an effective time between of  12:05 and 12:20 on 25/06/2004  --></nowiki>
+ <effectiveTime>
+     <low value="200406251205"/>
+     <high value="200406251220"/>
+ </effectiveTime>
+ <nowiki><!-- To indicate an effective time after  12:05 on 25/06/2004 --></nowiki>
+ <effectiveTime>
+     <low value="200406251205"/>
+ </effectiveTime>
+ <nowiki><!-- To indicate an effective time before  25/06/2004 --></nowiki>
+ <effectiveTime>
+     <high value="20040625"/>
+ </effectiveTime>
+ <nowiki><!-- To indicate an effective time of one month duration --></nowiki>
+ <effectiveTime>
+     <width xsi:type="PQ" value="1" unit="mo"/>
+ </effectiveTime>
+ <nowiki><!-- To indicate an effective time with a 24 hour duration centred on  15/06/2002  --></nowiki>
+ <effectiveTime>
+     <low value="200206141200"/>
+     <high value="200206151200"/>
+ </effectiveTime>
 ===Comparison Notes===
+Center is banned - have to replace with low and high
+width is a QTY - have to use xsi:type with it.
 ----
@@ Line 779: / Line 1,004: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 789: / Line 1,014: @@
 =Timing Specifications=
 ==PIVL (PeriodicInterval)==
@@ Line 800: / Line 1,025: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 817: / Line 1,042: @@
 Provenance:
-===UML ITS Generated Example===
+===UML ITS Equivalents===
 <.......>
@@ Line 869: / Line 1,094: @@
       </comp>
   </effective_time>
+ Comment from Grahame: does this really say what it claims? Firstly, a couple of technical issues,
+   PIVL_TS not PIVLS_TS, and the timestamp should be 200107010800 not 2001-07-01T0800. But it's a
+   very complex way to say the concept.
   <! To indicate every 6 hours at 00:00, 06:00, 12:00 and 18:00 between March 29 and April 8, 2004
@@ Line 912: / Line 1,141: @@
 Provenance: Effective Timing Tool Created By: Rob Landry, Todd Kinnee, Mike Cleghorn
-===UML ITS Generated Example===
+===UML ITS Equivalents===
+Actually, these ones can't be done right now - need to do some work with GTS.
-<.......>
 ===Comparison Notes===

Difference between revisions of "Datatype Examples Collection area"

Revision as of 05:53, 13 March 2007

Contents

Basic Data Types

BL (Boolean)

XML ITS Example

UML ITS Equivalents

Comparison Notes

BN (Boolean Non Null)

XML ITS Example

UML ITS Equivalents

Comparison Notes

Text And Content Data Types

ED (Encapsulated Data)

XML ITS Example

UML ITS Equivalents

Comparison Notes

ST (Character String)

XML ITS Example

UML ITS Equivalents

Comparison Notes

SC (Coded String)

XML ITS Example

UML ITS Equivalents

Comparison Notes

Coded Data Types

CD (Concept Descriptor)

XML ITS Example

UML ITS Equivalents

Comparison Notes

CE (Coded With Equivalents)

XML ITS Example

UML ITS Equivalents

Comparison Notes

CO (Coded Ordinal)

XML ITS Example

UML ITS Equivalents

Comparison Notes

CS (Coded Simple Value)

XML ITS Example

UML ITS Equivalents

Comparison Notes

Miscellaneous Data Types

II (Instance Identifier)

XML ITS Example

UML ITS Equivalents

Comparison Notes

TEL (Telecommunication Address)

XML ITS Example

UML ITS Equivalents

Comparison Notes

Names and Addresses

ADXP (Address Part)

XML ITS Example

UML ITS Equivalents

Comparison Notes

AD (Address)

XML ITS Example

UML ITS Equivalents

Comparison Notes

ENXP (Entity Name Part)

XML ITS Example

UML ITS Equivalents

Comparison Notes

EN (Entity Name)

XML ITS Example

UML ITS Equivalents

Comparison Notes

TN (Trivial Name)

XML ITS Example

UML ITS Equivalents

Comparison Notes

PN (Person Name)

XML ITS Example

UML ITS Equivalents

Comparison Notes

ON (Organization Name)

XML ITS Example

UML ITS Equivalents

Comparison Notes