Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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: purpose

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose

Version: 5.0.0-ballot

Name: purpose

Title: null

Modifier: This extension is not a modifier extension

Status: draft

Definition: Explanation of why this {{title}} is needed and why it has been designed as it has.

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: Health Level Seven, Inc. - CDS WG

Explanation of why this {{title}} is needed and why it has been designed as it has.

Comment:

This element does not describe the usage of the {{title}}. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this {{title}}.

Context of Use: Use on Element ID Element

Summary

Name	Flags	Card.	Type	Description & Constraints
purpose		0..1	markdown	URL = http://hl7.org/fhir/StructureDefinition/artifact-purpose purpose: Explanation of why this {{title}} is needed and why it has been designed as it has. Use on Element ID Element
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/artifact-purpose purpose: Explanation of why this {{title}} is needed and why it has been designed as it has. Use on Element ID Element
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-purpose"
value[x]	1..1	markdown	Value of extension
Documentation for this format

XML Template

<!-- purpose -->

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

JSON Template

{ // purpose
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/artifact-purpose", // R! 
    "valueMarkdown" : "<markdown>" // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
purpose		0..1	markdown	URL = http://hl7.org/fhir/StructureDefinition/artifact-purpose purpose: Explanation of why this {{title}} is needed and why it has been designed as it has. Use on Element ID Element
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/artifact-purpose purpose: Explanation of why this {{title}} is needed and why it has been designed as it has. Use on Element ID Element
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-purpose"
value[x]	1..1	markdown	Value of extension
Documentation for this format

XML Template

<!-- purpose -->

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

JSON Template

{ // purpose
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/artifact-purpose", // R! 
    "valueMarkdown" : "<markdown>" // I 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)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.