STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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: Human-specified notes and other documentation

(No assigned work group)   Maturity Level : 0 Context: Any

URL for this extension: 


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

Status: draft. Extension maintained by: HL7

Each comment is a time-stamped entry of arbitrary length that is not editable except by anyone in the author group.

Context of Use: Use on element: CodeSystem

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/codesystem-comment
Human-specified notes and other documentation: Each comment is a time-stamped entry of arbitrary length that is not editable except by anyone in the author group.
Use on element: CodeSystem
. . . content 1..1 string Comments created about the value set.
. . . timestamp 1..1 instant Time the comment was recorded.

doco Documentation for this format

Fulle Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/codesystem-comment
Human-specified notes and other documentation: Each comment is a time-stamped entry of arbitrary length that is not editable except by anyone in the author group.
Use on element: CodeSystem
. . . extension 1..1 Extension Remarks or other text
. . . . extension 0 .. 0
. . . . url 1..1 uri "content"
. . . . valueString 1..1 string Value of extension
. . . extension 1..1 Extension When the comment was created
. . . . extension 0 .. 0
. . . . url 1..1 uri "timestamp"
. . . . valueInstant 1..1 instant Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-comment"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- Human-specified notes and other documentation -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/codesystem-comment" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="content"> 1..1 Extension  <!-- 1..1 Remarks or other text -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="timestamp"> 1..1 Extension  <!-- 1..1 When the comment was created -->
  <valueInstant value="[instant]"/><!-- 1..1 Value of extension -->
 </extension>
</extension>

JSON Template 

{ // Human-specified notes and other documentation
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Remarks or other text // R! 
        // from Element: extension
        "url" : "content", // R! 
        "valueString" : "<string>" // R! Value of extension
      },
      { // When the comment was created // R! 
        // from Element: extension
        "url" : "timestamp", // R! 
        "valueInstant" : "<instant>" // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-comment", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/codesystem-comment
Human-specified notes and other documentation: Each comment is a time-stamped entry of arbitrary length that is not editable except by anyone in the author group.
Use on element: CodeSystem
. . . content 1..1 string Comments created about the value set.
. . . timestamp 1..1 instant Time the comment was recorded.

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/codesystem-comment
Human-specified notes and other documentation: Each comment is a time-stamped entry of arbitrary length that is not editable except by anyone in the author group.
Use on element: CodeSystem
. . . extension 1..1 Extension Remarks or other text
. . . . extension 0 .. 0
. . . . url 1..1 uri "content"
. . . . valueString 1..1 string Value of extension
. . . extension 1..1 Extension When the comment was created
. . . . extension 0 .. 0
. . . . url 1..1 uri "timestamp"
. . . . valueInstant 1..1 instant Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-comment"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- Human-specified notes and other documentation -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/codesystem-comment" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="content"> 1..1 Extension  <!-- 1..1 Remarks or other text -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="timestamp"> 1..1 Extension  <!-- 1..1 When the comment was created -->
  <valueInstant value="[instant]"/><!-- 1..1 Value of extension -->
 </extension>
</extension>

JSON Template 

{ // Human-specified notes and other documentation
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Remarks or other text // R! 
        // from Element: extension
        "url" : "content", // R! 
        "valueString" : "<string>" // R! Value of extension
      },
      { // When the comment was created // R! 
        // from Element: extension
        "url" : "timestamp", // R! 
        "valueInstant" : "<instant>" // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-comment", // R! 
// value[x]: Value of extension. One of these 38:
  }

 

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')]) )