R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 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

Extension: annotation

FHIR Infrastructure Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation

Status: draft. Extension maintained by: Health Level Seven, Inc. - [WG Name] WG

Additional notes about any item in a structure definition.

Context of Use: Use on element: StructureDefinition

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*AnnotationURL = http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation
annotation: Additional notes about any item in a structure definition.
Use on element: StructureDefinition

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation
annotation: Additional notes about any item in a structure definition.
Use on element: StructureDefinition
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation"
... valueAnnotation 0..1AnnotationValue of extension

doco Documentation for this format

XML Template

<!-- annotation -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation" >
  <!-- from Element: extension -->
 <valueAnnotation><!-- 0..1 Annotation Value of extension --></valueAnnotation>
</extension>

JSON Template

{ // annotation
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation", // R! 
    "valueAnnotation" : { Annotation } //Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*AnnotationURL = http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation
annotation: Additional notes about any item in a structure definition.
Use on element: StructureDefinition

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation
annotation: Additional notes about any item in a structure definition.
Use on element: StructureDefinition
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation"
... valueAnnotation 0..1AnnotationValue of extension

doco Documentation for this format

XML Template

<!-- annotation -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation" >
  <!-- from Element: extension -->
 <valueAnnotation><!-- 0..1 Annotation Value of extension --></valueAnnotation>
</extension>

JSON Template

{ // annotation
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation", // R! 
    "valueAnnotation" : { Annotation } //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')]))