Showing:

Annotations
Attributes
Diagrams
Facets
Properties
Source
Used by
Element terminologyAssociation
Namespace No namespace
Diagram
DiagramDECOR_xsd_Element_terminologyAssociation.tmp#terminologyAssociation_conceptIdDECOR_xsd_Element_terminologyAssociation.tmp#terminologyAssociation_conceptFlexibilityDECOR_xsd_Element_terminologyAssociation.tmp#terminologyAssociation_codeDECOR_xsd_Element_terminologyAssociation.tmp#terminologyAssociation_codeSystemDECOR_xsd_Element_terminologyAssociation.tmp#terminologyAssociation_codeSystemNameDECOR_xsd_Attribute_displayName.tmp#displayNameDECOR_xsd_Element_terminologyAssociation.tmp#terminologyAssociation_valueSetDECOR_xsd_Element_terminologyAssociation.tmp#terminologyAssociation_flexibilityDECOR_xsd_Element_terminologyAssociation.tmp#terminologyAssociation_strengthDECOR_xsd_Attribute_Group_VersionHandlingEffectiveDateOptional.tmp#VersionHandlingEffectiveDateOptionalDECOR_xsd_Element_terminologyAssociation.tmp#terminologyAssociation_equivalenceDECOR_xsd_Attribute_Group_TerminologyAssociationCompilationAttributes.tmp#TerminologyAssociationCompilationAttributes
Properties
content complex
Used by
Attributes
QName Type Default Use Annotation
code EnumerationString optional
codeSystem Oid optional
codeSystemName NonEmptyString optional
conceptFlexibility StaticFlexibility optional 
Refers to the concept/@effectiveDate if conceptId points to a real concept and not to conceptList or a concept under a conceptList.
conceptId Oid required
displayName NonEmptyString optional 
A short description string for the designation
effectiveDate TimeStampNoTimezone optional 
Identifies the effective date of the version of the object.
equivalence EquivalencyType optional 
Rating of mapping between the concept to the associated code or a concept list to an associated value set
expirationDate TimeStampNoTimezone optional 
Identifies the expiration date of the version of the object.
flexibility StaticOrDynamicFlexibility optional 
Reference to a valueSet/@effectiveDate. Default is unspecified which means 'latest available version'.
lastModifiedDate TimeStampNoTimezone optional 
Identifies last point in time that the object was changed.
officialReleaseDate TimeStampNoTimezone optional 
Identifies the official release date of the version of the object.
strength CodingStrengthType required optional
valueSet BasicIdOrOid optional 
Reference to a valueSet/@id or @name. References to @name are discouraged because they become ambiguous quickly.
valueSetName xs:string optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the displayName of the value set if available else the name
versionLabel ShortDescriptiveName optional 
A human readable version number or version label for convenient human rendition; not used by an application.
Wildcard: ANY attribute from ANY namespace OTHER than 'No Namespace'
Source
 
<xs:element name="terminologyAssociation">
  <xs:complexType>
    <xs:annotation>
      <xs:documentation xml:lang="en-US">terminologyAssociation links a concept to a code or a concept list to a value set</xs:documentation>
    </xs:annotation>
    <!--<xs:attribute name="id" use="optional" type="Oid">
                <xs:annotation>
                    <xs:documentation xml:lang="en-US">each assignment SHOULD have a project unique id so you can attach issues, manage the status machine, change with precision, and potentially delete</xs:documentation>
                </xs:annotation>
            </xs:attribute>-->
    <!-- concept id where this assocication is associated with -->
    <xs:attribute name="conceptId" use="required" type="Oid"/>
    <xs:attribute name="conceptFlexibility" use="optional" type="StaticFlexibility">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">Refers to the concept/@effectiveDate if conceptId points to a real concept and not to conceptList or a concept under a conceptList.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <!-- a coded concept -->
    <xs:attribute name="code" use="optional" type="EnumerationString"/>
    <xs:attribute name="codeSystem" use="optional" type="Oid"/>
    <!-- human readable things for codes -->
    <xs:attribute name="codeSystemName" use="optional" type="NonEmptyString"/>
    <xs:attribute ref="displayName" use="optional">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">A displayname for the code, only for human readablility here</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <!-- a value set and flexibility -->
    <xs:attribute name="valueSet" type="BasicIdOrOid" use="optional">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">Reference to a valueSet/@id or @name. References to @name are discouraged because they become ambiguous quickly.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="flexibility" type="StaticOrDynamicFlexibility" use="optional">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">Reference to a valueSet/@effectiveDate. Default is unspecified which means 'latest available version'.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <!-- coding strength -->
    <xs:attribute name="strength" type="CodingStrengthType" default="required" use="optional"/>
    <!-- version handling -->
    <xs:attributeGroup ref="VersionHandlingEffectiveDateOptional"/>
    <!-- removed after talks with users: not relevant for now and a can of worms should want it -->
    <!--<xs:attribute name="statusCode" type="ReleaseStatusCodeLifeCycle" use="optional">
                <xs:annotation>
                    <xs:documentation xml:lang="en-US">manages the status of the association itself</xs:documentation>
                </xs:annotation>
            </xs:attribute>-->
    <xs:attribute name="equivalence" type="EquivalencyType" use="optional">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">Rating of mapping between the concept to the associated code or a concept list to an associated value set</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <!-- Only relevant after compilation -->
    <xs:attributeGroup ref="TerminologyAssociationCompilationAttributes"/>
  </xs:complexType>
