HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)

This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions

PersonNameModel


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="cimi-element-PersonName-model"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC PersonName Logical Model</b></p>
  <p>A name used by a human being, written as it would be typically expressed. May include a breakdown of the various elements of the name (family name, given name, etc.).</p>
</div>
  </text>
  <url
       value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-element-PersonName-model"/>
  <identifier>
    <system value="http://hl7.org/fhir/us/breastcancer"/>
    <value value="cimi.element.PersonName"/>
  </identifier>
  <version value="0.2.0"/>
  <name value="PersonNameModel"/>
  <title value="BC PersonName Logical Model"/>
  <status value="draft"/>
  <date value="2018-08-17T00:00:00+10:00"/>
  <publisher
             value="The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cic/index.cfm"/>
    </telecom>
  </contact>
  <description
               value="A name used by a human being, written as it would be typically expressed. May include a breakdown of the various elements of the name (family name, given name, etc.)."/>
  <keyword>
    <system value="http://ncimeta.nci.nih.gov"/>
    <code value="C1547383"/>
  </keyword>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="cimi-element-PersonName-model"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="cimi-element-PersonName-model">
      <path value="cimi-element-PersonName-model"/>
      <definition
                  value="A name used by a human being, written as it would be typically expressed. May include a breakdown of the various elements of the name (family name, given name, etc.)."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-element-PersonName-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.nameAsText">
      <path value="cimi-element-PersonName-model.nameAsText"/>
      <short value="The name as plain unstructured or semi-structured text."/>
      <definition
                  value="The name as plain unstructured or semi-structured text."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-element-PersonName-model.nameAsText"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.purpose">
      <path value="cimi-element-PersonName-model.purpose"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0805701"/>
      </code>
      <short value="Why the item is used."/>
      <definition value="Why the item is used."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-element-PersonName-model.purpose"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/name-use"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-element-PersonName-model.effectiveTimePeriod">
      <path value="cimi-element-PersonName-model.effectiveTimePeriod"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C2985763"/>
      </code>
      <short
             value="The date and time span for which something is active, valid, or in force."/>
      <definition
                  value="The date and time span for which something is active, valid, or in force."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-element-PersonName-model.effectiveTimePeriod"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-EffectiveTimePeriod-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.prefix">
      <path value="cimi-element-PersonName-model.prefix"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C3476361"/>
      </code>
      <short
             value="Contains a set of honorific terms that typically appear before a person&#39;s name, for example Mr., Mrs., Dr., etc."/>
      <definition
                  value="Contains a set of honorific terms that typically appear before a person&#39;s name, for example Mr., Mrs., Dr., etc."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-element-PersonName-model.prefix"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.givenName">
      <path value="cimi-element-PersonName-model.givenName"/>
      <code>
        <system value="http://loinc.org"/>
        <code value="45392-8"/>
      </code>
      <code>
        <system value="http://snomed.info/sct"/>
        <code value="408677003"/>
      </code>
      <short value="The person&#39;s given name - e.g., John"/>
      <definition value="The person&#39;s given name - e.g., John"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-element-PersonName-model.givenName"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.middleName">
      <path value="cimi-element-PersonName-model.middleName"/>
      <code>
        <system value="http://loinc.org"/>
        <code value="45392-8"/>
      </code>
      <code>
        <system value="http://snomed.info/sct"/>
        <code value="408677003"/>
      </code>
      <short value="The person&#39;s middle name."/>
      <definition value="The person&#39;s middle name."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-element-PersonName-model.middleName"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.familyName">
      <path value="cimi-element-PersonName-model.familyName"/>
      <code>
        <system value="http://loinc.org"/>
        <code value="45394-4"/>
      </code>
      <short
             value="The portion of a person&#39;s name that reflects the genealogy of the person. In western cultures, this is the &#39;last&#39; name. In eastern cultures, the family name appears before the person&#39;s given name(s). In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. (Source: HL7 V3)."/>
      <definition
                  value="The portion of a person&#39;s name that reflects the genealogy of the person. In western cultures, this is the &#39;last&#39; name. In eastern cultures, the family name appears before the person&#39;s given name(s). In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. (Source: HL7 V3)."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-element-PersonName-model.familyName"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.suffix">
      <path value="cimi-element-PersonName-model.suffix"/>
      <code>
        <system value="http://loinc.org"/>
        <code value="45395-1"/>
      </code>
      <code>
        <system value="http://snomed.info/sct"/>
        <code value="715196001"/>
      </code>
      <short
             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."/>
      <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="cimi-element-PersonName-model.suffix"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </snapshot>
  <differential>
    <element id="cimi-element-PersonName-model">
      <path value="cimi-element-PersonName-model"/>
      <definition
                  value="A name used by a human being, written as it would be typically expressed. May include a breakdown of the various elements of the name (family name, given name, etc.)."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-element-PersonName-model"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.nameAsText">
      <path value="cimi-element-PersonName-model.nameAsText"/>
      <short value="The name as plain unstructured or semi-structured text."/>
      <definition
                  value="The name as plain unstructured or semi-structured text."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-element-PersonName-model.nameAsText"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.purpose">
      <path value="cimi-element-PersonName-model.purpose"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C0805701"/>
      </code>
      <short value="Why the item is used."/>
      <definition value="Why the item is used."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-element-PersonName-model.purpose"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/name-use"/>
        </valueSetReference>
      </binding>
    </element>
    <element id="cimi-element-PersonName-model.effectiveTimePeriod">
      <path value="cimi-element-PersonName-model.effectiveTimePeriod"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C2985763"/>
      </code>
      <short
             value="The date and time span for which something is active, valid, or in force."/>
      <definition
                  value="The date and time span for which something is active, valid, or in force."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="cimi-element-PersonName-model.effectiveTimePeriod"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-EffectiveTimePeriod-model"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.prefix">
      <path value="cimi-element-PersonName-model.prefix"/>
      <code>
        <system value="http://ncimeta.nci.nih.gov"/>
        <code value="C3476361"/>
      </code>
      <short
             value="Contains a set of honorific terms that typically appear before a person&#39;s name, for example Mr., Mrs., Dr., etc."/>
      <definition
                  value="Contains a set of honorific terms that typically appear before a person&#39;s name, for example Mr., Mrs., Dr., etc."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-element-PersonName-model.prefix"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.givenName">
      <path value="cimi-element-PersonName-model.givenName"/>
      <code>
        <system value="http://loinc.org"/>
        <code value="45392-8"/>
      </code>
      <code>
        <system value="http://snomed.info/sct"/>
        <code value="408677003"/>
      </code>
      <short value="The person&#39;s given name - e.g., John"/>
      <definition value="The person&#39;s given name - e.g., John"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-element-PersonName-model.givenName"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.middleName">
      <path value="cimi-element-PersonName-model.middleName"/>
      <code>
        <system value="http://loinc.org"/>
        <code value="45392-8"/>
      </code>
      <code>
        <system value="http://snomed.info/sct"/>
        <code value="408677003"/>
      </code>
      <short value="The person&#39;s middle name."/>
      <definition value="The person&#39;s middle name."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-element-PersonName-model.middleName"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.familyName">
      <path value="cimi-element-PersonName-model.familyName"/>
      <code>
        <system value="http://loinc.org"/>
        <code value="45394-4"/>
      </code>
      <short
             value="The portion of a person&#39;s name that reflects the genealogy of the person. In western cultures, this is the &#39;last&#39; name. In eastern cultures, the family name appears before the person&#39;s given name(s). In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. (Source: HL7 V3)."/>
      <definition
                  value="The portion of a person&#39;s name that reflects the genealogy of the person. In western cultures, this is the &#39;last&#39; name. In eastern cultures, the family name appears before the person&#39;s given name(s). In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. (Source: HL7 V3)."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="cimi-element-PersonName-model.familyName"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
    <element id="cimi-element-PersonName-model.suffix">
      <path value="cimi-element-PersonName-model.suffix"/>
      <code>
        <system value="http://loinc.org"/>
        <code value="45395-1"/>
      </code>
      <code>
        <system value="http://snomed.info/sct"/>
        <code value="715196001"/>
      </code>
      <short
             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."/>
      <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="cimi-element-PersonName-model.suffix"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <mustSupport value="false"/>
      <isModifier value="false"/>
      <isSummary value="false"/>
    </element>
  </differential>
</StructureDefinition>