This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: TN - XML Profile

XML representation of the TN logical model.

Raw xml | Download

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="TN"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>A restriction of entity name that is effectively a simple string used for a simple name for things and places.</p>
    </div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-no-order">
    <valueBoolean value="true"/>
  </extension>
  <url value="http://hl7.org/fhir/cda/StructureDefinition/TN"/>
  <version value="2.1.0-draft1"/>
  <name value="TN"/>
  <title value="TN: TrivialName (V3 Data Type)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2023-01-16T16:39:50+11:00"/>
  <publisher value="Health Level 7"/>
  <contact>
    <name value="HL7 International - Cross-Group Projects"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cgp"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="cgp@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="A restriction of entity name that is effectively a simple string used for a simple name for things and places."/>
  <fhirVersion value="5.0.0-snapshot3"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="EN"/>
  <baseDefinition value="http://hl7.org/fhir/cda/StructureDefinition/EN"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="EN">
      <path value="EN"/>
      <short value="Base for all types and resources"/>
      <definition
                  value="A restriction of entity name that is effectively a simple string used for a simple name for things and places."/>
      <min value="1"/>
      <max value="*"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <constraint>
        <key value="ele-1"/>
        <severity value="error"/>
        <human value="All FHIR elements must have a @value or children"/>
        <expression
                    value="hasValue() or (children().count() &gt; id.count())"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
      </constraint>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="EN.nullFlavor">
      <path value="EN.nullFlavor"/>
      <representation value="xmlAttr"/>
      <label value="Exceptional Value Detail"/>
      <definition
                  value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ANY.nullFlavor"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-NullFlavor"/>
      </binding>
    </element>
    <element id="EN.use">
      <path value="EN.use"/>
      <representation value="xmlAttr"/>
      <label value="Use Code"/>
      <definition
                  value="A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="EN.use"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-EntityNameUse"/>
      </binding>
    </element>
    <element id="EN.delimiter">
      <path value="EN.delimiter"/>
      <min value="0"/>
      <max value="0"/>
      <base>
        <path value="EN.delimiter"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/ENXP"/>
      </type>
    </element>
    <element id="EN.family">
      <path value="EN.family"/>
      <min value="0"/>
      <max value="0"/>
      <base>
        <path value="EN.family"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/ENXP"/>
      </type>
    </element>
    <element id="EN.given">
      <path value="EN.given"/>
      <min value="0"/>
      <max value="0"/>
      <base>
        <path value="EN.given"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/ENXP"/>
      </type>
    </element>
    <element id="EN.prefix">
      <path value="EN.prefix"/>
      <min value="0"/>
      <max value="0"/>
      <base>
        <path value="EN.prefix"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/ENXP"/>
      </type>
    </element>
    <element id="EN.suffix">
      <path value="EN.suffix"/>
      <min value="0"/>
      <max value="0"/>
      <base>
        <path value="EN.suffix"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/ENXP"/>
      </type>
    </element>
    <element id="EN.other">
      <path value="EN.other"/>
      <representation value="xmlText"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="EN.other"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="EN.validTime">
      <path value="EN.validTime"/>
      <label value="Valid Time"/>
      <definition
                  value="An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="EN.validTime"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/fhir/cda/StructureDefinition/IVL-TS"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="EN">
      <path value="EN"/>
      <definition
                  value="A restriction of entity name that is effectively a simple string used for a simple name for things and places."/>
      <min value="1"/>
      <max value="*"/>
    </element>
    <element id="EN.use">
      <path value="EN.use"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-EntityNameUse"/>
      </binding>
    </element>
    <element id="EN.delimiter">
      <path value="EN.delimiter"/>
      <min value="0"/>
      <max value="0"/>
    </element>
    <element id="EN.family">
      <path value="EN.family"/>
      <min value="0"/>
      <max value="0"/>
    </element>
    <element id="EN.given">
      <path value="EN.given"/>
      <min value="0"/>
      <max value="0"/>
    </element>
    <element id="EN.prefix">
      <path value="EN.prefix"/>
      <min value="0"/>
      <max value="0"/>
    </element>
    <element id="EN.suffix">
      <path value="EN.suffix"/>
      <min value="0"/>
      <max value="0"/>
    </element>
  </differential>
</StructureDefinition>