Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions

Hl7nl\extension-nl-core-humanname.xml

Raw XML (canonical form)

nl-core-humanname

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="nl-core-humanname"/>
  <meta>
    <lastUpdated value="2015-09-22T20:02:49.724+10:00"/>
  </meta>
  <url value="http://fhir.nl/fhir/StructureDefinition/nl-core-humanname"/>
  <name value="nl-core-humanname"/>
  <status value="draft"/>
  <contact>
    <name value="HL7 Netherlands"/>
  </contact>
  <date value="2015-09-22T20:02:49+10:00"/>
  <description value="Base StructureDefinition for HumanName Type with additions for Dutch realm names. Dutch
   names break down the family into maximum of 4 parts that are important to know separately
   in some use cases."/>
  <requirements value="Need to be able to record names, along with notes about their use."/>
  <fhirVersion value="1.0.1"/>
  <mapping>
    <identity value="v2"/>
    <uri value="http://hl7.org/v2"/>
    <name value="HL7 v2"/>
  </mapping>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <mapping>
    <identity value="servd"/>
    <uri value="http://www.omg.org/spec/ServD/1.0/"/>
    <name value="ServD"/>
  </mapping>
  <kind value="datatype"/>
  <constrainedType value="HumanName"/>
  <abstract value="false"/>
  <base value="http://hl7.org/fhir/StructureDefinition/HumanName"/>
  <snapshot>
    <element>
      <path value="HumanName"/>
      <short value="Name of a human - parts and usage"/>
      <definition value="A human's name with the ability to identify parts and usage."/>
      <comments value="Names may be changed, or repudiated, or people may have different names in different contexts.
       Names may be divided into parts of different type that have variable significance depending
       on context, though the division into parts does not always matter. With personal names,
       the different parts may or may not be imbued with some implicit meaning; various cultures
       associate different importance with the name parts and the degree to which systems must
       care about name parts around the world varies widely.  A Dutch HumanName is a proper FHIR
       HumanName. Systems that do not understand any of the extensions, will be able to render
       and work with a Dutch name. Dutch names make certain name parts seaprately communicable.
       These parts are required for use in true Dutch systems when dealing with Dutch names,
       but may not have value for international systems when information gets sent abroad.  To
       have true compatibility an implementer SHOULD use the core HumanName parts as intended.
       To have names work for Dutch context, the implementer SHOULD in addition use the extension
       elements.  The extension elements cover birth name (NL: eigennaam) and partner name. Both
       may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own
       name, assume the partner name, append the partner name to their own name, or the other
       way around.  For this reason, the the extension do not have explicit names like &quot;prefix
       spouse&quot;, because a person may not have a spouse, or may not have assumed their names.
       Each extension supports a qualifier to mark what it is.  Example: miss Irma Jongeneel
       marries mister de Haas and assumes the name Irma Jongeneel-de Haas family = &quot;Jongeneel-de
       Haas&quot; given = &quot;Irma&quot; family-name-part1 = &quot;Jongeneel&quot; (qualifier=BR)
       family-name-part2-prefix = &quot;de &quot; (qualifier=VV) family-name-part2-prefix = &quot;Haas&quot
      ; (qualifier=SP)"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="HumanName"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="HumanName"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="XPN"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="EN (actually, PN)"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="ProviderName"/>
      </mapping>
    </element>
    <element>
      <path value="HumanName.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="HumanName.id"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="HumanName.extension"/>
      <slicing>
        <discriminator value="url"/>
        <rules value="openAtEnd"/>
      </slicing>
      <short value="Extension"/>
      <definition value="An Extension"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="HumanName.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
    </element>
    <element>
      <path value="HumanName.extension"/>
      <name value="family-name-part1-prefix"/>
      <short value="family-name-part-prefix"/>
      <definition value="Optional Extensions Element - found in all resources."/>
      <comments value="Officially recognized family name prefixes  may be found in BRP/GBA Table 36 &quot;Voorvoegsels&quot
      ;"/>
      <alias value="voorvoegsel"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="HumanName.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
        <profile value="http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname-prefix"/>
      </type>
    </element>
    <element>
      <path value="HumanName.extension"/>
      <name value="family-name-part1"/>
      <short value="family-name-part"/>
      <definition value="Optional Extensions Element - found in all resources."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="HumanName.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
        <profile value="http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname"/>
      </type>
    </element>
    <element>
      <path value="HumanName.extension"/>
      <name value="family-name-part2-prefix"/>
      <short value="family-name-part2-prefix"/>
      <definition value="Optional Extensions Element - found in all resources."/>
      <comments value="Officially recognized family name prefixes  may be found in BRP/GBA Table 36 &quot;Voorvoegsels&quot
      ;"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="HumanName.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
        <profile value="http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname-prefix"/>
      </type>
    </element>
    <element>
      <path value="HumanName.extension"/>
      <name value="family-name-part2"/>
      <short value="family-name-part2"/>
      <definition value="Optional Extensions Element - found in all resources."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="HumanName.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
        <profile value="http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname"/>
      </type>
    </element>
    <element>
      <path value="HumanName.use"/>
      <short value="usual | official | temp | nickname | anonymous | old | maiden"/>
      <definition value="Identifies the purpose for this name."/>
      <comments value="This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary
       or old name etc.for a current/permanent one. Applications can assume that a name is current
       unless it explicitly says that it is temporary or old."/>
      <requirements value="Allows the appropriate name for a particular context of use to be selected from among
       a set of names."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="HumanName.use"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <binding>
        <strength value="required"/>
        <description value="The use of a human name"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/name-use"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="XPN.7, but often indicated by which field contains the name"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="unique(./use)"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="./NamePurpose"/>
      </mapping>
    </element>
    <element>
      <path value="HumanName.text"/>
      <short value="Text representation of the full name"/>
      <definition value="A full text representation of the name."/>
      <comments value="Can provide both a text representation and structured parts."/>
      <requirements value="A renderable, unencoded form."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="HumanName.text"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="implied by XPN.11"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./formatted"/>
      </mapping>
    </element>
    <element>
      <path value="HumanName.family"/>
      <short value="Family name (often called 'Surname')"/>
      <definition value="The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family
       name of a son is the first name of his father."/>
      <comments value="For family name, hyphenated names such as &quot;Smith-Jones&quot; are a single name, but
       names with spaces such as &quot;Smith Jones&quot; are broken into multiple parts."/>
      <alias value="surname"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="HumanName.family"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="XPN.1"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./part[partType = FAM]"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="./FamilyName"/>
      </mapping>
    </element>
    <element>
      <path value="HumanName.given"/>
      <short value="Given names (not always 'first'). Includes middle names"/>
      <definition value="Given name."/>
      <comments value="If only initials are recorded, they may be used in place of the full name.  Not called
       &quot;first name&quot; since given names do not always come first."/>
      <alias value="first name"/>
      <alias value="middle name"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="HumanName.given"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="XPN.2 + XPN.3"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./part[partType = GIV]"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="./GivenNames"/>
      </mapping>
    </element>
    <element>
      <path value="HumanName.prefix"/>
      <short value="Parts that come before the name"/>
      <definition value="Part of the name that is acquired as a title due to academic, legal, employment or nobility
       status, etc. and that appears at the start of the name."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="HumanName.prefix"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="XPN.5"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./part[partType = PFX]"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="./TitleCode"/>
      </mapping>
    </element>
    <element>
      <path value="HumanName.suffix"/>
      <short value="Parts that come after the name"/>
      <definition value="Part of the name that is acquired as a title due to academic, legal, employment or nobility
       status, etc. and that appears at the end of the name."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="HumanName.suffix"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="XPN/4"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./part[partType = SFX]"/>
      </mapping>
    </element>
    <element>
      <path value="HumanName.period"/>
      <short value="Time period when name was/is in use"/>
      <definition value="Indicates the period of time when this name was valid for the named person."/>
      <requirements value="Allows names to be placed in historical context."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="HumanName.period"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Period"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="XPN.13 + XPN.14"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./usablePeriod[type=&quot;IVL&lt;TS&gt;&quot;]"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="./StartDate and ./EndDate"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="HumanName"/>
      <short value="Name of a human - parts and usage"/>
      <definition value="A human's name with the ability to identify parts and usage."/>
      <comments value="Names may be changed, or repudiated, or people may have different names in different contexts.
       Names may be divided into parts of different type that have variable significance depending
       on context, though the division into parts does not always matter. With personal names,
       the different parts may or may not be imbued with some implicit meaning; various cultures
       associate different importance with the name parts and the degree to which systems must
       care about name parts around the world varies widely.  A Dutch HumanName is a proper FHIR
       HumanName. Systems that do not understand any of the extensions, will be able to render
       and work with a Dutch name. Dutch names make certain name parts seaprately communicable.
       These parts are required for use in true Dutch systems when dealing with Dutch names,
       but may not have value for international systems when information gets sent abroad.  To
       have true compatibility an implementer SHOULD use the core HumanName parts as intended.
       To have names work for Dutch context, the implementer SHOULD in addition use the extension
       elements.  The extension elements cover birth name (NL: eigennaam) and partner name. Both
       may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own
       name, assume the partner name, append the partner name to their own name, or the other
       way around.  For this reason, the the extension do not have explicit names like &quot;prefix
       spouse&quot;, because a person may not have a spouse, or may not have assumed their names.
       Each extension supports a qualifier to mark what it is.  Example: miss Irma Jongeneel
       marries mister de Haas and assumes the name Irma Jongeneel-de Haas family = &quot;Jongeneel-de
       Haas&quot; given = &quot;Irma&quot; family-name-part1 = &quot;Jongeneel&quot; (qualifier=BR)
       family-name-part2-prefix = &quot;de &quot; (qualifier=VV) family-name-part2-prefix = &quot;Haas&quot
      ; (qualifier=SP)"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="HumanName"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="XPN"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="EN (actually, PN)"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <map value="ProviderName"/>
      </mapping>
    </element>
    <element>
      <path value="HumanName.extension"/>
      <slicing>
        <discriminator value="url"/>
        <rules value="openAtEnd"/>
      </slicing>
    </element>
    <element>
      <path value="HumanName.extension"/>
      <name value="family-name-part1-prefix"/>
      <short value="family-name-part-prefix"/>
      <definition value="Optional Extensions Element - found in all resources."/>
      <comments value="Officially recognized family name prefixes  may be found in BRP/GBA Table 36 &quot;Voorvoegsels&quot
      ;"/>
      <alias value="voorvoegsel"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Extension"/>
        <profile value="http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname-prefix"/>
      </type>
    </element>
    <element>
      <path value="HumanName.extension"/>
      <name value="family-name-part1"/>
      <short value="family-name-part"/>
      <definition value="Optional Extensions Element - found in all resources."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Extension"/>
        <profile value="http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname"/>
      </type>
    </element>
    <element>
      <path value="HumanName.extension"/>
      <name value="family-name-part2-prefix"/>
      <short value="family-name-part2-prefix"/>
      <definition value="Optional Extensions Element - found in all resources."/>
      <comments value="Officially recognized family name prefixes  may be found in BRP/GBA Table 36 &quot;Voorvoegsels&quot
      ;"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Extension"/>
        <profile value="http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname-prefix"/>
      </type>
    </element>
    <element>
      <path value="HumanName.extension"/>
      <name value="family-name-part2"/>
      <short value="family-name-part2"/>
      <definition value="Optional Extensions Element - found in all resources."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Extension"/>
        <profile value="http://fhir.nl/fhir/StructureDefinition/nl-core-humanname-familyname"/>
      </type>
    </element>
  </differential>
</StructureDefinition>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.