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

(No assigned work group) (fhiri) (3)

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile

Version: 5.0.0-ballot

Name: sourceFile

Title: sourceFile

Modifier: This extension is not a modifier extension

Status: draft

Definition: Identifies files used as part of the the publication process other than resources referenced in definition.resource.

Committee: ??

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

Identifies files used as part of the the publication process other than resources referenced in definition.resource.

Comment:

When 'exporting' the referenced file for use in publication, if storing the content as a resource, the exported syntax (XML, JSON, or RDF) should be driven by the file extension of the specified location.

Context of Use: Use on Element ID ImplementationGuide.definition

Summary

Name	Card.	Type	Description & Constraints
sourceFile	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile sourceFile: Identifies files used as part of the the publication process other than resources referenced in definition.resource. Use on Element ID ImplementationGuide.definition
file	1..1	Reference()	Location on server
file	1..1	string	Path for publisher
file	0..1	boolean	Use attachment or resource?
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile sourceFile: Identifies files used as part of the the publication process other than resources referenced in definition.resource. Use on Element ID ImplementationGuide.definition
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:file	1..1	Extension	Location on server
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"file"
value[x]	1..1	Reference()	Value of extension
extension:location	1..1	Extension	Path for publisher
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"file"
value[x]	1..1	string	Value of extension
extension:keepAsResource	0..1	Extension	Use attachment or resource?
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"file"
value[x]	1..1	boolean	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile"
value[x]	0..0
Documentation for this format

XML Template

<!-- sourceFile -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="file"> I 1..1 Extension  <!-- I 1..1 Location on server -->
  <valueReference><!-- I 1..1 Reference Value of extension --></valueReference>
 </extension>
 <extension url="file"> I 1..1 Extension  <!-- I 1..1 Path for publisher -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="file"> I 0..1 Extension  <!-- I 0..1 Use attachment or resource? -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // sourceFile
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Location on server // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "file", // R! 
        "valueReference" : { Reference } // I R! Value of extension
      },
      { // Path for publisher // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "file", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Use attachment or resource? // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "file", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Location on server
    "extension" : { Extension }, // I R! Path for publisher
    "extension" : { Extension }, // IUse attachment or resource?
    "url" : "http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
sourceFile	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile sourceFile: Identifies files used as part of the the publication process other than resources referenced in definition.resource. Use on Element ID ImplementationGuide.definition
file	1..1	Reference()	Location on server
file	1..1	string	Path for publisher
file	0..1	boolean	Use attachment or resource?
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile sourceFile: Identifies files used as part of the the publication process other than resources referenced in definition.resource. Use on Element ID ImplementationGuide.definition
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:file	1..1	Extension	Location on server
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"file"
value[x]	1..1	Reference()	Value of extension
extension:location	1..1	Extension	Path for publisher
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"file"
value[x]	1..1	string	Value of extension
extension:keepAsResource	0..1	Extension	Use attachment or resource?
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"file"
value[x]	1..1	boolean	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile"
value[x]	0..0
Documentation for this format

XML Template

<!-- sourceFile -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="file"> I 1..1 Extension  <!-- I 1..1 Location on server -->
  <valueReference><!-- I 1..1 Reference Value of extension --></valueReference>
 </extension>
 <extension url="file"> I 1..1 Extension  <!-- I 1..1 Path for publisher -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="file"> I 0..1 Extension  <!-- I 0..1 Use attachment or resource? -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // sourceFile
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Location on server // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "file", // R! 
        "valueReference" : { Reference } // I R! Value of extension
      },
      { // Path for publisher // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "file", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Use attachment or resource? // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "file", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Location on server
    "extension" : { Extension }, // I R! Path for publisher
    "extension" : { Extension }, // IUse attachment or resource?
    "url" : "http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile" // R! 
  // value[x]: Value of extension: Prohibited
  }

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.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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
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.