complexType "CodeMapType"
Namespace:
Content:
complex, 7 attributes, 19 elements
Defined:
globally in comparative.xsd; see XML source
Includes:
definitions of 1 attribute, 8 elements
Used:
XML Representation Summary
<...
   
 = 
("Canonical" | "Deprecated")
 = 
("Add" | "Update" | "Delete")
 = 
xs:anyURI
 = 
("Agency" | "Maintainable") : "Agency"
 = 
(xs:dateTime | xs:date | xs:gYearMonth | xs:gYear | xs:duration)
 = 
"true"
 = 
xs:boolean
    >
   
Content: 
(r:URN | (r:Agency, r:ID, r:Version))[1..2], r:UserID*, r:UserAttributePair*, (r:VersionResponsibility | r:VersionResponsibilityReference)?, r:VersionRationale?, r:BasedOnReference?, r:MaintainableObject?, CodeMapName*, r:Label*, r:Description?, (SourceCodeListReference | SourceDelineationReference), TargetCodeListReference, Correspondence?, d:GenerationInstruction*
</...>
Content Model Elements (19):
CodeMapName, Correspondence, SourceCodeListReference, SourceDelineationReference, TargetCodeListReference, d:GenerationInstruction, r:Agency, r:BasedOnReference, r:Description, r:ID, r:Label, r:MaintainableObject, r:URN, r:UserAttributePair, r:UserID, r:Version, r:VersionRationale, r:VersionResponsibility, r:VersionResponsibilityReference
All Direct / Indirect Based Elements (1):
CodeMap
Known Usage Locations
Annotation
Maps the codes from two different CodeLists or from a delineation to a CodeList (i.e., from a NumericDelineation capture of age to age cohorts expressed in a CodeList). In addition to the standard name, label, and description of the CodeMap, identifies the source scheme and target scheme (which should be a CodeListScheme), describes the correspondence between the source and target, allows for the use of a GenerationInstruction to describe the recoding process, and indicates if this a general mapping or a mapping for a specific purpose.
Type Definition Detail
Type Derivation Tree
r:AbstractIdentifiableType (extension)
      r:VersionableType (extension)
          CodeMapType
XML Source (w/o annotations (10); see within schema source)
<xs:complexType name="CodeMapType">
<xs:complexContent>
<xs:extension base="r:VersionableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CodeMapName"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label"/>
<xs:element minOccurs="0" ref="r:Description"/>
<xs:choice>
<xs:element ref="SourceCodeListReference"/>
<xs:element ref="SourceDelineationReference"/>
</xs:choice>
<xs:element ref="TargetCodeListReference"/>
<xs:element minOccurs="0" ref="Correspondence"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="d:GenerationInstruction"/>
</xs:sequence>
<xs:attribute name="contextSpecificComparison" type="xs:boolean" use="optional"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Attribute Detail (all declarations; defined within this component only; 1/7)
contextSpecificComparison
Type:
xs:boolean, predefined
Use:
optional
Set the value to "true" if the context is for a specified use of the CodeList. For example, a Numeric Delineation may map to a CodeList of age cohorts but is limited to the use of the numeric delineation as a representation/response domain for the concept AGE.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="contextSpecificComparison" type="xs:boolean" use="optional"/>
Content Element Detail (all declarations; defined within this component only; 8/19)
CodeMapName
Type:
r:NameType, complex content
A name for the CodeMap. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CodeMapName"/>

Correspondence
Type:
CorrespondenceType, complex content
Describe the level of similarity and difference between the Source and the Target contents.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="Correspondence"/>

d:GenerationInstruction
Type:
Allows for use of programmatic logic to construct a detailed comparison map between individual codes in the source and target structures.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="d:GenerationInstruction"/>

r:Description
Type:
r:StructuredStringType, complex content
A description of the content and purpose of the CodeMap. May be expressed in multiple languages and supports the use of structured content.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:Description"/>

r:Label
Type:
r:LabelType, complex content
A display label for the CodeMap. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label"/>

SourceCodeListReference
Type:
r:ReferenceType, complex content
Mappings are unidirectional. The CodeList referenced as the source is the CodeList that would be transformed into the CodeList identified as the target. When harmonizing CodeLists, first create the harmonized CodeList and use it as the TargetCodeListReference. The two or more CodeLists used to determine the harmonized structure will all be treated as SourceCodeList in pairwise mappings to the harmonized TargetCodeList.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="SourceCodeListReference"/>

SourceDelineationReference
Type:
r:ReferenceType, complex content
A reference to a non-CodeList based delineation that will be mapped into a CodeList. Mappings are unidirectional. The delineation referenced as the source is the delineation that would be transformed into the CodeList identified as the target.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="SourceDelineationReference"/>

TargetCodeListReference
Type:
r:ReferenceType, complex content
Reference to the CodeList describing the target structure.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="TargetCodeListReference"/>

XML schema documentation generated with DocFlex/XML 1.8.7 using DocFlex/XML XSDDoc 2.7.0 template set