</xs:element>
Attribute terminologyAssociation / @conceptId
Namespace No namespace
Type Oid
Properties
use required
Facets
maxLength 255
pattern [0-2](\.(0|[1-9][0-9]*))*
Used by
Source
 
<xs:attribute name="conceptId" use="required" type="Oid"/>
Attribute terminologyAssociation / @conceptFlexibility
Namespace No namespace
Annotations
 
Refers to the concept/@effectiveDate if conceptId points to a real concept and not to conceptList or a concept under a conceptList.
Type StaticFlexibility
Type hierarchy
Properties
use optional
Facets
pattern \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Used by
Source
 
<xs:attribute name="conceptFlexibility" use="optional" type="StaticFlexibility">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Refers to the concept/@effectiveDate if conceptId points to a real concept and not to conceptList or a concept under a conceptList.</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute terminologyAssociation / @code
Namespace No namespace
Type EnumerationString
Properties
use optional
Facets
maxLength 128
Used by
Source
 
<xs:attribute name="code" use="optional" type="EnumerationString"/>
Attribute terminologyAssociation / @codeSystem
Namespace No namespace
Type Oid
Properties
use optional
Facets
maxLength 255
pattern [0-2](\.(0|[1-9][0-9]*))*
Used by
Source
 
<xs:attribute name="codeSystem" use="optional" type="Oid"/>
Attribute terminologyAssociation / @codeSystemName
Namespace No namespace
Type NonEmptyString
Properties
use optional
Facets
minLength 1
Used by
Source
 
<xs:attribute name="codeSystemName" use="optional" type="NonEmptyString"/>
Attribute terminologyAssociation / @valueSet
Namespace No namespace
Annotations
 
Reference to a valueSet/@id or @name. References to @name are discouraged because they become ambiguous quickly.
Type BasicIdOrOid
Properties
use optional
Used by
Source
 
<xs:attribute name="valueSet" type="BasicIdOrOid" use="optional">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Reference to a valueSet/@id or @name. References to @name are discouraged because they become ambiguous quickly.</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute terminologyAssociation / @flexibility
Namespace No namespace
Annotations
 
Reference to a valueSet/@effectiveDate. Default is unspecified which means 'latest available version'.
Type StaticOrDynamicFlexibility
Properties
use optional
Used by
Source
 
<xs:attribute name="flexibility" type="StaticOrDynamicFlexibility" use="optional">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Reference to a valueSet/@effectiveDate. Default is unspecified which means 'latest available version'.</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute terminologyAssociation / @strength
Namespace No namespace
Type CodingStrengthType
Properties
use optional
default required
Facets
enumeration CNE 
deprecated: use required. Required/CNE. Coded with no exceptions; this element SHALL be from the specified value set
 
deprecated: gebruik required. Verplicht/CNE. Gecodeerd, geen uitzonderingen; dit element MOET uit de gespecificeerde waardenlijst komen
 
deprecated: use required. Erforderlich/CNE. Codiert, keine Ausnahmen; das Element muss aus dem angegebene Value Set kommen.
enumeration required 
Required/CNE. Coded with no exceptions; this element SHALL be from the specified value set
 
Verplicht/CNE. Gecodeerd, geen uitzonderingen; dit element MOET uit de gespecificeerde waardenlijst komen
 
Erforderlich/CNE. Codiert, keine Ausnahmen; das Element muss aus dem angegebene Value Set kommen.
enumeration CWE 
deprecated, use extensible. Extensible/CWE. Coded with Exceptions; this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated. If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.
 
deprecated, gebruik extensible. Uitbreidbaar/CWE. Gecodeerde uitzonderingen toegestaan; dit element MOET uit de gespecificeerde waardenlijst komen als een van de codes binnen de waardenlijst van toepassing is op het concept dat wordt gecommuniceerd. Als de waarde het concept niet dekt (op basis van menselijke beoordeling), kunnen in plaats daarvan alternatieve coderingen (of datatype waarmee wordt toegestaan, tekst) worden opgenomen.
 
