mlhim-specs-dev team mailing list archive

Thread
Date

[Branch ~mlhim-specs-dev/mlhim-specs/main] Rev 314: Improved documentation.

To: MLHIM Specifications Developers <mlhim-specs-dev@xxxxxxxxxxxxxxxxxxx>
From: noreply@xxxxxxxxxxxxx
Date: Sat, 27 Oct 2012 22:14:20 -0000
Reply-to: noreply@xxxxxxxxxxxxx
Sender: bounces@xxxxxxxxxxxxx

------------------------------------------------------------
revno: 314
committer: Timothy W. Cook <timothywayne.cook@xxxxxxxxx>
branch nick: mlhim-specs
timestamp: Sat 2012-10-27 20:11:53 -0200
message:
  Improved documentation.
modified:
  schemas/mlhim2.pdf
  schemas/mlhim2.xsd


--
lp:mlhim-specs
https://code.launchpad.net/~mlhim-specs-dev/mlhim-specs/main

Your team MLHIM Specifications Developers is subscribed to branch lp:mlhim-specs.
To unsubscribe from this branch go to https://code.launchpad.net/~mlhim-specs-dev/mlhim-specs/main/+edit-subscription

=== modified file 'schemas/mlhim2.pdf'
Binary files schemas/mlhim2.pdf	2012-10-25 07:04:18 +0000 and schemas/mlhim2.pdf	2012-10-27 22:11:53 +0000 differ
=== modified file 'schemas/mlhim2.xsd'
--- schemas/mlhim2.xsd	2012-10-25 07:04:18 +0000
+++ schemas/mlhim2.xsd	2012-10-27 22:11:53 +0000
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"; xmlns:mlhim2="http://www.mlhim.org/xmlns/mlhim2/2_4_0";
-attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://www.mlhim.org/xmlns/mlhim2/2_4_0";
-version="2.4.0">
+attributeFormDefault="qualified" elementFormDefault="qualified"
+targetNamespace="http://www.mlhim.org/xmlns/mlhim2/2_4_0"; version="2.4.0">
 
 <!--Datatypes package-->
 
@@ -474,8 +474,8 @@
 <xs:annotation>
 <xs:documentation>Stringified units, expressed in UCUM unit syn- tax, e.g. "kg/m2", “mm[Hg]", "ms-1", "km/h". NOTICE!
 The type is DvCodedString and it must be completed correctly. Entering a string as a 'value' here will cause the CCD to
-be invalid. UOM codes can be found: http://aurora.regenstrief.org/~ucum/ucum.html Also see: http://www.unitsofmeasure.org/ Also available in
-other terminologies such as SNOMEDCT. </xs:documentation>
+be invalid. UOM codes can be found: http://aurora.regenstrief.org/~ucum/ucum.html Also see:
+http://www.unitsofmeasure.org/ Also available in other terminologies such as SNOMEDCT. </xs:documentation>
 </xs:annotation>
 </xs:element>
 </xs:sequence>
@@ -498,31 +498,19 @@
 <xs:complexContent>
 <xs:extension base="mlhim2:DvQuantifiedType">
 <xs:sequence>
-<xs:element maxOccurs="1" minOccurs="1" name="ratio-type">
-<xs:annotation>
-<xs:documentation>Indicates semantic type of ratio.</xs:documentation>
-</xs:annotation>
-<xs:simpleType>
-<xs:restriction base="xs:string">
-<xs:enumeration value="ratio">
-<xs:annotation>
-<xs:documentation>Ratio: a relationship between two numbers. </xs:documentation>
-</xs:annotation>
-</xs:enumeration>
-<xs:enumeration value="proportion">
-<xs:annotation>
-<xs:documentation>Proportion: a relationship between two numbers where there is a bi-univocal relationship between the
-numerator and the denominator (the numerator is contained in the denominator) </xs:documentation>
-</xs:annotation>
-</xs:enumeration>
-<xs:enumeration value="rate">
-<xs:annotation>
-<xs:documentation>Rate: a relationship between two numbers where there is not a bi-univocal relationship between the
-numerator and the denominator (the numerator is not contained in the denominator) </xs:documentation>
-</xs:annotation>
-</xs:enumeration>
-</xs:restriction>
-</xs:simpleType>
+<xs:element maxOccurs="1" minOccurs="1" name="ratio-type" type="xs:string">
+<xs:annotation>
+<xs:documentation>
+Indicates semantic type of ratio  must be set as fixed to one of the below strings in CCDs.
+ratio = a relationship between two numbers.
+
+proportion = a relationship between two numbers where there is a bi-univocal relationship between the
+numerator and the denominator (the numerator is contained in the denominator)
+
+rate = a relationship between two numbers where there is not a bi-univocal relationship between the
+numerator and the denominator (the numerator is not contained in the denominator) 
+</xs:documentation>
+</xs:annotation>
 </xs:element>
 <xs:element maxOccurs="1" minOccurs="1" name="numerator" type="xs:decimal">
 <xs:annotation>
