Release 4B Ballot #1

This page is part of the FHIR Specification (v4.1.0: Release 4B Ballot #1). 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 R3 R2

Extension: nullFlavor

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor

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

If the value is not a proper value, indicates the reason.

Comment:

Considerable care must be used when using nullFlavor in this context of FHIR - more than any other concept, this is tied to the way v3 works, and FHIR is quite different. For instance, there is no notion of a "proper value" as opposed to any other value in FHIR. a NullFlavor should be understood to mean, "why information is missing", and the nulFlavors OTH, NINF, PINF, and TRC should not be used.

Context of Use: Use on Element ID Element

Summary

Name	Flags	Card.	Type	Description & Constraints
nullFlavor		0..1	code	URL = http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor nullFlavor: If the value is not a proper value, indicates the reason. Binding: NullFlavor (required) Use on Element ID Element
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor nullFlavor: If the value is not a proper value, indicates the reason. Use on Element ID Element
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor"
value[x]	1..1	code	Value of extension Binding: NullFlavor (required)
Documentation for this format

XML Template

<!-- nullFlavor -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // nullFlavor
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor", // R! 
    "valueCode" : "<code>" // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
nullFlavor		0..1	code	URL = http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor nullFlavor: If the value is not a proper value, indicates the reason. Binding: NullFlavor (required) Use on Element ID Element
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor nullFlavor: If the value is not a proper value, indicates the reason. Use on Element ID Element
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor"
value[x]	1..1	code	Value of extension Binding: NullFlavor (required)
Documentation for this format

XML Template

<!-- nullFlavor -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // nullFlavor
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor", // 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|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)