mlhim-specs-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 114
committer: Timothy W. Cook <timothywayne.cook@xxxxxxxxx>
branch nick: mlhim-specs
timestamp: Thu 2011-04-28 15:14:32 -0500
message:
  Inserted documentation for all common.xsd complexTypes. See https://bugs.launchpad.net/mlhim-specs/+bug/771266
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-28 15:25:40 +0000
+++ schemas/common.xsd	2011-04-28 20:14:32 +0000
@@ -5,7 +5,8 @@
            <xs:complexType name="PartyProxy" abstract="true">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Abstract concept of a proxy description of a party, including an optional link to data for this party in a demographic 
+	or other identity management system. Sub-typed into PARTY_IDENTIFIED and PARTY_SELF.
 	</xs:documentation>
 	</xs:annotation>
              <xs:complexContent>
@@ -20,7 +21,8 @@
            <xs:complexType name="PartySelf"  abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Party proxy representing the subject of the record. Used to indicate that the party is the owner of the record. 
+	May or may not have external_ref set.
 	</xs:documentation>
 	</xs:annotation>
              <xs:complexContent>
@@ -32,7 +34,11 @@
            <xs:complexType name="PartyIdentified" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Proxy data for an identified party other than the subject of the record, minimally consisting of human-readable identifier(s), 
+	such as name, formal (and possibly computable) identifiers such as NHS number, and an optional link to external data. 
+	There must be at least one of name, identifier or external_ref present.Used to describe parties where only identifiers may 
+	be known, and there is no entry at all in the demographic system (or even no demographic system). Typically for health care 
+	providers, e.g. name and provider number of an institution. Should not be used to include patient identifying information.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -48,7 +54,8 @@
            <xs:complexType name="PartyRelated" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Proxy type for identifying a party and its relationship to the subject of the record. Use where the relationship between the 
+	party and the subject of the record must be known.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -63,7 +70,10 @@
            	<xs:complexType name="FeederAuditDetails" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Audit details for any system in a feeder system chain. Audit details here means the general notion of who/where/when the 
+	information item to which the audit is attached was created. None of the attributes is defined as mandatory, however, in 
+	different scenarios, various combinations of attributes will usually be mandatory. This can be controlled by specifying feeder 
+	audit details in legacy archetypes.
 	</xs:documentation>
 	</xs:annotation>
            	<xs:complexContent>
@@ -83,7 +93,7 @@
            <xs:complexType name="FeederAudit" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Audit and other meta-data for systems in the feeder chain.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -102,7 +112,7 @@
            <xs:complexType name="Locatable" abstract="true">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Root class of all information model classes that can be expressed in a constraint model.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -120,7 +130,8 @@
            <xs:complexType name="Folder" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	A container for other items representing a logical grouping. In implementations this may also inherit from 
+	library components providing the required functionality.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -135,7 +146,8 @@
            <xs:complexType name="Attestation" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Record an attestation by a party of item(s) of record content. The type of attestation is recorded by the reason attribute, 
+	which may be coded.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -155,7 +167,9 @@
            <xs:complexType name="Participation" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Model of a participation of a Party (any Actor or Role) in an activity. Used to represent any participation of a Party in some 
+	activity, which is not explicitly in the model, e.g. assisting nurse. Can be used to record past or future participations. 
+	Should not be used in place of more permanent relationships between demographic entities.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -173,7 +187,14 @@
            <xs:complexType name="Link" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	The LINK type defines a logical relationship between two items, such as two ENTRYs or an ENTRY and a COMPOSITION. 
+	Links can be used across compositions, and across EHRs. Links can potentially be used between interior 
+	nodes, although this probably should be prevented in CCDs. Multiple LINKs can be attached to the root object of any 
+	structure to give the effect of a 1->N link. 1:1 and 1:N relationships between content elements (e.g. ENTRYs) can be 
+	expressed by using one, or more than one. Chains of links can be used to see “problem threads” or other logical groupings 
+	of  items. Links should be between structures only, i.e. between objects representing complete domain concepts because 
+	relationships between sub-elements of whole concepts are not necessarily meaningful, and may be downright confusing. 
+	Sensible links only exist between whole ENTRYs, SECTIONs, COMPOSITIONs and so on.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -189,7 +210,8 @@
            <xs:complexType name="AuthoredResource" abstract="true">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Abstract idea of an online resource created by a human author. The attributes are derived primarily from the Dublin Core 
+	Metadata Initiative http://www.dublincore.org  http://dublincore.org/documents/2010/10/11/dces/ 
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -218,5 +240,4 @@
            	</xs:complexContent>
           </xs:complexType>
 
-
 </xs:schema>