mlhim-specs-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 116
committer: Timothy W. Cook <timothywayne.cook@xxxxxxxxx>
branch nick: mlhim-specs
timestamp: Thu 2011-04-28 16:55:56 -0500
message:
  Inserted documentation for all content.xsd complexTypes. See https://bugs.launchpad.net/mlhim-specs/+bug/771266
modified:
  schemas/content.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/content.xsd'
--- schemas/content.xsd	2011-04-28 15:25:40 +0000
+++ schemas/content.xsd	2011-04-28 21:55:56 +0000
@@ -5,7 +5,11 @@
            <xs:complexType name="EventContext" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Documents the context information of a healthcare event involving the subject of care and the health system. 
+	The context information recorded here is independent of the attributes recorded in the version audit, which document 
+	the “system interaction” context, i.e. the context of a user interacting with the health record  system. Healthcare events 
+	include patient contacts, and any other business activity, such as pathology investigations which take place on behalf of 
+	the patient.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -26,7 +30,7 @@
            <xs:complexType name="ContentItem"  abstract="true">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Abstract ancestor of all concrete content types.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -42,7 +46,9 @@
            <xs:complexType name="Section" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Represents a heading in a heading structure, or “section tree”. Created according to structures for typical headings 
+	such as SOAP, physical examination, but also pathology result heading structures. Should not be used instead of 
+	ENTRY hierarchical structures.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -57,7 +63,11 @@
            <xs:complexType name="Entry" abstract="true">
 	<xs:annotation>
 	<xs:documentation>
-	
+	The abstract parent of all ENTRY subtypes. An ENTRY is the root of a logical item of “hard” clinical information created in the 
+	“clinical statement” context, within a clinical session. There can be numerous such contexts in a clinical session. 
+	Observations and other Entry types only ever document information captured/created in the event documented by the enclosing 
+	Composition. An ENTRY is also the minimal unit of information any query should return, since a whole ENTRY (including sub-parts) 
+	records spatial structure, timing information, and contextual information, as well as the subject and generator of the information.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -77,7 +87,9 @@
            <xs:complexType name="AdminEntry" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Entry subtype for administrative information, i.e. information about setting up the clinical process, but not itself clinically relevant. 
+	CCDs will define contained information. Used for admistrative details of admission, episode, ward location, discharge,
+	appointment (if not stored in a practice management or appointments system). Not used for any clinically significant information.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -92,7 +104,7 @@
            <xs:complexType name="CareEntry"  abstract="true">
 	<xs:annotation>
 	<xs:documentation>
-	
+	The abstract parent of all clinical ENTRY subtypes. Defines protocol and guideline attributes for all clinical Entry subtypes.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -108,7 +120,10 @@
            <xs:complexType name="Observation" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Entry subtype for all clinical data in the past or present, i.e. which (by the time it is recorded) has already occurred. 
+	Observation data is expressed using the class History, which guarantees that it is situated in time. 
+	Observation is used for all notionally objective (i.e. measured in some way) observations of phenomena, and patient-reported 
+	phenomena, e.g. pain. Not used for recording opinion or future statements of any kind, including instructions, intentions, plans etc.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -124,7 +139,8 @@
            <xs:complexType name="Evaluation"  abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Used for all kinds of statements which evaluate other information, such as interpretations of obvservations, diagnoses, 
+	differential diagnoses, hypotheses, risk assessments, goals and plans.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -139,7 +155,8 @@
            <xs:complexType name="Action" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Used to record a clinical action that has been performed, which may have been adhoc, or due to the execution of an 
+	Activity in an Instruction workflow. Every Action corresponds to a careflow step of some kind or another.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -157,7 +174,8 @@
            <xs:complexType name="Instruction"  abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Used for any actionable statement such as medication and therapeutic orders, monitoring, recall and review. 
+	Enough details must be provided for the specification to be directly executed by an actor, either human or machine.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -168,7 +186,9 @@
            <xs:complexType name="Composition"  abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	One version in a VersionedComposition. A composition is considered the unit of modification of the record, the unit of 
+	transmission in record extracts, and the unit of attestation by authorising clinicians. In this latter sense, it may be considered 
+	equivalent to a signed document.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>