FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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: 1InformativeUse Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/valueset-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: ValueSet

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*stringURL = 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.
Use on element: ValueSet

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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.
Use on element: ValueSet
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-keyWord"
... valueString 0..1stringValue of extension

doco Documentation for this format

XML Template

<!-- keyWord -->doco

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

JSON Template

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

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*stringURL = 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.
Use on element: ValueSet

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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.
Use on element: ValueSet
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-keyWord"
... valueString 0..1stringValue of extension

doco Documentation for this format

XML Template

<!-- keyWord -->doco

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

JSON Template

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