Release 5 Ballot

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

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

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

Version: 5.0.0-ballot

Name: name

Title: null

Modifier: This extension is not a modifier extension

Status: draft

Definition: A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Committee: FHIR Infrastructure Work Group

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

A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Comment:

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Context of Use: Use on Element ID Element

Summary

Name	Flags	Card.	Type	Description & Constraints
name		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/artifact-name name: A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. 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-name name: A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. Use on Element ID Element
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-name"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- name -->

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

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
name		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/artifact-name name: A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. 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-name name: A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. Use on Element ID Element
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/artifact-name"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- name -->

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

JSON Template

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