FHIR Tooling Extensions IG
0.6.0 - Release 0.2.0 International flag

This page is part of the HL7 Tools Extension IG (v0.6.0: Release - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 0.7.0. For a full list of available versions, see the Directory of published versions

Extension: Resource Fragment

Official URL: http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-fragment Version: 0.6.0
Standards status: Informative Maturity Level: 4 Computable Name: ResourceFragment
Other Identifiers: OID:2.16.840.1.113883.4.642.40.1.42.22

Defines fragments, possibly with ellipsed content, to generate from a specified resource for a embedding as part of resource pages.

Context of Use

Usage info

Usages:

  • This Extension is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Fragment to generate from resource
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:id 1..1 Extension Filename suffix
..... extension 0..0
..... url 1..1 uri "id"
..... value[x] 1..1 id Value of extension
.... extension:base 0..1 Extension FHIRPath to fragment root
..... extension 0..0
..... url 1..1 uri "base"
..... value[x] 1..1 string Value of extension
.... extension:ellipse 0..* Extension Element(s) to ellipse
..... extension 0..0
..... url 1..1 uri "ellipse"
..... value[x] 1..1 string Value of extension
.... extension:ellipseExcept 0..* Extension Element(s) to NOT ellipse
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:base 0..1 Extension FHIRPath to element(s) whose children will be ellipsed
....... extension 0..0
....... url 1..1 uri "base"
....... value[x] 1..1 string Value of extension
...... extension:except 0..* Extension FHIRPath to element(s) to exclude from ellipsing
....... extension 0..0
....... url 1..1 uri "except"
....... value[x] 1..1 string Value of extension
..... url 1..1 uri "ellipseExcept"
..... value[x] 0..0
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-fragment"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Fragment to generate from resource
... id 0..1 id Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:id 1..1 Extension Filename suffix
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "id"
..... value[x] 1..1 id Value of extension
.... extension:base 0..1 Extension FHIRPath to fragment root
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "base"
..... value[x] 1..1 string Value of extension
.... extension:ellipse 0..* Extension Element(s) to ellipse
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "ellipse"
..... value[x] 1..1 string Value of extension
.... extension:ellipseExcept 0..* Extension Element(s) to NOT ellipse
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:base 0..1 Extension FHIRPath to element(s) whose children will be ellipsed
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "base"
....... value[x] 1..1 string Value of extension
...... extension:except 0..* Extension FHIRPath to element(s) to exclude from ellipsing
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "except"
....... value[x] 1..1 string Value of extension
..... url 1..1 uri "ellipseExcept"
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-fragment"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Defines fragments, possibly with ellipsed content, to generate from a specified resource for a embedding as part of resource pages.

  • id: id: An id that will be appended to the base resource name to form the name for this particular fragment
  • base: string: The path to the element to use as the 'root' of the published fragment. If not specified, the fragment root will be the resource root
  • ellipse: string: A path with a context of the fragment base that resolves to 1 or more elements that are to be ellipsed out of the generated fragment.
  • base: string: A FHIRPath with a context of the root of the fragment that resolves to the element(s) for which most children should be ellipsed. If not specified, the base will be the root of the fragement
  • except: string: FHIRPath to child element(s) that should NOT be ellipsed. These will be excluded when ellipsing the child nodes.

Maturity: 4

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Fragment to generate from resource
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:id 1..1 Extension Filename suffix
..... extension 0..0
..... url 1..1 uri "id"
..... value[x] 1..1 id Value of extension
.... extension:base 0..1 Extension FHIRPath to fragment root
..... extension 0..0
..... url 1..1 uri "base"
..... value[x] 1..1 string Value of extension
.... extension:ellipse 0..* Extension Element(s) to ellipse
..... extension 0..0
..... url 1..1 uri "ellipse"
..... value[x] 1..1 string Value of extension
.... extension:ellipseExcept 0..* Extension Element(s) to NOT ellipse
..... extension 1..* Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:base 0..1 Extension FHIRPath to element(s) whose children will be ellipsed
....... extension 0..0
....... url 1..1 uri "base"
....... value[x] 1..1 string Value of extension
...... extension:except 0..* Extension FHIRPath to element(s) to exclude from ellipsing
....... extension 0..0
....... url 1..1 uri "except"
....... value[x] 1..1 string Value of extension
..... url 1..1 uri "ellipseExcept"
..... value[x] 0..0
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-fragment"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Fragment to generate from resource
... id 0..1 id Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:id 1..1 Extension Filename suffix
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "id"
..... value[x] 1..1 id Value of extension
.... extension:base 0..1 Extension FHIRPath to fragment root
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "base"
..... value[x] 1..1 string Value of extension
.... extension:ellipse 0..* Extension Element(s) to ellipse
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "ellipse"
..... value[x] 1..1 string Value of extension
.... extension:ellipseExcept 0..* Extension Element(s) to NOT ellipse
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:base 0..1 Extension FHIRPath to element(s) whose children will be ellipsed
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "base"
....... value[x] 1..1 string Value of extension
...... extension:except 0..* Extension FHIRPath to element(s) to exclude from ellipsing
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "except"
....... value[x] 1..1 string Value of extension
..... url 1..1 uri "ellipseExcept"
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-fragment"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Defines fragments, possibly with ellipsed content, to generate from a specified resource for a embedding as part of resource pages.

  • id: id: An id that will be appended to the base resource name to form the name for this particular fragment
  • base: string: The path to the element to use as the 'root' of the published fragment. If not specified, the fragment root will be the resource root
  • ellipse: string: A path with a context of the fragment base that resolves to 1 or more elements that are to be ellipsed out of the generated fragment.
  • base: string: A FHIRPath with a context of the root of the fragment that resolves to the element(s) for which most children should be ellipsed. If not specified, the base will be the root of the fragement
  • except: string: FHIRPath to child element(s) that should NOT be ellipsed. These will be excluded when ellipsing the child nodes.

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()