mlhim-specs-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 128
committer: Timothy W. Cook <timothywayne.cook@xxxxxxxxx>
branch nick: mlhim-specs
timestamp: Sat 2011-04-30 16:03:31 -0500
message:
  Working on Element documentation strings. Completed content.xsd 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-30 02:18:58 +0000
+++ schemas/content.xsd	2011-04-30 21:03:31 +0000
@@ -17,31 +17,27 @@
              <xs:sequence>
 
                <xs:element name="healthcare_facility" maxOccurs="1" minOccurs="0" type="mlhim2:Organization">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>The health care facility under whose care the event took place. This is the most specific workgroup or delivery unit within a care delivery enterprise that has an official identifier in the health system, and can be used to ensure medico-legal accountability.</xs:documentation></xs:annotation>
                </xs:element>
 
                <xs:element name="start_time" maxOccurs="1" minOccurs="0" type="mlhim2:DvDateTime">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Start time of the clinical session or other kind of event during which a provider performs a service of any kind for the patient.</xs:documentation></xs:annotation>
                </xs:element>
 
                <xs:element name="end_time" maxOccurs="1" minOccurs="0" type="mlhim2:DvDateTime">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Optional end time of the clinical session.</xs:documentation></xs:annotation>
                </xs:element>
 
                <xs:element name="participation" maxOccurs="1" minOccurs="0" type="mlhim2:Participation">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
-               </xs:element>
-
-               <xs:element name="start_time" maxOccurs="1" minOccurs="0" type="mlhim2:DvDateTime">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Parties involved in the healthcare event.</xs:documentation></xs:annotation>
                </xs:element>
 
                <xs:element name="location" maxOccurs="1" minOccurs="0" type="mlhim2:Location">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>The actual location where the session occurred, e.g. “microbiol lab 2”, “home”, “ward A3” and so on.</xs:documentation></xs:annotation>
                </xs:element>
 
                <xs:element name="setting" maxOccurs="1" minOccurs="0" type="mlhim2:DvCodedText">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>The setting in which the clinical session took place. Coded using the MLHIM Terminology, “setting” group.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>
            	</xs:extension>
@@ -59,11 +55,11 @@
              <xs:sequence>
 
                <xs:element name="links" maxOccurs="unbounded" minOccurs="0" type="mlhim2:Link">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>A list of links to other content items.</xs:documentation></xs:annotation>
                </xs:element>
 
                <xs:element name="attestation" maxOccurs="1" minOccurs="0" type="mlhim2:Attestation">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Sign off on completeness and accuracy of the content.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>
            	</xs:extension>
@@ -83,7 +79,7 @@
              <xs:sequence>
               
                <xs:element name="items" maxOccurs="1" minOccurs="0" type="mlhim2:ContentItem">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Ordered list of content items under this section, which may include more SECTIONs or ENTRYs</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>
            	</xs:extension>
@@ -105,27 +101,27 @@
              <xs:sequence>
               
                <xs:element name="language" maxOccurs="1" minOccurs="0" type="xs:string">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Mandatory indicator of the localised language in which this Entry is written. Coded from MLHIM Code Set “languages”.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="encoding" maxOccurs="1" minOccurs="0" type="xs:string">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Name of character set in which text values in this Entry are encoded. Coded from MLHIM Code Set “character sets”.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="subject" maxOccurs="1" minOccurs="0" type="xs:string">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Id of human subject of this ENTRY, e.g.: organ donor, foetus, family member, another clinically relevant person.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="provider" maxOccurs="1" minOccurs="0" type="mlhim2:PartyProxy">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Optional identification of provider of the information in this ENTRY, which might be: the patient, a patient agent, e.g. parent, guardian, the clinician, a device or software.  Generally only used when the recorder needs  to make it explicit. Otherwise, Composition  composer and other participants are assumed.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="other_participations" maxOccurs="unbounded" minOccurs="0" type="mlhim2:Participation">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Other participations at ENTRY level.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="workflow_id" maxOccurs="1" minOccurs="0" type="mlhim2:ObjectRef">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Identifier of externally held workflow engine data for this workflow execution, for this subject of care.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>
            	</xs:extension>
@@ -145,7 +141,7 @@
              <xs:sequence>
               
                <xs:element name="data" maxOccurs="1" minOccurs="0" type="mlhim2:ItemStructure">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>The data of the Entry.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>
            	</xs:extension>
@@ -163,11 +159,11 @@
              <xs:sequence>
               
                <xs:element name="protocol" maxOccurs="1" minOccurs="0" type="mlhim2:ItemStructure">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Description of the method (i.e. how) the information in this entry was arrived at. For OBSERVATIONs, this is a description of the method or instrument used. For EVALUATIONs, how the evaluation was arrived at. For INSTRUCTIONs, how to execute the Instruction. This may take the form of references to guidelines, including manually followed and executable; knowledge references such as a paper in Medline; clinical reasons within a larger care process.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="guideline_id" maxOccurs="1" minOccurs="0" type="mlhim2:ObjectRef">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Optional external identifier of guideline creating this action if relevant</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>
            	</xs:extension>
