mlhim-specs-dev team mailing list archive
-
mlhim-specs-dev team
-
Mailing list archive
-
Message #00148
[Branch ~mlhim-specs-dev/mlhim-specs/main] Rev 117: Inserted documentation for all datatypes.xsd complexTypes. See https://bugs.launchpad.net/mlhim-s...
------------------------------------------------------------
revno: 117
committer: Timothy W. Cook <timothywayne.cook@xxxxxxxxx>
branch nick: mlhim-specs
timestamp: Thu 2011-04-28 17:26:01 -0500
message:
Inserted documentation for all datatypes.xsd complexTypes. See https://bugs.launchpad.net/mlhim-specs/+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-28 15:25:40 +0000
+++ schemas/datatypes.xsd 2011-04-28 22:26:01 +0000
@@ -5,7 +5,7 @@
<xs:complexType name="DvAny" abstract="true">
<xs:annotation>
<xs:documentation>
-
+ Serves as a common ancestor of all datatypes in MLHIM models.
</xs:documentation>
</xs:annotation>
<xs:sequence>
@@ -18,7 +18,7 @@
<xs:complexType name="DvText" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ A text item, which may contain any amount of legal characters arranged as e.g. words, sentences etc. as its data value (dv)
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -35,7 +35,8 @@
<xs:complexType name="DvCodedText" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ A text item whose dv attribute must be the long name or description from a controlled terminology, the key (i.e. the 'code')
+ of which is the code_string attribute.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -52,7 +53,8 @@
<xs:complexType name="DvIdentifier" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ Type for representing identifiers of real-world entities. Typical identifiers include: drivers licence number,
+ social security number, veterans affairs number, prescription id, order id, and so on.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -69,7 +71,10 @@
<xs:complexType name="DvBoolean" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ Items which are truly boolean data, such as true/false or yes/no answers. Use for such data, it is important to devise
+ the meanings (usually questions in subjective data) carefully, so that the only allowed results are in fact true or false.
+ Potential MisUse:Â The DvBoolean class should not be used as a replacement for naively modelled enumerated types such
+ as male/female etc. Such values should be coded, and in any case the enumeration often has more than two values.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -84,7 +89,11 @@
<xs:complexType name="DvURI" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ A reference to an object which conforms to the Universal Resource Identifier (URI) standard, as defined by W3C RFC 2936.
+ See "Universal Resource Identifiers in WWW" by Tim Berners-Lee at http://www.ietf.org/rfc/rfc2396.txt. This is a World-Wide
+ Web RFC for global identification of resources. See http://www.w3.org/Addressing for a starting point on URIs.
+ See http://www.ietf.org/rfc/rfc2806.txt for new URI types like telephone, fax and modem numbers. Enables external resources
+ to be referenced from within the content of the EHR. A number of functions return the logical subparts of the URI string.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -99,7 +108,9 @@
<xs:complexType name="DvParagraph" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ A logical composite text value consisting of a series of DvTexts, i.e. plain or coded text to form a larger tract of prose,
+ which may be interpreted for display purposes as a paragraph. DvParagraph is the standard way for constructing longer
+ text items in summaries, reports and so on.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -114,7 +125,7 @@
<xs:complexType name="DvEncapsulated" abstract="true">
<xs:annotation>
<xs:documentation>
-
+ Abstract class defining the common meta-data of all types of encapsulated data.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -131,7 +142,9 @@
<xs:complexType name="DvParsable" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ Encapsulated data expressed as a parsable String. The internal model of the data item is not described in the MLHIM
+ model in common with other encapsulated types, but in this case, the form of the data is assumed to be plaintext, rather
+ than compressed or other types of large binary data.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -147,7 +160,8 @@
<xs:complexType name="DvMultimedia" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ A specialisation of DvEncapsulated for audiovisual and biosignal types. Includes further metadata relating to multimedia
+ types which are not applicable to other subtypes of DvEncapsulated.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -169,7 +183,8 @@
<xs:complexType name="DvInterval" abstract="false">
<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 match) and so on.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -189,7 +204,9 @@
<xs:complexType name="ReferenceRange" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ Defines a named range to be associated with any Ordered datum. Each such range is particular to the patient and context,
+ e.g. sex, age, and any other factor which affects ranges. May be used to represent normal, therapeutic, dangerous,
+ critical etc ranges.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -205,7 +222,11 @@
<xs:complexType name="DvOrdered" abstract="true">
<xs:annotation>
<xs:documentation>
-
+ Abstract class defining the concept of ordered values, which includes ordinals as well as true quantities. It defines the
+ functions < and is_strictly_comparable_to, the latter of which must evaluate to True for instances being compared with
+ the ‘<’ function, or used as limits in the DvInterval class. Data value types which are to be used as limits must inherit from
+ this class, and implement the function is_strictly_comparable_to to ensure that instances compare meaningfully.
+ For example, instances of DvQuantity can only be compared if they measure the same kind of physical quantity.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -222,7 +243,13 @@
<xs:complexType name="DvOrdinal" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ Models rankings and scores, e.g. pain, Apgar values, etc, where there is a) implied ordering, b) no implication that the distance
+ between each value is constant, and c) the total number of values is finite. Note that although the term ‘ordinal’ in mathematics
+ means natural numbers only, here any integer is allowed, since negative and zero values are often used by medical professionals
+ for values around a neutral point. Examples of sets of ordinal values: -3, -2, -1, 0, 1, 2, 3 -- reflex response values 0, 1, 2 -- Apgar values
+ Used for recording any clinical datum which is customarily recorded using symbolic values. Example: the results on a urinalysis strip,
+ e.g. {neg, trace, +,++, +++} are used for leucocytes, protein, nitrites etc; for non-haemolysed blood {neg, trace, moderate};
+ for haemolysed blood {neg, trace,small, moderate, large}.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -238,7 +265,8 @@
<xs:complexType name="DvQuantified" abstract="true">
<xs:annotation>
<xs:documentation>
-
+ Abstract class defining the concept of true quantified values, i.e. values which are not only ordered, but which have a
+ precise magnitude.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -256,7 +284,10 @@
<xs:complexType name="DvDateTime" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ All dates and times representations in MLHIM use this class. Represents an absolute point in time, specified to the second.
+ Used for recording a precise point in real world time, and for approximate time stamps, e.g. the origin of a History in an
+ Observation which is only partially known. All dates and times are assumed to be in the "current era"; somewhere between
+ 0001-01-01T00:00:00Z and 9999-12-31T23:59:59Z AD. The difference function is redefined to produce a DvDuration.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -271,7 +302,10 @@
<xs:complexType name="DvQuantity" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ Quantitified type representing “scientific†quantities, i.e. quantities expressed as a magnitude and units. Units were inspired
+ by the Unified Code for Units of Measure (UCUM), developed by Gunther Schadow and Clement J. McDonald of The Regenstrief
+ Institute. Can also be used for time durations, where it is more convenient to treat these as simply a number of individual
+ seconds, minutes, hours, days, months, years, etc.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -287,7 +321,8 @@
<xs:complexType name="DvCount" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ Countable quantities. Used for countable types such as pregnancies and steps (taken by a physiotherapy patient),
+ number of cigarettes smoked in a day, etc. Misuse:Not used for amounts of physical entities (which all have units)
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -302,7 +337,36 @@
<xs:complexType name="DvDuration" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ Durations are a component of time intervals and define the amount of intervening time in a time interval.
+ They should only be used as part of a time interval as prescribed by the standard. Durations are represented by the
+ format P[n]Y[n]M[n]DT[n]H[n]M[n]S or P[n]W as shown to the right. In these representations, the [n] is replaced by the
+ value for each of the date and time elements that follow the [n]. Leading zeros are not required, but the maximum number
+ of digits for each element should be agreed to by the communicating parties. The capital letters 'P', 'Y', 'M', 'W', 'D', 'T', 'H', 'M',
+ and 'S' are designators for each of the date and time elements and are not replaced.
+
+ * P is the duration designator (historically called "period") placed at the start of the duration representation.
+ * Y is the year designator that follows the value for the number of years.
+ * M is the month designator that follows the value for the number of months.
+ * W is the week designator that follows the value for the number of weeks.
+ * D is the day designator that follows the value for the number of days.
+ * T is the time designator that precedes the time components of the representation.
+ * H is the hour designator that follows the value for the number of hours.
+ * M is the minute designator that follows the value for the number of minutes.
+ * S is the second designator that follows the value for the number of seconds.
+
+ For example, "P3Y6M4DT12H30M5S" represents a duration of "three years, six months, four days, twelve hours, thirty minutes,
+ and five seconds". Date and time elements including their designator may be omitted if their value is zero, and lower order
+ elements may also be omitted for reduced precision. For example, "P23DT23H" and "P4Y" are both acceptable duration
+ representations. To resolve ambiguity, "P1M" is a one-month duration and "PT1M" is a one-minute duration
+ (note the time designator, T, that precedes the time value). The smallest value used may also have a decimal fraction,
+ as in "P0.5Y" to indicate half a year. This decimal fraction may be specified with either a comma or a full stop, as in
+ "P0,5Y" or "P0.5Y". The standard does not prohibit date and time values in a duration representation from exceeding their
+ "carry-over points" except as noted below. Thus, "PT36H" could be used as well as "P1DT12H" for representing the same duration.
+ Alternately, a format for duration based on combined date and time representations may be used by agreement between the
+ communicating parties either in the basic format PYYYYMMDDThhmmss or in the extended
+ format P[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]. For example, the first duration shown above would be "P0003-06-04T12:30:05".
+ However, individual date and time values cannot exceed their moduli (e.g. a value of 13 for the month or 25 for the hour would
+ not be permissible).
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -317,7 +381,7 @@
<xs:complexType name="DvRatio" abstract="true">
<xs:annotation>
<xs:documentation>
-
+ Models a ratio of values, i.e. where the numerator and denominator are both pure numbers.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -333,7 +397,9 @@
<xs:complexType name="DvRate" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ Models a ratio of values, i.e. where the numerator and denominator are both pure numbers, and the numerator is not
+ contained (it is not a subset of the denominator). Example 1: Numerator = Number of episodes of seizures;
+ Denominator = Number of days Example 2 = Number of hospital admissions; Denominator = Number of bed-days
</xs:documentation>
</xs:annotation>
<xs:complexContent>
@@ -348,7 +414,13 @@
<xs:complexType name="DvProportion" abstract="false">
<xs:annotation>
<xs:documentation>
-
+ Models a ratio of values, i.e. where the numerator and denominator are both pure numbers. The proportion_kind
+ property is used to control the type attribute to be one of a defined set. Used for recording titers (e.g. 1:128),
+ concentration ratios, e.g. Na:K (unitary denominator), albumin:creatinine ratio, and percentages, e.g. red cell distirbution
+ width (RDW). Should not be used to represent things like blood pressure which are often written using a ‘/’ character,
+ giving the misleading impression that the item is a ratio, when in fact it is a structured value. Similarly, visual acuity, often
+ written as (e.g.) “6/24†in clinical notes is not a ratio but an ordinal (which includes non-numeric symbols like CF = count fingers etc).
+ Should not be used for formulations.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
