Release 4 4B

This page is part of the FHIR Specification (v4.0.1: R4 (v4.3.0: R4B - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). ). 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: R4B R4 R4B R4

Extension: EN-use

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/iso21090-EN-use

Status: draft. Extension maintained by: Health Level Seven International (Modeling and Methodology)

A set of codes advising a system or user which name in a set of names to select for a given purpose.

Comment :

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.

Context of Use: Use on Element ID HumanName

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . EN-use 0..1 code URL = http://hl7.org/fhir/StructureDefinition/iso21090-EN-use
EN-use: A set of codes advising a system or user which name in a set of names to select for a given purpose.


Binding: EntityNameUseR2 ( required )
Use on Element ID HumanName

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/iso21090-EN-use
EN-use: A set of codes advising a system or user which name in a set of names to select for a given purpose.


Use on Element ID HumanName
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-use"
. . . value[x] I 1..1 code Value of extension
Binding: EntityNameUseR2 ( required )

doco Documentation for this format

XML Template 

<!-- EN-use -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-use" >
  <!-- from Element: extension -->
 <

 <valueCode value="[code]"/><!-- ?? 1..1 Value of extension -->

</extension>

JSON Template 

{ // EN-use
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-use", // R! 
    "

    "valueCode" : "<code>" // C? R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . EN-use 0..1 code URL = http://hl7.org/fhir/StructureDefinition/iso21090-EN-use
EN-use: A set of codes advising a system or user which name in a set of names to select for a given purpose.


Binding: EntityNameUseR2 ( required )
Use on Element ID HumanName

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/iso21090-EN-use
EN-use: A set of codes advising a system or user which name in a set of names to select for a given purpose.


Use on Element ID HumanName
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-use"
. . . value[x] I 1..1 code Value of extension
Binding: EntityNameUseR2 ( required )

doco Documentation for this format

XML Template 

<!-- EN-use -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-use" >
  <!-- from Element: extension -->
 <

 <valueCode value="[code]"/><!-- ?? 1..1 Value of extension -->

</extension>

JSON Template 

{ // EN-use
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-use", // R! 
    "

    "valueCode" : "<code>" // C? R! Value of extension

  }

 

Constraints

  • ele-1 : All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div @value|f:*|h:div|self::f:Parameters )
  • ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) )
  • ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div )