R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: comments

Vocabulary Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

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

Status: draft. Extension maintained by: HL7

A comment that explains how this code is used in this context (where the value set is expected to be used).

Comment:

This is used in various FHIR value sets to make comments on how particular codes are used when the formal definition is a little abstract or vague, but it's not clear whether it belongs in the actual value set resource.

Context of Use: Use on Element ID CodeSystem.concept

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

Summary

Name	Flags	Card.	Type	Description & Constraints
comments		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/codesystem-comments comments: A comment that explains how this code is used in this context (where the value set is expected to be used). Use on Element ID CodeSystem.concept
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/codesystem-comments comments: A comment that explains how this code is used in this context (where the value set is expected to be used). Use on Element ID CodeSystem.concept
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-comments"
valueString	0..1	string	Value of extension
Documentation for this format

XML Template

<!-- comments -->

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

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
comments		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/codesystem-comments comments: A comment that explains how this code is used in this context (where the value set is expected to be used). Use on Element ID CodeSystem.concept
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/codesystem-comments comments: A comment that explains how this code is used in this context (where the value set is expected to be used). Use on Element ID CodeSystem.concept
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-comments"
valueString	0..1	string	Value of extension
Documentation for this format

XML Template

<!-- comments -->

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

JSON Template

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