deprecated, use extensible. Erweiterbar/CWE. Codiert, Ausnahmen zugelassen; Dieses Element sollte aus dem angegebenen Value Set kommen, wenn das Konzept kommuniziert wird. Wenn der Code das Konzept nicht abdeckt (basierend auf menschlicher Überprüfung), können alternative Kodierungen (oder falls der Datentyp es erlaubt, Text) eingeschlossen sein.
enumeration extensible 
Extensible/CWE. Coded with Exceptions; this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated. If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.
 
Uitbreidbaar/CWE. Gecodeerde uitzonderingen toegestaan; dit element MOET uit de gespecificeerde waardenlijst komen als een van de codes binnen de value set van toepassing is op het concept dat wordt gecommuniceerd. Als de waarde het concept niet dekt (op basis van menselijke beoordeling), kunnen in plaats daarvan alternatieve coderingen (of datatype waarmee wordt toegestaan, tekst) worden opgenomen.
 
Erweiterbar/CWE. Codiert, Ausnahmen zugelassen; Dieses Element sollte aus dem angegebenen Value Set kommen, wenn das Konzept kommuniziert wird. Wenn der Code das Konzept nicht abdeckt (basierend auf menschlicher Überprüfung), können alternative Kodierungen (oder falls der Datentyp es erlaubt, Text) eingeschlossen sein.
enumeration preferred 
Preferred. Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.
 
Voorkeur. Instantiaties worden aangemoedigd om voor interoperabiliteitsdoeleinden codes op basis van de gespecificeerde waardenlijst te gebruiken.
 
Bevorzugt. Instanzen werden aufgefordert, für Interoperabilitätszwecke die Codes aus dem Value Set zu nutzen.
enumeration example 
Example. Instances are not expected or even encouraged to draw from the specified value set. The value set merely provides examples of the types of concepts intended to be included.
 
Voorbeeld. Instantiaties worden niet verwacht of zelfs maar aangemoedigd om codes op basis van de gespecificeerde waardenlijst te gebruiken. De waardenlijst stelt een voorbeeld voor van het type concept dat gebruikt kan worden.
 
Beispiel. Es wird in Instanzen nicht erwartet, dass der Code aus  dem Value Set genutzt wird. Das Value Set enthält Beispiele für den Typ Konzept, die verwendet werden können.
Used by
Source
 
<xs:attribute name="strength" type="CodingStrengthType" default="required" use="optional"/>
Attribute terminologyAssociation / @equivalence
Namespace No namespace
Annotations
 
Rating of mapping between the concept to the associated code or a concept list to an associated value set
Type EquivalencyType
Properties
use optional
Facets
enumeration relatedto 
The concepts are related to each other, and have at least some overlap in meaning, but the exact relationship is not known
enumeration equivalent 
The definitions of the concepts mean the same thing (including when structural implications of meaning are considered) (i.e. extensionally identical).
ISO 12300: 2 = Equivalence of meaning, but with synonymy. For example, ureteric calculus and ureteric stone; gall stones and cholelithiasis
enumeration equal 
The definitions of the concepts are exactly the same (i.e. only grammatical differences) and structural implications of meaning are identical or irrelevant (i.e. intentionally identical).
ISO 12300: 1 = Equivalence of meaning; lexical, as well as conceptual. For example, asthma and asthma; ovarian cyst and cyst of ovary.
enumeration wider 
The source concept is broader in meaning than the target concept.
ISO 12300: 3 = Source concept is broader and has a less specific meaning than the target concept/term. For example, obesity and morbid obesity; diabetes and diabetes mellitus type II.
enumeration subsumes 
The target concept subsumes the meaning of the source concept (e.g. the source is-a target)
enumeration narrower 
The source concept is narrower in meaning than the target concept. The sense in which the mapping is narrower SHALL be described in the comments in this case, and applications should be careful when attempting to use these mappings operationally.
ISO 12300: 4 = Source concept is narrower and has a more specific meaning than the target concept/term. For example, feels ugly and self-image finding; acute renal failure syndrome secondary to dehydration and acute renal failure syndrome.
enumeration specializes 
The target concept specializes the meaning of the source concept (e.g. the target is-a source)
enumeration inexact 
The mappings overlap, but both source and target cover additional meaning, or the definitions are imprecise and it is uncertain whether they have the same boundaries to their meaning. The sense in which the mapping is different SHALL be described in the comments in this case, and applications should be careful when attempting to use these mappings operationally.
enumeration unmatched 
There is no match for this concept in the destination concept system.
ISO 12300: 5 = No map is possible. No concept was found in the target with some degree of equivalence (as measured by any of the other four ratings).
enumeration disjoint 
This is an explicit assertion that there is no mapping between the source and target concept.
Used by
Source
 
<xs:attribute name="equivalence" type="EquivalencyType" use="optional">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Rating of mapping between the concept to the associated code or a concept list to an associated value set</xs:documentation>
  </xs:annotation>
</xs:attribute>
XML Schema documentation generated by ® XML Editor.