mlhim-specs-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 124
committer: Timothy W. Cook <timothywayne.cook@xxxxxxxxx>
branch nick: mlhim-specs
timestamp: Fri 2011-04-29 14:36:27 -0500
message:
  Working on Element documentation strings.
modified:
  schemas/common.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/common.xsd'
--- schemas/common.xsd	2011-04-29 19:15:04 +0000
+++ schemas/common.xsd	2011-04-29 19:36:27 +0000
@@ -12,7 +12,9 @@
              <xs:complexContent>
              <xs:extension base="mlhim2:DvAny">
              <xs:sequence>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>
+             Optional reference to more detailed demographic or identification information for this party, in an external system.
+              </xs:documentation></xs:annotation>
                <xs:element name="external_ref" maxOccurs="1" minOccurs="0" type="mlhim2:EntityRef"></xs:element>
              </xs:sequence>
              </xs:extension>
@@ -45,9 +47,10 @@
            <xs:complexContent>
            <xs:extension base="mlhim2:PartyProxy">
               <xs:sequence>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>
+             Optional human-readable name (in String form).</xs:documentation></xs:annotation>
                <xs:element name="name" maxOccurs="1" minOccurs="0" type="xs:string"></xs:element>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>List of DvIdentifiers - One or more formal identifiers (possibly computable).</xs:documentation></xs:annotation>
                <xs:element name="identifiers" maxOccurs="unbounded" minOccurs="0" type="mlhim2:DvIdentifier"></xs:element>
              </xs:sequence>          
            </xs:extension>
@@ -64,7 +67,8 @@
            <xs:complexContent>
            <xs:extension base="mlhim2:PartyIdentified">
               <xs:sequence>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Relationship of subject of this Entry to the subject of the record. May be coded. 
+             If it is the patient, coded as “self”. </xs:documentation></xs:annotation>
                <xs:element name="relationship" maxOccurs="1" minOccurs="1" type="mlhim2:Relationship"></xs:element>
              </xs:sequence>          
            </xs:extension>
@@ -83,17 +87,17 @@
            	<xs:complexContent>
            	<xs:extension base="mlhim2:DvAny">
            	  <xs:sequence>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Identifier of the system which handled the information item.</xs:documentation></xs:annotation>
            	    <xs:element name="system_id" maxOccurs="1" minOccurs="0" type="xs:string"></xs:element>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Any identifier used in the system such as “interim”, “final”, or numeric versions if available.</xs:documentation></xs:annotation>
            	    <xs:element name="version_id" maxOccurs="1" minOccurs="0" type="xs:string"></xs:element>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Optional provider(s) who created, committed, forwarded or otherwise handled the item.</xs:documentation></xs:annotation>
            	    <xs:element name="provider" maxOccurs="1" minOccurs="0" type="mlhim2:PartyIdentified"></xs:element>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Identifier of the particular site/facility within an organisation which handled the item. For computability, this identifier needs to be e.g. a PKI identifier which can be included in the identifier list of the PARTY_IDENTIFIED object.</xs:documentation></xs:annotation>
            	    <xs:element name="location" maxOccurs="1" minOccurs="0" type="mlhim2:Location"></xs:element>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Time of handling the item. For an originating system, this will be time of creation, for an intermediate feeder system, this will be a time of accession or other time of handling, where available.</xs:documentation></xs:annotation>
            	    <xs:element name="time" maxOccurs="1" minOccurs="0" type="mlhim2:DvDateTime"></xs:element>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Identifiers for subject of the received information item.</xs:documentation></xs:annotation>
            	    <xs:element name="subject" maxOccurs="1" minOccurs="0" type="mlhim2:PartyProxy"></xs:element>
            	  </xs:sequence>
            	</xs:extension>
@@ -109,15 +113,15 @@
            <xs:complexContent>
            <xs:extension base="mlhim2:DvAny">
              <xs:sequence>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Any audit information for the information item from the originating system.</xs:documentation></xs:annotation>
                <xs:element name="originating_system_audit" maxOccurs="1" minOccurs="1" type="mlhim2:FeederAuditDetails"></xs:element>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Identifiers used for the item in the originating system, e.g. filler and placer ids.</xs:documentation></xs:annotation>
                <xs:element name="originating_system_item_ids" maxOccurs="unbounded" minOccurs="1" type="mlhim2:DvIdentifier"></xs:element>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Any audit information for the information item from the feeder system, if different from the originating system.</xs:documentation></xs:annotation>
                <xs:element name="feeder_system_audit" maxOccurs="1" minOccurs="1" type="mlhim2:FeederAuditDetails"></xs:element>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Identifiers used for the item in the feeder system, where the feeder system is distinct from the originating system.</xs:documentation></xs:annotation>
                <xs:element name="feeder_system_ids" maxOccurs="unbounded" minOccurs="1" type="mlhim2:DvIdentifier"></xs:element>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Optional inline inclusion of or reference to original content corresponding to the MLHIM content at this node. Typically a URI reference to a document or message in a persistent store associated with the EHR.</xs:documentation></xs:annotation>
                <xs:element name="original_content" maxOccurs="1" minOccurs="1" type="mlhim2:DvEncapsulated"></xs:element>
              </xs:sequence>
            </xs:extension>
@@ -133,13 +137,13 @@
            <xs:complexContent>
            <xs:extension base="mlhim2:DvAny">
              <xs:sequence>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Audit trail from non-MLHIM system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.</xs:documentation></xs:annotation>
                <xs:element name="feeder_audit" maxOccurs="1" minOccurs="0" type="mlhim2:FeederAudit"></xs:element>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Runtime name of this fragment, used to build runtime paths. This is the term provided at design time to name this EHR construct.  Its retention in the EHR faithfully preserves the original label by which this entry was known to end users. When created in English; it shall consist only of lowercase letters a-z, digits 0-9 and use the _ (underscore) as a separator.   Other languages should follow similar naming rules in order to not conflict with implementations,</xs:documentation></xs:annotation>
                <xs:element name="name" maxOccurs="1" minOccurs="1" type="xs:string"></xs:element>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>UUID for each Locatable structure.</xs:documentation></xs:annotation>
                <xs:element name="uuid" maxOccurs="1" minOccurs="1" type="xs:string"></xs:element>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>Parent of this node in compositional hierarchy. Usually a UUID of another Locatable.</xs:documentation></xs:annotation>
                <xs:element name="parent" maxOccurs="1" minOccurs="1" type="xs:string"></xs:element>
              </xs:sequence>
            </xs:extension>
@@ -156,7 +160,7 @@
            <xs:complexContent>
            <xs:extension base="mlhim2:Locatable">
               <xs:sequence>
-             <xs:annotation><xs:documentation></xs:documentation></xs:annotation>
+             <xs:annotation><xs:documentation>A list of  UUIDs of Compositions logically in this folder.</xs:documentation></xs:annotation>
                <xs:element name="items" maxOccurs="unbounded" minOccurs="1" type="mlhim2:Composition"></xs:element>
              </xs:sequence>          
            </xs:extension>