StructureDefinition-HumanName-eu.xml
  1 <?xml version="1.0" encoding="utf-8"?>
  2 <StructureDefinition xmlns="http://hl7.org/fhir">
  3   <id value="HumanName-eu" />
  4   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
  5     <valueInteger value="2" />
  6   </extension>
  7   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
  8     <valueCode value="trial-use" />
  9   </extension>
 10   <url value="http://hl7.eu/fhir/base/StructureDefinition/HumanName-eu" />
 11   <version value="0.0.1-ci" />
 12   <name value="HumanNameEu" />
 13   <title value="HumanName (Eu)" />
 14   <status value="draft" />
 15   <date value="2025-01-16T21:55:40.0000000+01:00" />
 16   <publisher value="HL7 Europe" />
 17   <contact>
 18     <name value="HL7 Europe" />
 19     <telecom>
 20       <system value="url" />
 21       <value value="http://hl7.eu" />
 22     </telecom>
 23   </contact>
 24   <description value="This profile extends the HumanName data type for supporting multiple family names." />
 25   <jurisdiction>
 26     <coding>
 27       <system value="http://unstats.un.org/unsd/methods/m49/m49.htm" />
 28       <code value="150" />
 29       <display value="Europe" />
 30     </coding>
 31   </jurisdiction>
 32   <purpose value="This profile of the HumanName allows for expressing multiple family names, as requested by some jurisdictions." />
 33   <copyright value="Used by permission of HL7 Europe, all rights reserved Creative Commons License" />
 34   <fhirVersion value="4.0.1" />
 35   <mapping>
 36     <identity value="v2" />
 37     <uri value="http://hl7.org/v2" />
 38     <name value="HL7 v2 Mapping" />
 39   </mapping>
 40   <mapping>
 41     <identity value="rim" />
 42     <uri value="http://hl7.org/v3" />
 43     <name value="RIM Mapping" />
 44   </mapping>
 45   <mapping>
 46     <identity value="servd" />
 47     <uri value="http://www.omg.org/spec/ServD/1.0/" />
 48     <name value="ServD" />
 49   </mapping>
 50   <kind value="complex-type" />
 51   <abstract value="false" />
 52   <type value="HumanName" />
 53   <baseDefinition value="http://hl7.org/fhir/StructureDefinition/HumanName" />
 54   <derivation value="constraint" />
 55   <snapshot>
 56     <element id="HumanName">
 57       <path value="HumanName" />
 58       <short value="Name of a human - parts and usage" />
 59       <definition value="A human's name with the ability to identify parts and usage." />
 60       <comment 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 might or might 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." />
 61       <min value="0" />
 62       <max value="*" />
 63       <base>
 64         <path value="HumanName" />
 65         <min value="0" />
 66         <max value="*" />
 67       </base>
 68       <condition value="ele-1" />
 69       <constraint>
 70         <key value="ele-1" />
 71         <severity value="error" />
 72         <human value="All FHIR elements must have a @value or children" />
 73         <expression value="hasValue() or (children().count() > id.count())" />
 74         <xpath value="@value|f:*|h:div" />
 75         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
 76       </constraint>
 77       <isModifier value="false" />
 78       <mapping>
 79         <identity value="rim" />
 80         <map value="n/a" />
 81       </mapping>
 82       <mapping>
 83         <identity value="v2" />
 84         <map value="XPN" />
 85       </mapping>
 86       <mapping>
 87         <identity value="rim" />
 88         <map value="EN (actually, PN)" />
 89       </mapping>
 90       <mapping>
 91         <identity value="servd" />
 92         <map value="ProviderName" />
 93       </mapping>
 94     </element>
 95     <element id="HumanName.id">
 96       <path value="HumanName.id" />
 97       <representation value="xmlAttr" />
 98       <short value="Unique id for inter-element referencing" />
 99       <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
