Consolidated CDA (C-CDA)
4.0.0-ballot - STU4
Consolidated CDA (C-CDA)
4.0.0-ballot - STU4
Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
| Draft as of 2024-11-21 |
XML representation of the USRealmPatientNamePTNUSFIELDED logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="USRealmPatientNamePTNUSFIELDED"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition USRealmPatientNamePTNUSFIELDED</b></p><a name="USRealmPatientNamePTNUSFIELDED"> </a><a name="hcUSRealmPatientNamePTNUSFIELDED"> </a><a name="USRealmPatientNamePTNUSFIELDED-en-US"> </a><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmPatientNamePTNUSFIELDED-definitions.html#PN">PN</a><a name="PN"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( shall-family, shall-given, shall-max-suffix, 81-7278 )">C</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-PN.html">PN</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">XML Namespace: </span>urn:hl7-org:v3<br/>Elements defined in Ancestors:<a href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ANY.html" title="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.">@nullFlavor</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-EN.html" title="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">@use</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-EN.html" title="A series of items that constitute the name.">item</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-EN.html" title="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.">validTime</a>, <a href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-PN.html">item</a><br/><span style="opacity: 0.5">Base for all types and resources</span><br/><span style="font-weight:bold" title="The root class that contains instances of this class">Logical Container: </span><a href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ClinicalDocument.html">ClinicalDocument (CDA Class)</a><br/><span style="font-weight:bold">shall-family: </span>SHALL contain exactly one [1..1] family (CONF:81-7159).<br/><span style="font-weight:bold">shall-given: </span>SHALL contain at least one [1..*] given (CONF:81-7157).<br/><span style="font-weight:bold">shall-max-suffix: </span>There may be at most one suffix<br/><span style="font-weight:bold">81-7278: </span>**SHALL NOT** have mixed content except for white space (CONF:81-7278).</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmPatientNamePTNUSFIELDED-definitions.html#PN.use">@use</a><a name="PN.use"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span>..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-cs-simple.html" title="code">cs</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck11.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmPatientNamePTNUSFIELDED-definitions.html#PN.item">item</a><a name="PN.item"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck111.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmPatientNamePTNUSFIELDED-definitions.html#PN.item.family">family</a><a name="PN.item.family"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ENXP.html">ENXP</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">𝗨𝗦𝗖𝗗𝗜: Last Name</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1100.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmPatientNamePTNUSFIELDED-definitions.html#PN.item.family.qualifier">@qualifier</a><a name="PN.item.family.qualifier"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span>..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-cs-simple.html" title="code">cs</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.26/expansion" title="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26">EntityPersonNamePartQualifier <img src="external.png" alt="."/></a> (<a href="http://hl7.org/fhir/R5/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">required</a>)</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck111.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmPatientNamePTNUSFIELDED-definitions.html#PN.item.given">given</a><a name="PN.item.given"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ENXP.html">ENXP</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1100.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmPatientNamePTNUSFIELDED-definitions.html#PN.item.given.qualifier">@qualifier</a><a name="PN.item.given.qualifier"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span>..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-cs-simple.html" title="code">cs</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">𝗨𝗦𝗖𝗗𝗜: callMe meets the USCDI 'Name to use' requirement<br/><span style="font-weight:bold">Binding: </span><a href="https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.26/expansion" title="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26">EntityPersonNamePartQualifier <img src="external.png" alt="."/></a> (<a href="http://hl7.org/fhir/R5/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">required</a>)</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck111.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmPatientNamePTNUSFIELDED-definitions.html#PN.item.prefix">prefix</a><a name="PN.item.prefix"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ENXP.html">ENXP</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1100.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmPatientNamePTNUSFIELDED-definitions.html#PN.item.prefix.qualifier">@qualifier</a><a name="PN.item.prefix.qualifier"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span>..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-cs-simple.html" title="code">cs</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.26/expansion" title="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26">EntityPersonNamePartQualifier <img src="external.png" alt="."/></a> (<a href="http://hl7.org/fhir/R5/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">required</a>)</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck101.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmPatientNamePTNUSFIELDED-definitions.html#PN.item.suffix">suffix</a><a name="PN.item.suffix"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-ENXP.html">ENXP</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">𝗨𝗦𝗖𝗗𝗜: Suffix</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1000.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmPatientNamePTNUSFIELDED-definitions.html#PN.item.suffix.qualifier">@qualifier</a><a name="PN.item.suffix.qualifier"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span>..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-cs-simple.html" title="code">cs</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="https://vsac.nlm.nih.gov/valueset/2.16.840.1.113883.11.20.9.26/expansion" title="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26">EntityPersonNamePartQualifier <img src="external.png" alt="."/></a> (<a href="http://hl7.org/fhir/R5/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">required</a>)</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-USRealmPatientNamePTNUSFIELDED-definitions.html#PN.validTime">validTime</a><a name="PN.validTime"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="https://build.fhir.org/ig/HL7/CDA-core-sd/StructureDefinition-IVL-TS.html">IVL_TS</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">𝗨𝗦𝗖𝗗𝗜: Previous Name - Available for use to identify the time period when name was/is in use.</td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/logical-target">
<valueBoolean>
<extension
url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
<valueCode value="not-applicable"/>
</extension>
</valueBoolean>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
<valueUri value="urn:hl7-org:v3"/>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/xml-name">
<valueString value="name"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/logical-container">
<valueUri
value="http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"/>
</extension>
<url
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"/>
<identifier>
<value value="urn:oid:2.16.840.1.113883.10.20.22.5.1"/>
</identifier>
<version value="4.0.0-ballot"/>
<name value="USRealmPatientNamePTNUSFIELDED"/>
<title value="US Realm Patient Name (PTN.US.FIELDED)"/>
<status value="draft"/>
<date value="2024-11-21T20:34:36+00:00"/>
<publisher value="Health Level Seven"/>
<contact>
<name value="HL7 International - Structured Documents"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/structure"/>
</telecom>
</contact>
<description
value="The US Realm Patient Name datatype flavor is a set of reusable constraints that can be used for the patient or any other person. It requires a first (given) and last (family) name. If a patient or person has only one name part (e.g., patient with first name only) place the name part in the field required by the organization. Use the appropriate nullFlavor, "Not Applicable" (NA), in the other field.
For information on mixed content see the Extensible Markup Language reference (http://www.w3c.org/TR/2008/REC-xml-20081126/)."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<fhirVersion value="5.0.0"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type value="http://hl7.org/cda/stds/core/StructureDefinition/PN"/>
<baseDefinition
value="http://hl7.org/cda/stds/core/StructureDefinition/PN"/>
<derivation value="constraint"/>
<snapshot>
<element id="PN">
<path value="PN"/>
<short value="Base for all types and resources"/>
<definition
value="A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status)."/>
<min value="1"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="pn-no-ls"/>
<severity value="error"/>
<human value="No PN name part may have a qualifier of LS."/>
<expression
value="(item.delimiter | item.family | item.given | item.prefix | item.suffix).where(qualifier.where($this = 'LS').exists()).empty()"/>
<source value="http://hl7.org/cda/stds/core/StructureDefinition/PN"/>
</constraint>
<constraint>
<key value="shall-family"/>
<severity value="error"/>
<human
value="SHALL contain exactly one [1..1] family (CONF:81-7159)."/>
<expression value="nullFlavor.exists() or item.family.count() = 1"/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"/>
</constraint>
<constraint>
<key value="shall-given"/>
<severity value="error"/>
<human
value="SHALL contain at least one [1..*] given (CONF:81-7157)."/>
<expression value="nullFlavor.exists() or item.given.exists()"/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"/>
</constraint>
<constraint>
<key value="shall-max-suffix"/>
<severity value="error"/>
<human value="There may be at most one suffix"/>
<expression value="(item.suffix.empty() or item.suffix.count() = 1)"/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"/>
</constraint>
<constraint>
<key value="81-7278"/>
<severity value="error"/>
<human
value="**SHALL NOT** have mixed content except for white space (CONF:81-7278)."/>
<expression value="item.xmlText.empty()"/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="PN.nullFlavor">
<path value="PN.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"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
</binding>
</element>
<element id="PN.use">
<path value="PN.use"/>
<representation value="xmlAttr"/>
<label value="Use Code"/>
<short
value="If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced"/>
<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"/>
<comment
value="MAY contain zero or one [0..1] @use, which SHALL be selected from ValueSet EntityNameUse urn:oid:2.16.840.1.113883.1.11.15913 STATIC 2005-05-01 (CONF:81-7154)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EN.use"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse"/>
</binding>
</element>
<element id="PN.item">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group">
<valueBoolean value="true"/>
</extension>
<path value="PN.item"/>
<definition value="A series of items that constitute the name."/>
<min value="1"/>
<max value="*"/>
<base>
<path value="EN.item"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/fhir/StructureDefinition/Base"/>
</type>
<constraint>
<key value="EN-1"/>
<severity value="error"/>
<human
value="Can only have only one of the possible item elements in each choice"/>
<expression
value="(delimiter | family | given | prefix | suffix | xmlText).count() = 1"/>
<source value="http://hl7.org/cda/stds/core/StructureDefinition/EN"/>
</constraint>
</element>
<element id="PN.item.delimiter">
<path value="PN.item.delimiter"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="EN.item.delimiter"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ENXP"/>
</type>
</element>
<element id="PN.item.family">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="PN.item.family"/>
<short value="𝗨𝗦𝗖𝗗𝗜: Last Name"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="EN.item.family"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ENXP"/>
</type>
</element>
<element id="PN.item.family.nullFlavor">
<path value="PN.item.family.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"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
</binding>
</element>
<element id="PN.item.family.representation">
<path value="PN.item.family.representation"/>
<representation value="xmlAttr"/>
<definition
value="Specifies the representation of the binary data that is the content of the binary data value"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.representation"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="TXT"/>
</element>
<element id="PN.item.family.mediaType">
<path value="PN.item.family.mediaType"/>
<representation value="xmlAttr"/>
<label value="Media Type"/>
<definition
value="Identifies the type of the encapsulated data and identifies a method to interpret or render the data."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.mediaType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="text/plain"/>
</element>
<element id="PN.item.family.language">
<path value="PN.item.family.language"/>
<representation value="xmlAttr"/>
<label value="Language"/>
<definition
value="For character based information the language property specifies the human language of the text."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.language"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
</element>
<element id="PN.item.family.xmlText">
<path value="PN.item.family.xmlText"/>
<representation value="xmlText"/>
<short value="Allows for mixed text content"/>
<comment
value="This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.xmlText"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="PN.item.family.partType">
<path value="PN.item.family.partType"/>
<representation value="xmlAttr"/>
<label value="Name Part Type Code"/>
<definition
value="Indicates whether the name part is a given name, family name, prefix, suffix, etc."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ENXP.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-EntityNamePartType"/>
</binding>
</element>
<element id="PN.item.family.qualifier">
<path value="PN.item.family.qualifier"/>
<representation value="xmlAttr"/>
<label value="Qualifier Code"/>
<definition
value="qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records."/>
<comment
value="This family MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7160)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ENXP.qualifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"/>
</binding>
</element>
<element id="PN.item.given">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="PN.item.given"/>
<short value="𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name"/>
<comment
value="SHALL contain at least one [1..*] given (CONF:81-7157)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="EN.item.given"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ENXP"/>
</type>
</element>
<element id="PN.item.given.nullFlavor">
<path value="PN.item.given.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"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
</binding>
</element>
<element id="PN.item.given.representation">
<path value="PN.item.given.representation"/>
<representation value="xmlAttr"/>
<definition
value="Specifies the representation of the binary data that is the content of the binary data value"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.representation"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="TXT"/>
</element>
<element id="PN.item.given.mediaType">
<path value="PN.item.given.mediaType"/>
<representation value="xmlAttr"/>
<label value="Media Type"/>
<definition
value="Identifies the type of the encapsulated data and identifies a method to interpret or render the data."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.mediaType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="text/plain"/>
</element>
<element id="PN.item.given.language">
<path value="PN.item.given.language"/>
<representation value="xmlAttr"/>
<label value="Language"/>
<definition
value="For character based information the language property specifies the human language of the text."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.language"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
</element>
<element id="PN.item.given.xmlText">
<path value="PN.item.given.xmlText"/>
<representation value="xmlText"/>
<short value="Allows for mixed text content"/>
<comment
value="This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.xmlText"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="PN.item.given.partType">
<path value="PN.item.given.partType"/>
<representation value="xmlAttr"/>
<label value="Name Part Type Code"/>
<definition
value="Indicates whether the name part is a given name, family name, prefix, suffix, etc."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ENXP.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-EntityNamePartType"/>
</binding>
</element>
<element id="PN.item.given.qualifier">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="PN.item.given.qualifier"/>
<representation value="xmlAttr"/>
<label value="Qualifier Code"/>
<short
value="𝗨𝗦𝗖𝗗𝗜: callMe meets the USCDI 'Name to use' requirement"/>
<definition
value="qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records."/>
<comment
value="Such givens MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7158)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ENXP.qualifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"/>
</binding>
</element>
<element id="PN.item.prefix">
<path value="PN.item.prefix"/>
<comment
value="MAY contain zero or more [0..*] prefix (CONF:81-7155)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="EN.item.prefix"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ENXP"/>
</type>
</element>
<element id="PN.item.prefix.nullFlavor">
<path value="PN.item.prefix.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"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
</binding>
</element>
<element id="PN.item.prefix.representation">
<path value="PN.item.prefix.representation"/>
<representation value="xmlAttr"/>
<definition
value="Specifies the representation of the binary data that is the content of the binary data value"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.representation"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="TXT"/>
</element>
<element id="PN.item.prefix.mediaType">
<path value="PN.item.prefix.mediaType"/>
<representation value="xmlAttr"/>
<label value="Media Type"/>
<definition
value="Identifies the type of the encapsulated data and identifies a method to interpret or render the data."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.mediaType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="text/plain"/>
</element>
<element id="PN.item.prefix.language">
<path value="PN.item.prefix.language"/>
<representation value="xmlAttr"/>
<label value="Language"/>
<definition
value="For character based information the language property specifies the human language of the text."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.language"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
</element>
<element id="PN.item.prefix.xmlText">
<path value="PN.item.prefix.xmlText"/>
<representation value="xmlText"/>
<short value="Allows for mixed text content"/>
<comment
value="This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.xmlText"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="PN.item.prefix.partType">
<path value="PN.item.prefix.partType"/>
<representation value="xmlAttr"/>
<label value="Name Part Type Code"/>
<definition
value="Indicates whether the name part is a given name, family name, prefix, suffix, etc."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ENXP.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-EntityNamePartType"/>
</binding>
</element>
<element id="PN.item.prefix.qualifier">
<path value="PN.item.prefix.qualifier"/>
<representation value="xmlAttr"/>
<label value="Qualifier Code"/>
<definition
value="qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records."/>
<comment
value="The prefix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7156)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ENXP.qualifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"/>
</binding>
</element>
<element id="PN.item.suffix">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="PN.item.suffix"/>
<short value="𝗨𝗦𝗖𝗗𝗜: Suffix"/>
<comment value="MAY contain zero or one [0..1] suffix (CONF:81-7161)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="EN.item.suffix"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/ENXP"/>
</type>
</element>
<element id="PN.item.suffix.nullFlavor">
<path value="PN.item.suffix.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"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
</binding>
</element>
<element id="PN.item.suffix.representation">
<path value="PN.item.suffix.representation"/>
<representation value="xmlAttr"/>
<definition
value="Specifies the representation of the binary data that is the content of the binary data value"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.representation"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="TXT"/>
</element>
<element id="PN.item.suffix.mediaType">
<path value="PN.item.suffix.mediaType"/>
<representation value="xmlAttr"/>
<label value="Media Type"/>
<definition
value="Identifies the type of the encapsulated data and identifies a method to interpret or render the data."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.mediaType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<fixedCode value="text/plain"/>
</element>
<element id="PN.item.suffix.language">
<path value="PN.item.suffix.language"/>
<representation value="xmlAttr"/>
<label value="Language"/>
<definition
value="For character based information the language property specifies the human language of the text."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.language"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
</element>
<element id="PN.item.suffix.xmlText">
<path value="PN.item.suffix.xmlText"/>
<representation value="xmlText"/>
<short value="Allows for mixed text content"/>
<comment
value="This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ST.xmlText"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="PN.item.suffix.partType">
<path value="PN.item.suffix.partType"/>
<representation value="xmlAttr"/>
<label value="Name Part Type Code"/>
<definition
value="Indicates whether the name part is a given name, family name, prefix, suffix, etc."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ENXP.partType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-EntityNamePartType"/>
</binding>
</element>
<element id="PN.item.suffix.qualifier">
<path value="PN.item.suffix.qualifier"/>
<representation value="xmlAttr"/>
<label value="Qualifier Code"/>
<definition
value="qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records."/>
<comment
value="The suffix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7162)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ENXP.qualifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"/>
</binding>
</element>
<element id="PN.item.xmlText">
<path value="PN.item.xmlText"/>
<representation value="xmlText"/>
<short value="Allows for mixed text content"/>
<comment
value="This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EN.item.xmlText"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="PN.validTime">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="PN.validTime"/>
<label value="Valid Time"/>
<short
value="𝗨𝗦𝗖𝗗𝗜: Previous Name - Available for use to identify the time period when name was/is in use."/>
<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/cda/stds/core/StructureDefinition/IVL-TS"/>
</type>
</element>
</snapshot>
<differential>
<element id="PN">
<path value="PN"/>
<constraint>
<key value="shall-family"/>
<severity value="error"/>
<human
value="SHALL contain exactly one [1..1] family (CONF:81-7159)."/>
<expression value="nullFlavor.exists() or item.family.count() = 1"/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"/>
</constraint>
<constraint>
<key value="shall-given"/>
<severity value="error"/>
<human
value="SHALL contain at least one [1..*] given (CONF:81-7157)."/>
<expression value="nullFlavor.exists() or item.given.exists()"/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"/>
</constraint>
<constraint>
<key value="shall-max-suffix"/>
<severity value="error"/>
<human value="There may be at most one suffix"/>
<expression value="(item.suffix.empty() or item.suffix.count() = 1)"/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"/>
</constraint>
<constraint>
<key value="81-7278"/>
<severity value="error"/>
<human
value="**SHALL NOT** have mixed content except for white space (CONF:81-7278)."/>
<expression value="item.xmlText.empty()"/>
<source
value="http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPatientNamePTNUSFIELDED"/>
</constraint>
</element>
<element id="PN.use">
<path value="PN.use"/>
<short
value="If name/@nullFlavor is present, the remaining conformance statements *SHALL NOT* be enforced"/>
<comment
value="MAY contain zero or one [0..1] @use, which SHALL be selected from ValueSet EntityNameUse urn:oid:2.16.840.1.113883.1.11.15913 STATIC 2005-05-01 (CONF:81-7154)."/>
<max value="1"/>
</element>
<element id="PN.item.family">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="PN.item.family"/>
<short value="𝗨𝗦𝗖𝗗𝗜: Last Name"/>
</element>
<element id="PN.item.family.qualifier">
<path value="PN.item.family.qualifier"/>
<comment
value="This family MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7160)."/>
<max value="1"/>
<binding>
<strength value="required"/>
<valueSet
value="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"/>
</binding>
</element>
<element id="PN.item.given">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="PN.item.given"/>
<short value="𝗨𝗦𝗖𝗗𝗜: First Name / Middle Name"/>
<comment
value="SHALL contain at least one [1..*] given (CONF:81-7157)."/>
</element>
<element id="PN.item.given.qualifier">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="PN.item.given.qualifier"/>
<short
value="𝗨𝗦𝗖𝗗𝗜: callMe meets the USCDI 'Name to use' requirement"/>
<comment
value="Such givens MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7158)."/>
<max value="1"/>
<binding>
<strength value="required"/>
<valueSet
value="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"/>
</binding>
</element>
<element id="PN.item.prefix">
<path value="PN.item.prefix"/>
<comment
value="MAY contain zero or more [0..*] prefix (CONF:81-7155)."/>
</element>
<element id="PN.item.prefix.qualifier">
<path value="PN.item.prefix.qualifier"/>
<comment
value="The prefix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7156)."/>
<max value="1"/>
<binding>
<strength value="required"/>
<valueSet
value="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"/>
</binding>
</element>
<element id="PN.item.suffix">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="PN.item.suffix"/>
<short value="𝗨𝗦𝗖𝗗𝗜: Suffix"/>
<comment value="MAY contain zero or one [0..1] suffix (CONF:81-7161)."/>
</element>
<element id="PN.item.suffix.qualifier">
<path value="PN.item.suffix.qualifier"/>
<comment
value="The suffix, if present, MAY contain zero or one [0..1] @qualifier, which SHALL be selected from ValueSet EntityPersonNamePartQualifier urn:oid:2.16.840.1.113883.11.20.9.26 STATIC 2011-09-30 (CONF:81-7162)."/>
<max value="1"/>
<binding>
<strength value="required"/>
<valueSet
value="http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.26"/>
</binding>
</element>
<element id="PN.validTime">
<extension
url="http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement">
<valueBoolean value="true"/>
</extension>
<path value="PN.validTime"/>
<short
value="𝗨𝗦𝗖𝗗𝗜: Previous Name - Available for use to identify the time period when name was/is in use."/>
</element>
</differential>
</StructureDefinition>
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#4.0.0-ballot based on FHIR 5.0.0. Generated 2024-11-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change