@@ -188,11 +184,11 @@
              <xs:sequence>
               
                <xs:element name="data" maxOccurs="1" minOccurs="0" type="mlhim2:History">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>The data of this observation, in the form of a history of values which may be of any complexity.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="state" maxOccurs="1" minOccurs="0" type="mlhim2:History">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Optional recording of the state of subject of this observation during the observation process, in the form of a separate history of values which may be of any complexity. State may also be recorded within the History of the data attribute.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>
            	</xs:extension>
@@ -211,7 +207,7 @@
              <xs:sequence>
               
                <xs:element name="data" maxOccurs="1" minOccurs="0" type="mlhim2:ItemStructure">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>The data from the evaluation.</xs:documentation></xs:annotation>
                </xs:element>
             </xs:sequence>
            	</xs:extension>
@@ -230,19 +226,19 @@
              <xs:sequence>
               
                <xs:element name="time" maxOccurs="1" minOccurs="0" type="mlhim2:DvDateTime">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Point in time at which this action completed.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="description" maxOccurs="1" minOccurs="0" type="mlhim2:ItemStructure">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Description of the activity to be performed, in the form of a defined structure.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="ism_transition" maxOccurs="1" minOccurs="0" type="mlhim2:DvCodedText">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Details of transition in the Instruction state machine caused by this Action.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="instruction_details" maxOccurs="1" minOccurs="0" type="mlhim2:DvCodedText">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Details to of the Instruction that caused this Action to be performed, if there was one.</xs:documentation></xs:annotation>
                </xs:element>
              </xs:sequence>
            	</xs:extension>
@@ -257,7 +253,26 @@
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
-           <xs:extension base="mlhim2:CareEntry"></xs:extension>
+           <xs:extension base="mlhim2:CareEntry">
+             <xs:sequence>
+              
+               <xs:element name="expiry_time" maxOccurs="1" minOccurs="0" type="mlhim2:DvDateTime">
+               <xs:annotation><xs:documentation>Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired. This helps prevent false listing of Instructions as Active when they clearly must have been terminated in some way or other.</xs:documentation></xs:annotation>
+               </xs:element>
+              
+               <xs:element name="narrative" maxOccurs="1" minOccurs="1" type="mlhim2:DvText">
+               <xs:annotation><xs:documentation>Mandatory human-readable version of what the Instruction is about.</xs:documentation></xs:annotation>
+               </xs:element>
+              
+               <xs:element name="wf_definition" maxOccurs="1" minOccurs="0" type="mlhim2:DvParsable">
+               <xs:annotation><xs:documentation>Optional workflow engine executable expression of the Instruction.</xs:documentation></xs:annotation>
+               </xs:element>
+              
+               <xs:element name="activities" maxOccurs="unbounded" minOccurs="1" type="mlhim2:Activity">
+               <xs:annotation><xs:documentation>List of all activities in Instruction.</xs:documentation></xs:annotation>
+               </xs:element>
+             </xs:sequence>
+           </xs:extension>
            </xs:complexContent>
            </xs:complexType>
 
@@ -274,47 +289,47 @@
              <xs:sequence>
               
                <xs:element name="attestation" maxOccurs="1" minOccurs="0" type="mlhim2:Attestation">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>The signoff of this Composition.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="links" maxOccurs="unbounded" minOccurs="0" type="mlhim2:Link">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>A list of links to other content items.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="original" maxOccurs="1" minOccurs="0" type="xs:string">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>The UUID of the original composition if this is a new version. Void if this is an original composition. This attribute along with the predecessor form the versioning function for compositions. </xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="predecessor" maxOccurs="1" minOccurs="0" type="xs:string">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>The UUID of the preceeding composition if this is a new version. Void if this is an original composition.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="created" maxOccurs="1" minOccurs="0" type="mlhim2:DvDateTime">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>DateTime created.  Since Compositions are never modified, only copied and edited. </xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="composer" maxOccurs="1" minOccurs="0" type="mlhim2:PartyProxy">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). This is the identifier which should appear on the screen. It may or may not be the person who entered the data. When it is the patient, the special “self”  instance of PARTY_PROXY will be used.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="territory" maxOccurs="1" minOccurs="0" type="mlhim2:Location">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Name of territory in which this Composition was written. </xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="category" maxOccurs="1" minOccurs="0" type="mlhim2:DvCodedText">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>Indicates what broad category this Composition is belongs to, e.g. “persistent” - of longitudinal validity, “event”, “process”.</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>Mandatory indicator of the localised language in which this Composition is written. Coded from MLHIM Code Set “languages”. The language of an Entry if  different from the Composition is indicated in ENTRY.language.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="context" maxOccurs="1" minOccurs="0" type="mlhim2:EventContext">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>The clinical session context of this Composition, i.e. the contextual attributes of the clinical session.</xs:documentation></xs:annotation>
                </xs:element>
               
                <xs:element name="content" maxOccurs="1" minOccurs="0" type="mlhim2:Locatable">
-               <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+               <xs:annotation><xs:documentation>The content of this Composition.  Any Locatable content items or structures may be added here. </xs:documentation></xs:annotation>
                </xs:element>
             </xs:sequence>
            	</xs:extension>