Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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: keyWord

Vocabulary Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/valueset-keyWord

Version: 5.0.0-ballot

Name: keyWord

Title: null

Modifier: This extension is not a modifier extension

Status: draft

Definition: Word or words used in an information retrieval system to indicate the content of the value set. (deprecated)

Committee: Vocabulary Work Group

Status: draft. Extension maintained by: HL7

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

Comment:

This extension is deprecated, use the topic element of the CodeSystem resource instead.

Context of Use: Use on Element ID ValueSet

Summary

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

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-keyWord keyWord: Word or words used in an information retrieval system to indicate the content of the value set. (deprecated) Use on Element ID ValueSet
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-keyWord"
value[x]	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/valueset-keyWord" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

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

Summary

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

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-keyWord keyWord: Word or words used in an information retrieval system to indicate the content of the value set. (deprecated) Use on Element ID ValueSet
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-keyWord"
value[x]	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/valueset-keyWord" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

{ // keyWord
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-keyWord", // R! 
    "valueString" : "<string>" // I 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)

Search

keyword

string

Optional Extensions Element
Expression: CodeSystem.extension('http://hl7.org/fhir/StructureDefinition/valueset-keyWord').value

Examples of this extension

No examples found.