Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #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 . Page versions: R4B R4

Extension: Design Note

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/designNote

Status: draft. Extension maintained by: Health Level Seven International (FHIR Infrastructure)

Information captured by the author/maintainer of the questionnaire for development purposes, not intended to be seen by users.

Comment:

Allows capture of todos, rationale for design decisions, etc.

Context of Use: Use on Element ID Questionnaire, Element ID Questionnaire.item, Element ID Questionnaire.item.item or Element ID ElementDefinition

Summary

Name	Flags	Card.	Type	Description & Constraints
Design Note		0..1	markdown	URL = http://hl7.org/fhir/StructureDefinition/designNote Design Note: Information captured by the author/maintainer of the questionnaire for development purposes, not intended to be seen by users. Use on Element ID Questionnaire, Element ID Questionnaire.item, Element ID Questionnaire.item.item or Element ID ElementDefinition
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/designNote Design Note: Information captured by the author/maintainer of the questionnaire for development purposes, not intended to be seen by users. Use on Element ID Questionnaire, Element ID Questionnaire.item, Element ID Questionnaire.item.item or Element ID ElementDefinition
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/designNote"
value[x]	I	1..1	markdown	Value of extension
Documentation for this format

XML Template

<!-- Design Note -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/designNote" >
  <!-- from Element: extension -->
 <valueMarkdown value="[markdown]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // Design Note
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/designNote", // R! 
    "valueMarkdown" : "<markdown>" // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
Design Note		0..1	markdown	URL = http://hl7.org/fhir/StructureDefinition/designNote Design Note: Information captured by the author/maintainer of the questionnaire for development purposes, not intended to be seen by users. Use on Element ID Questionnaire, Element ID Questionnaire.item, Element ID Questionnaire.item.item or Element ID ElementDefinition
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/designNote Design Note: Information captured by the author/maintainer of the questionnaire for development purposes, not intended to be seen by users. Use on Element ID Questionnaire, Element ID Questionnaire.item, Element ID Questionnaire.item.item or Element ID ElementDefinition
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/designNote"
value[x]	I	1..1	markdown	Value of extension
Documentation for this format

XML Template

<!-- Design Note -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/designNote" >
  <!-- from Element: extension -->
 <valueMarkdown value="[markdown]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // Design Note
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/designNote", // R! 
    "valueMarkdown" : "<markdown>" // C? R! 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')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)