mlhim-specs-dev team mailing list archive
-
mlhim-specs-dev team
-
Mailing list archive
-
Message #00172
[Branch ~mlhim-specs-dev/mlhim-specs/main] Rev 133: Working on Element documentation strings. Completed datatypes.xsd Bug #771266
------------------------------------------------------------
revno: 133
committer: Timothy W. Cook <timothywayne.cook@xxxxxxxxx>
branch nick: mlhim-specs
timestamp: Sat 2011-04-30 21:35:50 -0500
message:
Working on Element documentation strings. Completed datatypes.xsd Bug #771266
modified:
schemas/datatypes.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/datatypes.xsd'
--- schemas/datatypes.xsd 2011-04-30 21:22:48 +0000
+++ schemas/datatypes.xsd 2011-05-01 02:35:50 +0000
@@ -11,15 +11,15 @@
<xs:sequence>
<xs:element name="valid_time_begin" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>If present this must be a valid datetime string including timezone</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="valid_time_end" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>If present this must be a valid datetime string including timezone</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="ev" maxOccurs="1" minOccurs="0" type="mlhim2:ExceptionalValue">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>The exceptional value. Often referred to as Null Flavour. </xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
@@ -35,15 +35,15 @@
<xs:sequence>
<xs:element name="uuid" maxOccurs="1" minOccurs="1" type="xs:string" nillable="false">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>UUID in order to track translations.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="language" maxOccurs="1" minOccurs="0" type="xs:string" nillable="true">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Optional indicator of the localised language in which the value is written. Coded IAW IETF RFC 5646. http://tools.ietf.org/html/rfc5646 Only used when the text object is in a different language from the enclosing CCD.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="dv" maxOccurs="1" minOccurs="0" type="xs:string" nillable="true">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Displayable rendition of the item.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -62,15 +62,15 @@
<xs:sequence>
<xs:element name="code_string" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context. In the NLM Metathesarus this would be the Concept Unique Identifier (CUI).</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="terminology_name" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Full Source Name from NLM Metathesarus; or similar.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="terminology_abbrev" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Version Source Abbreviation (VSAB) from NLM Metathesarus; or similar </xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -89,15 +89,15 @@
<xs:sequence>
<xs:element name="issuer" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Authority which issues the kind of id used in the id field of this object.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="assigner" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Organisation that assigned the id to the item being identified.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="name" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>The identifier common name, such as “Driver's License†or “SSNâ€.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -118,7 +118,7 @@
<xs:sequence>
<xs:element name="dv" maxOccurs="1" minOccurs="0" type="xs:string" nillable="true">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>A string indicating a boolean type result according to the rules described below. Boolean True values are represented by any one of these strings: ["True","1","T"]. Boolean False values are represented by any one of these strings: ["False","0","F"]. Note that the strings are not case-sensitive; i.e. "T" == "t" and "TRUE" == "t". The empty string; "" represents a Void or Null value, in which case the ev attribute cannot be empty. </xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -140,7 +140,7 @@
<xs:sequence>
<xs:element name="dv" maxOccurs="1" minOccurs="0" type="xs:anyURI" nillable="true">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Value of URI as a String.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -160,7 +160,7 @@
<xs:sequence>
<xs:element name="items" maxOccurs="unbounded" minOccurs="0" type="mlhim2:DvText" nillable="false">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>List of Items making up the paragraph, each of which is a text item. The items should be displayed in sequential order from smallest index number to highest index number.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -178,15 +178,15 @@
<xs:sequence>
<xs:element name="size" maxOccurs="1" minOccurs="1" type="xs:integer">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Original size in bytes of unencoded encapsulated data. I.e. encodings such as base64, hexadecimal etc do not change the value of this attribute.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="charset" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Name of character encoding scheme in which this value is encoded. Coded from MLHIM Code Set “character setsâ€. Unicode is the default assumption in MLHIM, with UTF-8 being the assumed encoding. This attribute allows for variations from these assumptions.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="language" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Optional indicator of the localised language in which the value is written. Coded IAW IETF RFC 5646. http://tools.ietf.org/html/rfc5646 Only used when the text object is in a different language from the enclosing CCD.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -206,11 +206,11 @@
<xs:sequence>
<xs:element name="dv" maxOccurs="1" minOccurs="0" type="xs:string" nillable="true">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>The string, which may validly be empty in some syntaxes</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="formalism" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>name of the formalism, e.g. "MAG 1.0", “GLIF 1.0â€, “PROforma†etc. </xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -229,35 +229,35 @@
<xs:sequence>
<xs:element name="dv" maxOccurs="1" minOccurs="0" type="xs:base64Binary" nillable="true">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>The actual data found at uri, if supplied inline</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="mime_type" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Content type as defined in RFC2045 and RFC 2046</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="compression_algorithm" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Compression type, a coded value from the MLHIM “Integrity check†code set. Void means no compression.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="integrity_check" maxOccurs="1" minOccurs="0" type="xs:base64Binary" nillable="true">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Binary cryptographic integrity checksum</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="integrity_check_algorithm" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Type of integrity check, a coded value from the MLHIM “Integrity check†code set.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="thumbnail" maxOccurs="1" minOccurs="0" type="xs:base64Binary" nillable="true">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>The thumbnail for this item, if one exists; mainly for graphics formats.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="uri" maxOccurs="1" minOccurs="0" type="mlhim2:DvURI" nillable="true">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>URI reference to electronic information stored outside the record as a file, database entry etc, if supplied as a reference.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="alt_text" maxOccurs="1" minOccurs="0" type="xs:string" nillable="true">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Text to display in lieu of multimedia display/replay</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -275,28 +275,28 @@
<xs:extension base="mlhim2:DvAny">
<xs:sequence>
- <xs:element name="lower" maxOccurs="1" minOccurs="1" type="mlhim2:DvOrdered">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:element name="lower" maxOccurs="1" minOccurs="0" type="mlhim2:DvOrdered">
+ <xs:annotation><xs:documentation>Lower boundary.</xs:documentation></xs:annotation>
</xs:element>
- <xs:element name="upper" maxOccurs="1" minOccurs="1" type="mlhim2:DvOrdered">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:element name="upper" maxOccurs="1" minOccurs="0" type="mlhim2:DvOrdered">
+ <xs:annotation><xs:documentation>Upper boundary.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="lower_included" maxOccurs="1" minOccurs="1" type="xs:boolean">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Is the lower boundary included in the interval?</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="upper_included" maxOccurs="1" minOccurs="1" type="xs:boolean">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Is the upper boundary included in the interval?</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="lower_unbounded" maxOccurs="1" minOccurs="1" type="xs:boolean">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>If True, there is no lower boundary</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="upper_unbounded" maxOccurs="1" minOccurs="1" type="xs:boolean">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>If True, there is no upper boundary</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -316,11 +316,11 @@
<xs:sequence>
<xs:element name="definition" maxOccurs="1" minOccurs="1" type="mlhim2:DvText">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Term whose value indicates the meaning of this range, e.g. “normalâ€, “criticalâ€, “therapeutic†etc.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="data_range" maxOccurs="1" minOccurs="1" type="mlhim2:DvInterval">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>The data range for this meaning.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -342,15 +342,15 @@
<xs:sequence>
<xs:element name="normal_range" maxOccurs="1" minOccurs="0" type="mlhim2:DvInterval">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Optional normal range.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="other_reference_ranges" maxOccurs="unbounded" minOccurs="0" type="mlhim2:ReferenceRange">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>List of ReferenceRanges. Optional tagged other reference ranges for this value in its particular measurement context.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="normal_status" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Optional normal status indicator of value with respect to normal range for this value. Often included by lab, even if the normal range itself is not included. Coded by ordinals in series HHH, HH, H, (nothing), L, LL, LLL, etc.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -374,11 +374,11 @@
<xs:sequence>
<xs:element name="dv" maxOccurs="1" minOccurs="0" type="xs:integer">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Value in ordered enumeration of values. Any integer value can be used.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="symbol" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Coded textual representation of this value in the enumeration, which may be strings made from “+†symbols, or other enumerations of terms such as “mildâ€, “moderateâ€, “severeâ€, or even the same number series as the values, e.g. “1â€, “2â€, “3â€. Codes come from archetype.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -397,19 +397,31 @@
<xs:sequence>
<xs:element name="magnitude" maxOccurs="1" minOccurs="0" type="xs:long">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Numeric value of the quantity in canonical (i.e. single value) form. Implemented as constant, function or attribute in subtypes as appropriate. The type Ordered_numeric is mapped to the available appropriate type in each implementation technology.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="magnitude_status" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation><!--Optional status of magnitude with values:
+•
+“=†: magnitude is a point value
+•
+“<“ : value is < magnitude
+•
+“>†: value is > magnitude
+•
+“<=†: value is <= magnitude
+•
+“>=†: value is >= magnitude
+•
+“~†: value is approximately magnitude If not present, meaning is “=â€.--></xs:documentation></xs:annotation>
</xs:element>
<xs:element name="error" maxOccurs="1" minOccurs="1" type="xs:long">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Error margin of measurement, indicating error in the recording method or instrument (+/- %). Implemented in subtypes. A logical value of 0 indicates 100% accuracy, i.e. no error.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="accuracy_unknown" maxOccurs="1" minOccurs="1" type="xs:boolean">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>True if accuracy is not known, e.g. due to not being recorded or discernable.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -430,7 +442,7 @@
<xs:sequence>
<xs:element name="dv" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation><!--ISO8601:2004 date/time string including UTC offset. <date>T<time>Z --></xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -451,11 +463,11 @@
<xs:sequence>
<xs:element name="units" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Stringified units, expressed in UCUM unit syntax, e.g. "kg/m2", “mm[Hg]", "ms-1", "km/h". Implemented accordingly in subtypes.</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="precision" maxOccurs="1" minOccurs="0" type="xs:integer">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Precision to which the value of the quantity is expressed, in terms of number of decimal places. The value 0 implies an integral quantity. The value -1 implies no limit, i.e. any number of decimal places.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -474,7 +486,7 @@
<xs:sequence>
<xs:element name="count" maxOccurs="1" minOccurs="0" type="xs:integer">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Number of items counted.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -521,7 +533,7 @@
<xs:sequence>
<xs:element name="dv" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>The duration in the form of a string.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -539,11 +551,11 @@
<xs:sequence>
<xs:element name="numerator" maxOccurs="1" minOccurs="0" type="xs:long">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>numerator of ratio</xs:documentation></xs:annotation>
</xs:element>
<xs:element name="denominator" maxOccurs="1" minOccurs="0" type="xs:long">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>denominator of ratio</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -563,7 +575,11 @@
<xs:sequence>
<xs:element name="rate_type" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Indicates semantic type of coefficient:
+pk_coefficient = coefficient type. Numerator and denominator may be any value.
+pk_unitary = Denominator must be 1.
+pk_per10^n = Denominator is 10^2, numerator is understood as a real number divided by an exponent of 10 (10^n).
+pk_fraction = Numerator and denominator are real numbers, allowing rational and irrational fractions, and the presentation method uses a slash, e.g. “1/2â€; if the numerator is greater than the denominator, e.g. n=3, d=2, the presentation is “1 1/2â€.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
@@ -587,7 +603,11 @@
<xs:sequence>
<xs:element name="proportion_type" maxOccurs="1" minOccurs="0" type="xs:string">
- <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+ <xs:annotation><xs:documentation>Indicates semantic type of proportion:
+pk_proportion = proportion type. Numerator and denominator may be any value.
+pk_unitary = Denominator must be 1.
+pk_per10^n = Denominator is 10^2, numerator is understood as a real number divided by an exponent of 10 (10^n).
+pk_fraction = Numerator and denominator are real numbers, allowing rational and irrational fractions, and the presentation method uses a slash, e.g. “1/2â€; if the numerator is greater than the denominator, e.g. n=3, d=2, the presentation is “1 1/2â€.</xs:documentation></xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
