FHIR Release 3 (STU) R4 Ballot #1 (Mixed Normative/Trial use)

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

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use 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: Element ID StructureDefinition

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Annotation URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation
annotation: Additional notes about any item in a structure definition.


Use on element: Element ID StructureDefinition

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation
annotation: Additional notes about any item in a structure definition.


Use on element: Element ID StructureDefinition
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation" "http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation"
. . . valueAnnotation 0..1 Annotation Value 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

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Annotation URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation
annotation: Additional notes about any item in a structure definition.


Use on element: Element ID StructureDefinition

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation
annotation: Additional notes about any item in a structure definition.


Use on element: Element ID StructureDefinition
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation" "http://hl7.org/fhir/StructureDefinition/structuredefinition-annotation"
. . . valueAnnotation 0..1 Annotation Value 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')]) )