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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: interface

URL for this extension:

http://hl7.org/fhir/StructureDefinition/structuredefinition-interface

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
• Full Structure
• XML
• JSON
• All

Summary

Name	Flags	Card.	Type	Description & Constraints
interface		0..1	boolean	URL = 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
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = 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	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/structuredefinition-interface"
value[x]	I	1..1	boolean	Value of extension
Documentation for this format

XML Template

<!-- interface -->

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

JSON Template

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

Summary

Name	Flags	Card.	Type	Description & Constraints
interface		0..1	boolean	URL = 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
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = 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	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/structuredefinition-interface"
value[x]	I	1..1	boolean	Value of extension
Documentation for this format

XML Template

<!-- interface -->

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

JSON Template

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