This page is part of the FHIR Specification (v4.2.0: R5 Preview #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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: keyWord

URL for this extension:

http://hl7.org/fhir/StructureDefinition/codesystem-keyWord

Status: draft. Extension maintained by: HL7

Word or words used in an information retrieval system to indicate the content of the value set.

Context of Use: Use on Element ID CodeSystem

Extension Content

• Summary
• Full Structure
• XML
• JSON
• All

Summary

Name	Flags	Card.	Type	Description & Constraints
keyWord		0..*	string	URL = http://hl7.org/fhir/StructureDefinition/codesystem-keyWord keyWord: Word or words used in an information retrieval system to indicate the content of the value set. Use on Element ID CodeSystem
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/codesystem-keyWord keyWord: Word or words used in an information retrieval system to indicate the content of the value set. Use on Element ID CodeSystem
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-keyWord"
value[x]	I	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- keyWord -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/codesystem-keyWord" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
keyWord		0..*	string	URL = http://hl7.org/fhir/StructureDefinition/codesystem-keyWord keyWord: Word or words used in an information retrieval system to indicate the content of the value set. Use on Element ID CodeSystem
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/codesystem-keyWord keyWord: Word or words used in an information retrieval system to indicate the content of the value set. Use on Element ID CodeSystem
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-keyWord"
value[x]	I	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- keyWord -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/codesystem-keyWord" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

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

Constraints

• ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
• 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)