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: interface

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

Summary

Defining URL:http://hl7.org/fhir/StructureDefinition/structuredefinition-interface
Version:5.0.0-ballot
Name:interface
Title:Interface
Modifier:This extension is not a modifier extension
Status:draft
Definition:Marks that the resource definition represents an [interface](uml.html#interface) rather than a resource.
Committee:FHIR Infrastructure Work Group

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

Marks that the resource definition represents an interface rather than a resource.

Context of Use: Use on Element ID StructureDefinition

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. interface0..1booleanURL = http://hl7.org/fhir/StructureDefinition/structuredefinition-interface
interface: Marks that the resource definition represents an interface rather than a resource.


Use on Element ID StructureDefinition

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/structuredefinition-interface
interface: Marks that the resource definition represents an interface rather than a resource.


Use on Element ID StructureDefinition
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/structuredefinition-interface"
... value[x] 1..1booleanValue of extension

doco Documentation for this format

XML Template

<!-- interface -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-interface" >
  <!-- from Element: extension -->
 <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

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

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. interface0..1booleanURL = http://hl7.org/fhir/StructureDefinition/structuredefinition-interface
interface: Marks that the resource definition represents an interface rather than a resource.


Use on Element ID StructureDefinition

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/structuredefinition-interface
interface: Marks that the resource definition represents an interface rather than a resource.


Use on Element ID StructureDefinition
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/structuredefinition-interface"
... value[x] 1..1booleanValue of extension

doco Documentation for this format

XML Template

<!-- interface -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-interface" >
  <!-- from Element: extension -->
 <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
</extension>

JSON Template

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