DSTU2
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
StructureDefinition for HumanName
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="HumanName"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <table border="0" cellpadding="0" cellspacing="0" style="border: 0px; 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 class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="formats.html#table" title="The logical name of the element">Name</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="formats.html#table" title="Information about the use of the element">Flags</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a> </th> <th class="hierarchy" style="width: 100px"> <a href="formats.html#table" title="Reference to the type of the element">Type</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="formats.html#table" title="Additional information about the element">Description & Constraints</a> <span style="float: right"> <a href="formats.html#table" title="Legend for this format"> <img alt="doco" src="help16.png" style="background-color: inherit"/> </a> </span> </th> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,R0lGODlhEAAQAMQfAOvGUf7ztuvPMf/78/fkl/Pbg+u8Rvjqteu2Pf3zxPz36Pz0z+vTmPzurPvuw /npofbjquvNefHVduuyN+uuMu3Oafbgjfnqvf/3zv/3xevPi+vRjP/20/bmsP///////yH5BAEAAB8ALAAAAAAQABAAAAV24CeOZG mepqeqqOgxjBZFa+19r4ftWQUAgqDgltthMshMIJAZ4jYDHsBARSAmFOJvq+g6HIdEFgcYmBWNxoNAsDjGHgBnmV5bCoUDHLBIq9s FEhIdcAYJdYASFRUQhQkLCwkOFwcdEBAXhVabE52ecDahKy0oIQA7" style="background-color: white; background-color: inherit" title="Element"/> <a href="datatypes-definitions.html#HumanName" title="HumanName : A human's name with the ability to identify parts and usage.">HumanName</a> <a name="HumanName"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"/> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="element.html">Element</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Name of a human - parts and usage</td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav 7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#HumanName.use" title="HumanName.use : Identifies the purpose for this name.">use</a> <a name="HumanName.use"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is a modifier element">?! </span> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="datatypes.html#code">code</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">usual | official | temp | nickname | anonymous | old | maiden <br/> <a href="valueset-name-use.html" title="The use of a human name">NameUse</a> ( <a href="terminologies.html#required" title="To be conformant, instances of this element SHALL include a code from the specified value set.">Required</a>) </td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav 7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#HumanName.text" title="HumanName.text : A full text representation of the name.">text</a> <a name="HumanName.text"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="datatypes.html#string">string</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Text representation of the full name</td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav 7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#HumanName.family" title="HumanName.family : 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.">family</a> <a name="HumanName.family"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..*</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="datatypes.html#string">string</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Family name (often called 'Surname')</td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav 7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#HumanName.given" title="HumanName.given : Given name.">given</a> <a name="HumanName.given"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..*</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="datatypes.html#string">string</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Given names (not always 'first'). Includes middle names</td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav 7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#HumanName.prefix" title="HumanName.prefix : 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.">prefix</a> <a name="HumanName.prefix"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..*</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="datatypes.html#string">string</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Parts that come before the name</td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav 7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#HumanName.suffix" title="HumanName.suffix : 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.">suffix</a> <a name="HumanName.suffix"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..*</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="datatypes.html#string">string</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Parts that come after the name</td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAI0lEQVR42u3QIQEAAAACIL/6/4MvTAQOkLYBAAB4kAAAANwMad9AqkRjgNAAAAAASUVORK5CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzME+lXFigAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+3OsRUAIAjEUO L+O8cJABttJM11/x1qZAGqRBEVcNIqdWj1efDqQbb3HwwwwEfABmQUHSPM9dtDAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,R0lGODlhEAAQAOZ/APrkusOiYvvfqbiXWaV2G+jGhdq1b8GgYf3v1frw3vTUlsWkZNewbcSjY/DQk ad4Hb6dXv3u0f3v1ObEgfPTlerJiP3w1v79+e7OkPrfrfnjuNOtZPrpydaxa+/YrvvdpP779ZxvFPvnwKKBQaFyF/369M2vdaqHRP z58/HNh/vowufFhfroxO3OkPrluv779tK0e6JzGProwvrow9m4eOnIifPTlPDPkP78+Naxaf3v0/zowfXRi+bFhLWUVv379/rnwPv szv3rye3LiPvnv+3MjPDasKiIS/789/3x2f747eXDg+7Mifvu0tu7f+/QkfDTnPXWmPrjsvrjtPbPgrqZW+/QlPz48K2EMv36866O UPvowat8Ivvgq/Pbrvzgq/PguvrgrqN0Gda2evfYm9+7d/rpw9q6e/LSku/Rl/XVl/LSlfrkt+zVqe7Wqv3x1/bNffbOf59wFdS6i f3u0vrqyP3owPvepfXQivDQkO/PkKh9K7STVf779P///////yH5BAEAAH8ALAAAAAAQABAAAAfNgH+Cg36FfoOIhH4JBxBghYl/hQ kNAV0IVT5GkJKLCwtQaSsSdx9aR26Gcwt2IkQaNRI6dBERIzCFDSgWSW8WCDkbBnoOQ3uFARc/JQJfCAZlT0x4ZFyFBxdNQT9ZCBN WKQoKUQ+FEDgcdTIAV14YDmg2CgSFA0hmQC5TLE4VRTdrKJAoxOeFCzZSwsw4U6BCizwUQhQyEaAPiAwCVNCY0FCNnA6GPAwYoETI FgY9loiRA4dToTYnsOxg8CBGHE6ICvEYQ4AKzkidfgoKBAA7" style="background-color: white; background-color: inherit" title="Data Type"/> <a href="datatypes-definitions.html#HumanName.period" title="HumanName.period : Indicates the period of time when this name was valid for the named person.">period</a> <a name="HumanName.period"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="datatypes.html#Period">Period</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Time period when name was/is in use</td> </tr> <tr> <td class="hierarchy" colspan="5"> <br/> <a href="formats.html#table" title="Legend for this format"> <img alt="doco" src="help16.png" style="background-color: inherit"/> Documentation for this format </a> </td> </tr> </table> </div> </text> <url value="http://hl7.org/fhir/StructureDefinition/HumanName"/> <name value="HumanName"/> <status value="draft"/> <publisher value="HL7 FHIR Standard"/> <contact> <telecom> <system value="other"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <date value="2015-10-24T07:41:03+11:00"/> <description value="Base StructureDefinition for HumanName Type"/> <requirements value="Need to be able to record names, along with notes about their use."/> <fhirVersion value="1.0.2"/> <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"/> <abstract value="false"/> <base value="http://hl7.org/fhir/StructureDefinition/Element"/> <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."/> <min value="0"/> <max value="*"/> <type> <code value="Element"/> </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"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="HumanName.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </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 "Is Modifier" 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"/> <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"/> <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 "Smith-Jones" are a single name, but names with spaces such as "Smith Jones" are broken into multiple parts."/> <alias value="surname"/> <min value="0"/> <max value="*"/> <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 "first name" since given names do not always come first."/> <alias value="first name"/> <alias value="middle name"/> <min value="0"/> <max value="*"/> <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="*"/> <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="*"/> <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"/> <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="IVL<TS>"]"/> </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."/> <min value="0"/> <max value="*"/> <type> <code value="Element"/> </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.use"/> <short value="usual | official | temp | nickname | anonymous | old | maiden"/> <definition value="Identifies the purpose for this name."/> <comments value="This is labeled as "Is Modifier" 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"/> <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"/> <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 "Smith-Jones" are a single name, but names with spaces such as "Smith Jones" are broken into multiple parts."/> <alias value="surname"/> <min value="0"/> <max value="*"/> <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 "first name" since given names do not always come first."/> <alias value="first name"/> <alias value="middle name"/> <min value="0"/> <max value="*"/> <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="*"/> <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="*"/> <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"/> <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="IVL<TS>"]"/> </mapping> <mapping> <identity value="servd"/> <map value="./StartDate and ./EndDate"/> </mapping> </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.
© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100.
Links: Search |
Version History |
Table of Contents |
Compare to DSTU1 |
|
Propose a change