100       <min value="0" />
101       <max value="1" />
102       <base>
103         <path value="Element.id" />
104         <min value="0" />
105         <max value="1" />
106       </base>
107       <type>
108         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
109           <valueUrl value="string" />
110         </extension>
111         <code value="http://hl7.org/fhirpath/System.String" />
112       </type>
113       <isModifier value="false" />
114       <isSummary value="false" />
115       <mapping>
116         <identity value="rim" />
117         <map value="n/a" />
118       </mapping>
119     </element>
120     <element id="HumanName.extension">
121       <path value="HumanName.extension" />
122       <slicing>
123         <discriminator>
124           <type value="value" />
125           <path value="url" />
126         </discriminator>
127         <description value="Extensions are always sliced by (at least) url" />
128         <rules value="open" />
129       </slicing>
130       <short value="Additional content defined by implementations" />
131       <definition value="May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
132       <comment 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." />
133       <alias value="extensions" />
134       <alias value="user content" />
135       <min value="0" />
136       <max value="*" />
137       <base>
138         <path value="Element.extension" />
139         <min value="0" />
140         <max value="*" />
141       </base>
142       <type>
143         <code value="Extension" />
144       </type>
145       <constraint>
146         <key value="ele-1" />
147         <severity value="error" />
148         <human value="All FHIR elements must have a @value or children" />
149         <expression value="hasValue() or (children().count() > id.count())" />
150         <xpath value="@value|f:*|h:div" />
151         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
152       </constraint>
153       <constraint>
154         <key value="ext-1" />
155         <severity value="error" />
156         <human value="Must have either extensions or value[x], not both" />
157         <expression value="extension.exists() != value.exists()" />
158         <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
159         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
160       </constraint>
161       <isModifier value="false" />
162       <isSummary value="false" />
163       <mapping>
164         <identity value="rim" />
165         <map value="n/a" />
166       </mapping>
167     </element>
168     <element id="HumanName.use">
169       <path value="HumanName.use" />
170       <short value="usual | official | temp | nickname | anonymous | old | maiden" />
171       <definition value="Identifies the purpose for this name." />
172       <comment value="Applications can assume that a name is current unless it explicitly says that it is temporary or old." />
173       <requirements value="Allows the appropriate name for a particular context of use to be selected from among a set of names." />
174       <min value="0" />
175       <max value="1" />
176       <base>
177         <path value="HumanName.use" />
178         <min value="0" />
179         <max value="1" />
180       </base>
181       <type>
182         <code value="code" />
183       </type>
184       <constraint>
185         <key value="ele-1" />
186         <severity value="error" />
187         <human value="All FHIR elements must have a @value or children" />
188         <expression value="hasValue() or (children().count() > id.count())" />
189         <xpath value="@value|f:*|h:div" />
190         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
191       </constraint>
192       <isModifier value="true" />
193       <isModifierReason value="This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one" />
194       <isSummary value="true" />
195       <binding>
196         <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
197           <valueString value="NameUse" />
198         </extension>
199         <strength value="required" />
200         <description value="The use of a human name." />
201         <valueSet value="http://hl7.org/fhir/ValueSet/name-use|4.0.1" />
202       </binding>
203       <mapping>
204         <identity value="v2" />
205         <map value="XPN.7, but often indicated by which field contains the name" />
206       </mapping>
207       <mapping>
208         <identity value="rim" />
209         <map value="unique(./use)" />
210       </mapping>
211       <mapping>
212         <identity value="servd" />
213         <map value="./NamePurpose" />
214       </mapping>
215     </element>
216     <element id="HumanName.text">
217       <path value="HumanName.text" />
218       <short value="Text representation of the full name" />
219       <definition value="Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts." />
220       <comment value="Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present,  no content is included in the text that isn't found in a part." />
221       <requirements value="A renderable, unencoded form." />
222       <min value="0" />
223       <max value="1" />
224       <base>
225         <path value="HumanName.text" />
226         <min value="0" />
227         <max value="1" />
228       </base>
229       <type>
230         <code value="string" />
231       </type>
232       <constraint>
233         <key value="ele-1" />
234         <severity value="error" />
235         <human value="All FHIR elements must have a @value or children" />
236         <expression value="hasValue() or (children().count() > id.count())" />
237         <xpath value="@value|f:*|h:div" />
238         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
239       </constraint>
240       <isModifier value="false" />
241       <isSummary value="true" />
242       <mapping>
243         <identity value="v2" />
244         <map value="implied by XPN.11" />
245       </mapping>
246       <mapping>
247         <identity value="rim" />
248         <map value="./formatted" />
249       </mapping>
250     </element>
251     <element id="HumanName.family">
252       <path value="HumanName.family" />
253       <short value="Family name (often called 'Surname')" />
254       <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." />
255       <comment value="Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures)." />
256       <alias value="surname" />
257       <min value="0" />
258       <max value="1" />
259       <base>
260         <path value="HumanName.family" />
261         <min value="0" />
262         <max value="1" />
263       </base>
264       <type>
265         <code value="string" />
266       </type>
267       <example>
268         <label value="spanish name" />
269         <valueString value="Valero Iglesias" />
270       </example>
271       <constraint>
272         <key value="ele-1" />
273         <severity value="error" />
274         <human value="All FHIR elements must have a @value or children" />
275         <expression value="hasValue() or (children().count() > id.count())" />
276         <xpath value="@value|f:*|h:div" />
277         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
278       </constraint>
279       <isModifier value="false" />
280       <isSummary value="true" />
281       <mapping>
282         <identity value="v2" />
283         <map value="XPN.1/FN.1" />
284       </mapping>
285       <mapping>
286         <identity value="rim" />
287         <map value="./part[partType = FAM]" />
288       </mapping>
289       <mapping>
290         <identity value="servd" />
291         <map value="./FamilyName" />
292       </mapping>
293     </element>
294     <element id="HumanName.family.id">
295       <path value="HumanName.family.id" />
296       <representation value="xmlAttr" />
297       <short value="xml:id (or equivalent in JSON)" />
298       <definition value="unique id for the element within a resource (for internal references)" />
299       <min value="0" />
300       <max value="1" />
301       <base>
302         <path value="Element.id" />
303         <min value="0" />
304         <max value="1" />
305       </base>
306       <type>
307         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
308           <valueUrl value="string" />
309         </extension>
310         <code value="http://hl7.org/fhirpath/System.String" />
311       </type>
312       <isModifier value="false" />
313       <isSummary value="false" />
314     </element>
315     <element id="HumanName.family.extension">
316       <path value="HumanName.family.extension" />
317       <slicing>
318         <discriminator>
319           <type value="value" />
320           <path value="url" />
321         </discriminator>
322         <ordered value="false" />
323         <rules value="open" />
324       </slicing>
325       <short value="Extension" />
326       <definition value="An Extension" />
327       <min value="0" />
328       <max value="*" />
329       <base>
330         <path value="Element.extension" />
331         <min value="0" />
332         <max value="*" />
333       </base>
334       <type>
335         <code value="Extension" />
336       </type>
337       <constraint>
338         <key value="ele-1" />
339         <severity value="error" />
340         <human value="All FHIR elements must have a @value or children" />
341         <expression value="hasValue() or (children().count() > id.count())" />
342         <xpath value="@value|f:*|h:div" />
343         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
344       </constraint>
345       <constraint>
346         <key value="ext-1" />
347         <severity value="error" />
348         <human value="Must have either extensions or value[x], not both" />
349         <expression value="extension.exists() != value.exists()" />
350         <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
351         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
352       </constraint>
353       <isModifier value="false" />
354       <isSummary value="false" />
355     </element>
356     <element id="HumanName.family.extension:fathersFamily">
357       <path value="HumanName.family.extension" />
358       <sliceName value="fathersFamily" />
359       <short value="Portion of family name derived from father" />
360       <definition value="The portion of the family name that is derived from the person's father." />
361       <min value="0" />
362       <max value="*" />
363       <base>
364         <path value="Element.extension" />
365         <min value="0" />
366         <max value="*" />
367       </base>
368       <type>
369         <code value="Extension" />
370         <profile value="http://hl7.org/fhir/StructureDefinition/humanname-fathers-family" />
371       </type>
372       <example>
373         <label value="spanish name" />
374         <valueString value="Valero" />
375       </example>
376       <constraint>
377         <key value="ele-1" />
378         <severity value="error" />
379         <human value="All FHIR elements must have a @value or children" />
380         <expression value="hasValue() or (children().count() > id.count())" />
381         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
382       </constraint>
383       <constraint>
384         <key value="ext-1" />
385         <severity value="error" />
386         <human value="Must have either extensions or value[x], not both" />
387         <expression value="extension.exists() != value.exists()" />
388         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
389       </constraint>
390       <isModifier value="false" />
391       <mapping>
392         <identity value="v2" />
393         <map value="N/A" />
394       </mapping>
395       <mapping>
396         <identity value="rim" />
397         <map value="N/A" />
398       </mapping>
399     </element>
400     <element id="HumanName.family.extension:mothersFamily">
401       <path value="HumanName.family.extension" />
402       <sliceName value="mothersFamily" />
403       <short value="Portion of family name derived from mother" />
404       <definition value="The portion of the family name that is derived from the person's mother." />
405       <min value="0" />
406       <max value="*" />
407       <base>
408         <path value="Element.extension" />
409         <min value="0" />
410         <max value="*" />
411       </base>
412       <type>
413         <code value="Extension" />
414         <profile value="http://hl7.org/fhir/StructureDefinition/humanname-mothers-family" />
415       </type>
416       <example>
417         <label value="spanish name" />
418         <valueString value="Iglesias" />
419       </example>
420       <constraint>
421         <key value="ele-1" />
422         <severity value="error" />
423         <human value="All FHIR elements must have a @value or children" />
424         <expression value="hasValue() or (children().count() > id.count())" />
425         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
426       </constraint>
427       <constraint>
428         <key value="ext-1" />
429         <severity value="error" />
430         <human value="Must have either extensions or value[x], not both" />
431         <expression value="extension.exists() != value.exists()" />
432         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
433       </constraint>
434       <isModifier value="false" />
435       <mapping>
436         <identity value="v2" />
437         <map value="N/A" />
438       </mapping>
439       <mapping>
440         <identity value="rim" />
441         <map value="N/A" />
442       </mapping>
443     </element>
444     <element id="HumanName.family.value">
445       <path value="HumanName.family.value" />
446       <representation value="xmlAttr" />
447       <short value="Primitive value for string" />
448       <definition value="The actual value" />
449       <min value="0" />
450       <max value="1" />
451       <base>
452         <path value="string.value" />
453         <min value="0" />
454         <max value="1" />
455       </base>
456       <type>
457         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
458           <valueUrl value="string" />
459         </extension>
460         <extension url="http://hl7.org/fhir/StructureDefinition/regex">
461           <valueString value="[ \r\n\t\S]+" />
462         </extension>
463         <code value="http://hl7.org/fhirpath/System.String" />
464       </type>
465       <maxLength value="1048576" />
466       <isModifier value="false" />
467       <isSummary value="false" />
468     </element>
469     <element id="HumanName.given">
470       <path value="HumanName.given" />
471       <short value="Given names (not always 'first'). Includes middle names" />
472       <definition value="Given name." />
473       <comment value="If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations.  This element is not called "first name" since given names do not always come first." />
474       <alias value="first name" />
475       <alias value="middle name" />
476       <min value="0" />
477       <max value="*" />
478       <base>
479         <path value="HumanName.given" />
480         <min value="0" />
481         <max value="*" />
482       </base>
483       <type>
484         <code value="string" />
485       </type>
486       <orderMeaning value="Given Names appear in the correct order for presenting the name" />
487       <example>
488         <label value="spanish name" />
489         <valueString value="Borja" />
490       </example>
491       <constraint>
492         <key value="ele-1" />
493         <severity value="error" />
494         <human value="All FHIR elements must have a @value or children" />
495         <expression value="hasValue() or (children().count() > id.count())" />
496         <xpath value="@value|f:*|h:div" />
497         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
498       </constraint>
499       <isModifier value="false" />
500       <isSummary value="true" />
501       <mapping>
502         <identity value="v2" />
503         <map value="XPN.2 + XPN.3" />
504       </mapping>
505       <mapping>
506         <identity value="rim" />
507         <map value="./part[partType = GIV]" />
508       </mapping>
509       <mapping>
510         <identity value="servd" />
511         <map value="./GivenNames" />
512       </mapping>
513     </element>
514     <element id="HumanName.prefix">
515       <path value="HumanName.prefix" />
516       <short value="Parts that come before the name" />
517       <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." />
518       <min value="0" />
519       <max value="*" />
520       <base>
521         <path value="HumanName.prefix" />
522         <min value="0" />
523         <max value="*" />
524       </base>
525       <type>
526         <code value="string" />
527       </type>
528       <orderMeaning value="Prefixes appear in the correct order for presenting the name" />
529       <constraint>
530         <key value="ele-1" />
531         <severity value="error" />
532         <human value="All FHIR elements must have a @value or children" />
533         <expression value="hasValue() or (children().count() > id.count())" />
534         <xpath value="@value|f:*|h:div" />
535         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
536       </constraint>
537       <isModifier value="false" />
538       <isSummary value="true" />
539       <mapping>
540         <identity value="v2" />
541         <map value="XPN.5" />
542       </mapping>
543       <mapping>
544         <identity value="rim" />
545         <map value="./part[partType = PFX]" />
546       </mapping>
547       <mapping>
548         <identity value="servd" />
549         <map value="./TitleCode" />
550       </mapping>
551     </element>
552     <element id="HumanName.suffix">
553       <path value="HumanName.suffix" />
554       <short value="Parts that come after the name" />
555       <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." />
556       <min value="0" />
557       <max value="*" />
558       <base>
559         <path value="HumanName.suffix" />
560         <min value="0" />
561         <max value="*" />
562       </base>
563       <type>
564         <code value="string" />
565       </type>
566       <orderMeaning value="Suffixes appear in the correct order for presenting the name" />
567       <constraint>
568         <key value="ele-1" />
569         <severity value="error" />
570         <human value="All FHIR elements must have a @value or children" />
571         <expression value="hasValue() or (children().count() > id.count())" />
572         <xpath value="@value|f:*|h:div" />
573         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
574       </constraint>
575       <isModifier value="false" />
576       <isSummary value="true" />
577       <mapping>
578         <identity value="v2" />
579         <map value="XPN/4" />
580       </mapping>
581       <mapping>
582         <identity value="rim" />
583         <map value="./part[partType = SFX]" />
584       </mapping>
585     </element>
586     <element id="HumanName.period">
587       <path value="HumanName.period" />
588       <short value="Time period when name was/is in use" />
589       <definition value="Indicates the period of time when this name was valid for the named person." />
590       <requirements value="Allows names to be placed in historical context." />
591       <min value="0" />
592       <max value="1" />
593       <base>
594         <path value="HumanName.period" />
595         <min value="0" />
596         <max value="1" />
597       </base>
598       <type>
599         <code value="Period" />
600       </type>
601       <constraint>
602         <key value="ele-1" />
603         <severity value="error" />
604         <human value="All FHIR elements must have a @value or children" />
605         <expression value="hasValue() or (children().count() > id.count())" />
606         <xpath value="@value|f:*|h:div" />
607         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
608       </constraint>
609       <isModifier value="false" />
610       <isSummary value="true" />
611       <mapping>
612         <identity value="v2" />
613         <map value="XPN.13 + XPN.14" />
614       </mapping>
615       <mapping>
616         <identity value="rim" />
617         <map value="./usablePeriod[type="IVL<TS>"]" />
618       </mapping>
619       <mapping>
620         <identity value="servd" />
621         <map value="./StartDate and ./EndDate" />
622       </mapping>
623     </element>
624   </snapshot>
625   <differential>
626     <element id="HumanName">
627       <path value="HumanName" />
628     </element>
629     <element id="HumanName.family">
630       <path value="HumanName.family" />
631       <example>
632         <label value="spanish name" />
633         <valueString value="Valero Iglesias" />
634       </example>
635     </element>
636     <element id="HumanName.family.extension">
637       <path value="HumanName.family.extension" />
638       <slicing>
639         <discriminator>
640           <type value="value" />
641           <path value="url" />
642         </discriminator>
643         <ordered value="false" />
644         <rules value="open" />
645       </slicing>
646     </element>
647     <element id="HumanName.family.extension:fathersFamily">
648       <path value="HumanName.family.extension" />
649       <sliceName value="fathersFamily" />
650       <min value="0" />
651       <max value="*" />
652       <type>
653         <code value="Extension" />
654         <profile value="http://hl7.org/fhir/StructureDefinition/humanname-fathers-family" />
655       </type>
656       <example>
657         <label value="spanish name" />
658         <valueString value="Valero" />
659       </example>
660     </element>
661     <element id="HumanName.family.extension:mothersFamily">
662       <path value="HumanName.family.extension" />
663       <sliceName value="mothersFamily" />
664       <min value="0" />
665       <max value="*" />
666       <type>
667         <code value="Extension" />
668         <profile value="http://hl7.org/fhir/StructureDefinition/humanname-mothers-family" />
669       </type>
670       <example>
671         <label value="spanish name" />
672         <valueString value="Iglesias" />
673       </example>
674     </element>
675     <element id="HumanName.given">
676       <path value="HumanName.given" />
677       <example>
678         <label value="spanish name" />
679         <valueString value="Borja" />
680       </example>
681     </element>
682   </differential>
683 </StructureDefinition>