@@ -550,14 +538,13 @@
 </xs:extension>
 </xs:complexContent>
 </xs:complexType>
-<xs:element name="DvRatio" substitutionGroup="mlhim2:DvQuantified mlhim2:DvOrdered mlhim2:DvAny"
-type="mlhim2:DvRatioType"/>
+<xs:element name="DvRatio" substitutionGroup="mlhim2:DvQuantified mlhim2:DvOrdered mlhim2:DvAny" type="mlhim2:DvRatioType"/>
 
 <xs:complexType name="DvIntervalType">
 <xs:annotation>
 <xs:documentation>Generic class defining an interval (i.e. range) of a comparable type. An interval is a contiguous
-subrange of a comparable base type. Used to define intervals of dates, times, quantities Whose units of measure match and datatypes
-are the same and are ordered. </xs:documentation>
+subrange of a comparable base type. Used to define intervals of dates, times, quantities Whose units of measure match
+and datatypes are the same and are ordered. </xs:documentation>
 </xs:annotation>
 <xs:complexContent>
 <xs:extension base="mlhim2:DvAnyType">
@@ -1128,8 +1115,9 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>No Information : The value is exceptional (missing, omitted, incomplete, improper). No information as to the reason for being an exceptional value is provided. This is the most general exceptional value. It is also the default exceptional value 
-</xs:documentation>
+<xs:documentation>No Information : The value is exceptional (missing, omitted, incomplete, improper). No information as
+to the reason for being an exceptional value is provided. This is the most general exceptional value. It is also the
+default exceptional value </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="No Information" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1146,8 +1134,11 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Masked : There is information on this item available but it has not been provided by the sender due to security, privacy or other reasons. There may be an alternate mechanism for gaining access to this information.  Warning: Using this exceptional value does provide information that may be a breach of confidentiality, even though no detail data is provided. Its primary purpose is for those circumstances where it is necessary to inform the receiver that the information does exist without providing any detail 
-</xs:documentation>
+<xs:documentation>Masked : There is information on this item available but it has not been provided by the sender due to
+security, privacy or other reasons. There may be an alternate mechanism for gaining access to this information. Warning:
+Using this exceptional value does provide information that may be a breach of confidentiality, even though no detail
+data is provided. Its primary purpose is for those circumstances where it is necessary to inform the receiver that the
+information does exist without providing any detail </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Masked" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1164,8 +1155,8 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Invalid : The value as represented in the instance is not a member of the set of permitted data values in the constrained  value domain of a variable.
-</xs:documentation>
+<xs:documentation>Invalid : The value as represented in the instance is not a member of the set of permitted data values
+in the constrained value domain of a variable. </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Invalid" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1183,8 +1174,8 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Derived : An actual value may exist, but it must be derived from the provided information; usually an expression is provided directly.
-</xs:documentation>
+<xs:documentation>Derived : An actual value may exist, but it must be derived from the provided information; usually an
+expression is provided directly. </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Derived" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1201,8 +1192,8 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Unencoded : No attempt has been made to encode the information correctly but the raw source information is represented, usually in free text
-</xs:documentation>
+<xs:documentation>Unencoded : No attempt has been made to encode the information correctly but the raw source
+information is represented, usually in free text </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Unencoded" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1219,8 +1210,8 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Other : The actual value is not a member of the permitted data values in the variable. (e.g., when the value of the variable is not  by the coding system) 
-</xs:documentation>
+<xs:documentation>Other : The actual value is not a member of the permitted data values in the variable. (e.g., when the
+value of the variable is not by the coding system) </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Other" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1237,8 +1228,7 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Negative Infinity : Negative infinity of numbers
-</xs:documentation>
+<xs:documentation>Negative Infinity : Negative infinity of numbers </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Negative Infinity" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1254,8 +1244,7 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Positive Infinity : Positive infinity of numbers
-</xs:documentation>
+<xs:documentation>Positive Infinity : Positive infinity of numbers </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Positive Infinity" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1270,8 +1259,7 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Unknown : A proper value is applicable, but not known
-</xs:documentation>
+<xs:documentation>Unknown : A proper value is applicable, but not known </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Unknown" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1287,8 +1275,8 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Asked and Refused : Information was sought but refused to be provided (e.g., patient was asked but refused to answer)
-</xs:documentation>
+<xs:documentation>Asked and Refused : Information was sought but refused to be provided (e.g., patient was asked but
+refused to answer) </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Asked and Refused" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1304,8 +1292,7 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Not Asked : This information has not been sought (e.g., patient was not asked)
-</xs:documentation>
+<xs:documentation>Not Asked : This information has not been sought (e.g., patient was not asked) </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Not Asked" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1321,8 +1308,9 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Sufficient Quantity : The specific quantity is not known, but is known to non-zero and it is not specified because it makes up the bulk of the material; Add 10mg of ingredient X, 50mg of ingredient Y and sufficient quantity of water to 100mL.
-</xs:documentation>
+<xs:documentation>Sufficient Quantity : The specific quantity is not known, but is known to non-zero and it is not
+specified because it makes up the bulk of the material; Add 10mg of ingredient X, 50mg of ingredient Y and sufficient
+quantity of water to 100mL. </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Sufficient Quantity" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1339,8 +1327,7 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Trace : The content is greater or less than zero but too small to be quantified.
-</xs:documentation>
+<xs:documentation>Trace : The content is greater or less than zero but too small to be quantified. </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Trace" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1373,8 +1360,8 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Not Available : Information is unavailable at this time but is expected that it will be available later.
-</xs:documentation>
+<xs:documentation>Not Available : Information is unavailable at this time but is expected that it will be available
+later. </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Not Available" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1390,8 +1377,8 @@
 <xs:complexContent>
 <xs:restriction base="mlhim2:ExceptionalValueType">
 <xs:annotation>
