mlhim-specs-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 121
committer: Timothy W. Cook <timothywayne.cook@xxxxxxxxx>
branch nick: mlhim-specs
timestamp: Fri 2011-04-29 07:21:47 -0500
message:
  Inserted documentation for all support.xsd complexTypes. See https://bugs.launchpad.net/mlhim-specs/+bug/771266
modified:
  schemas/support.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/support.xsd'
--- schemas/support.xsd	2011-04-28 15:25:40 +0000
+++ schemas/support.xsd	2011-04-29 12:21:47 +0000
@@ -4,7 +4,7 @@
 	<xs:complexType abstract="true" name="ExceptionalValue">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Subclasses are used to indicate why a value is missing (Null) or is outside a measurable range.
 	</xs:documentation>
 	</xs:annotation>
 		<xs:sequence>
@@ -16,7 +16,8 @@
 	<xs:complexType name="NI">
 	<xs:annotation>
 	<xs:documentation>
-	
+	The value is exceptional (missing, incomplete, improper). No information is available as to the reason 
+	for being an exceptional value is provided. This is the most general and default value.
 	</xs:documentation>
 	</xs:annotation>
 	  <xs:complexContent>
@@ -27,7 +28,8 @@
 	<xs:complexType name="MSK">
 	<xs:annotation>
 	<xs:documentation>
-	
+	There is inforamtion 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 method of obtaining the information.	
 	</xs:documentation>
 	</xs:annotation>
 	  <xs:complexContent>
@@ -38,7 +40,7 @@
 	<xs:complexType name="NA">
 	<xs:annotation>
 	<xs:documentation>
-	
+	No proper value is applicable in this context e.g., last menstrual period fora male.
 	</xs:documentation>
 	</xs:annotation>
 	  <xs:complexContent>
@@ -49,51 +51,54 @@
 	<xs:complexType name="UNK">
 	<xs:annotation>
 	<xs:documentation>
-	
-	</xs:documentation>
-	</xs:annotation>
-	  <xs:complexContent>
-	    <xs:extension base="mlhim2:NI"></xs:extension>
-	  </xs:complexContent>
-	</xs:complexType> 
-	
-	<xs:complexType base="NI" name="INV">
-	<xs:annotation>
-	<xs:documentation>
-	
-	</xs:documentation>
-	</xs:annotation>
-	  <xs:complexContent>
-	    <xs:extension base="mlhim2:NI"></xs:extension>
-	  </xs:complexContent>
-	</xs:complexType> 
-	
-	<xs:complexType base="INV" name="DER">
-	<xs:annotation>
-	<xs:documentation>
-	
-	</xs:documentation>
-	</xs:annotation>
-	  <xs:complexContent>
-	    <xs:extension base="mlhim2:NI"></xs:extension>
-	  </xs:complexContent>
-	</xs:complexType> 
-	
-	<xs:complexType base="INV" name="UNC">
-	<xs:annotation>
-	<xs:documentation>
-	
-	</xs:documentation>
-	</xs:annotation>
-	  <xs:complexContent>
-	    <xs:extension base="mlhim2:NI"></xs:extension>
+	A proper value is applicable, but not known
+	</xs:documentation>
+	</xs:annotation>
+	  <xs:complexContent>
+	    <xs:extension base="mlhim2:NI"></xs:extension>
+	  </xs:complexContent>
+	</xs:complexType> 
+	
+	<xs:complexType name="INV">
+	<xs:annotation>
+	<xs:documentation>
+      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:complexContent>
+	    <xs:extension base="mlhim2:NI"></xs:extension>
+	  </xs:complexContent>
+	</xs:complexType> 
+	
+	<xs:complexType  name="DER">
+	<xs:annotation>
+	<xs:documentation>
+	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:complexContent>
+	    <xs:extension base="mlhim2:INV"></xs:extension>
+	  </xs:complexContent>
+	</xs:complexType> 
+	
+	<xs:complexType name="UNC">
+	<xs:annotation>
+	<xs:documentation>
+	No attempt has been made to encode the information correctly but the raw source information is represented, 
+	usually in original text.
+	</xs:documentation>
+	</xs:annotation>
+	  <xs:complexContent>
+	    <xs:extension base="mlhim2:INV"></xs:extension>
 	  </xs:complexContent>
 	</xs:complexType> 
 	
 	<xs:complexType name="OTH">
 	<xs:annotation>
 	<xs:documentation>
-	
+	The actual value is not a member of the permitted data values in the constrained value domain of a variable. 
+	(e.g., concept not provided by code system).
 	</xs:documentation>
 	</xs:annotation>
 	  <xs:complexContent>
@@ -104,7 +109,7 @@
 	<xs:complexType name="ASKU">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Information was sought but not found (e.g., patient was asked but did not know).
 	</xs:documentation>
 	</xs:annotation>
 	  <xs:complexContent>
@@ -115,7 +120,7 @@
 	<xs:complexType  name="NASK">
 	<xs:annotation>
 	<xs:documentation>
-	
+	This information has not been sought (e.g., patient was not asked).
 	</xs:documentation>
 	</xs:annotation>
 	  <xs:complexContent>
@@ -126,7 +131,8 @@
 	<xs:complexType name="QS">
 	<xs:annotation>
 	<xs:documentation>
-	
+	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:complexContent>
@@ -137,7 +143,7 @@
 	<xs:complexType name="TRC">
 	<xs:annotation>
 	<xs:documentation>
-	
+	The content is greater than zero but too small to be quantified.
 	</xs:documentation>
 	</xs:annotation>
 	  <xs:complexContent>
@@ -148,7 +154,7 @@
 	<xs:complexType name="NINF">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Negative infinity of numbers
 	</xs:documentation>
 	</xs:annotation>
 	  <xs:complexContent>
@@ -159,7 +165,7 @@
 	<xs:complexType name="PINF">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Positive infinity of numbers
 	</xs:documentation>
 	</xs:annotation>
 	  <xs:complexContent>
@@ -170,7 +176,7 @@
 	<xs:complexType name="NAV">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Information is unavailable at this time but is expected that it will be available later.
 	</xs:documentation>
 	</xs:annotation>
 	  <xs:complexContent>
@@ -181,7 +187,10 @@
 	<xs:complexType name="ObjectRef">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Class describing a reference to another object, which may exist locally or be maintained outside the current namespace, 
+	e.g. in another service. Services are usually external, e.g. available in a LAN (including on the same host) or the internet via 
+	Corba, SOAP, or some other distributed protocol. However, in small systems they may be part of the same executable as the 
+	data containing the Id.
 	</xs:documentation>
 	</xs:annotation>
 		<xs:sequence>
@@ -194,7 +203,10 @@
 	<xs:complexType name="EntityRef">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Identifier for entities in an identity service. There are typically a number of subtypes of the Entity class, including Person, 
+	Organization, Device, etc. Abstract supertypes are allowed if the referenced object is of a type not known by the current 
+	implementation of this class. For example, if the entity model is changed by the addition of a new subtype, valid EntityRefs 
+	can still be constructed to them.
 	</xs:documentation>
 	</xs:annotation>
 	<xs:complexContent>