-<xs:documentation>Not Applicable : No proper value is applicable in this context e.g.,the number of cigarrettes smoked per day by a non-smoker subject.
-</xs:documentation>
+<xs:documentation>Not Applicable : No proper value is applicable in this context e.g.,the number of cigarrettes smoked
+per day by a non-smoker subject. </xs:documentation>
 </xs:annotation>
 <xs:sequence>
 <xs:element fixed="Not Applicable" maxOccurs="1" minOccurs="1" name="ev-name" type="xs:string"/>
@@ -1416,7 +1403,10 @@
 <xs:sequence>
 <xs:element maxOccurs="1" minOccurs="0" name="annotation" type="xs:string">
 <xs:annotation>
-<xs:documentation>Optional semantic annotation in RDF.</xs:documentation>
+<xs:documentation>Optional semantic annotation in RDF. A fixed name, note comment can be included to be expressed in the
+instance documents if desired. In a CCD, one of more rdf: attributes can be included as semantic links to controlled
+vocabularies. This element may be depricated in future versions in preference to placing rdf directly on the data-name
+element of DvAny subtypes.</xs:documentation>
 </xs:annotation>
 </xs:element>
 </xs:sequence>
@@ -1627,7 +1617,8 @@
 <xs:extension base="mlhim2:EntryType"/>
 </xs:complexContent>
 </xs:complexType>
-<xs:element name="DemographicEntry" substitutionGroup="mlhim2:Entry mlhim2:Definition" type="mlhim2:DemographicEntryType"/>
+<xs:element name="DemographicEntry" substitutionGroup="mlhim2:Entry mlhim2:Definition"
+type="mlhim2:DemographicEntryType"/>
 
 
 <!--CCD / constraint model -->