Smart Health Checks
0.3.0 - ci-build Australia flag

Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions

Extension: Template Extract Extension Extended

Official URL: https://smartforms.csiro.au/ig/StructureDefinition/TemplateExtractExtensionExtended Version: 0.3.0
Draft as of 2025-09-23 Computable Name: TemplateExtractExtensionExtended

Copyright/Legal: Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/.

This extension is used to extend the Extract Template - Resource extension to include additional information that supports the extraction of a Parameters resource to be used with the FHIRPath patch mechanism of updating resources. An additional subextension is included to specify the type of resource that is being patched, which is necessary for constructing the request URL of an entry in a transaction bundle.

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 TemplateExtractExtension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* TemplateExtractExtension Template Extract Extension Extended
... Slices for extension Content/Rules for all slices
.... extension:type 0..1 Extension Patch resource type
..... extension 0..0
..... url 1..1 uri "type"
..... value[x] 1..1 code Value of extension
Binding: ResourceType (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* TemplateExtractExtension Template Extract Extension Extended
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:template 1..1 Extension Reference to contained resource template
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "template"
..... value[x] 1..1 Reference() {c} Contained reference to the resource template
.... extension:fullUrl 0..1 Extension A fhirpath expression to evaluate to populate the fullUrl property in the `Bundle.entry` (uri/string result)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "fullUrl"
..... value[x] 1..1 string Fhirpath Expression value
.... extension:resourceId 0..1 Extension A fhirpath expression to evaluate to populate the resourceId property (string result)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "resourceId"
..... value[x] 1..1 string Fhirpath Expression value
.... extension:ifNoneMatch 0..1 Extension A fhirpath expression to evaluate to populate the ifNoneMatch property (string result)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "ifNoneMatch"
..... value[x] 1..1 string Fhirpath Expression value
.... extension:ifModifiedSince 0..1 Extension A fhirpath expression to evaluate to populate the ifModifiedSince property (instant result)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "ifModifiedSince"
..... value[x] 1..1 string Fhirpath Expression value
.... extension:ifMatch 0..1 Extension A fhirpath expression to evaluate to populate the ifMatch property (string result)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "ifMatch"
..... value[x] 1..1 string Fhirpath Expression value
.... extension:ifNoneExist 0..1 Extension A fhirpath expression to evaluate to populate the ifNoneExist property (string result)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "ifNoneExist"
..... value[x] 1..1 string Fhirpath Expression value
.... extension:type 0..1 Extension Patch resource type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "type"
..... value[x] 1..1 code Value of extension
Binding: ResourceType (required)
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract"

doco Documentation for this format

This structure is derived from TemplateExtractExtension

Summary

Complex Extension: This extension is used to extend the Extract Template - Resource extension to include additional information that supports the extraction of a Parameters resource to be used with the FHIRPath patch mechanism of updating resources. An additional subextension is included to specify the type of resource that is being patched, which is necessary for constructing the request URL of an entry in a transaction bundle.

  • template: Reference: A reference to a contained resource to use as a template to put into the output transaction bundle.
  • fullUrl: string: A fhirpath expression to evaluate to extract the value into the fullUrl property. If no value is evaluated, then the element is not extracted.
  • resourceId: string: A fhirpath expression to evaluate to extract the value into the ifNoneMatch property. If no value is evaluated, then the element is not extracted.
  • ifNoneMatch: string: A fhirpath expression to evaluate to extract the value into the ifNoneMatch property. If no value is evaluated, then the element is not extracted.
  • ifModifiedSince: string: A fhirpath expression to evaluate to extract the value into the ifModifiedSince property. If no value is evaluated, then the element is not extracted.
  • ifMatch: string: A fhirpath expression to evaluate to extract the value into the ifMatch property. If no value is evaluated, then the element is not extracted.
  • ifNoneExist: string: A fhirpath expression to evaluate to extract the value into the ifNoneExist property. If no value is evaluated, then the element is not extracted.
  • type: code: When templating a Parameters resource, this is the kind of resource to be patched. It is used to construct the request URL for the entry in a transaction bundle.

Differential View

This structure is derived from TemplateExtractExtension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* TemplateExtractExtension Template Extract Extension Extended
... Slices for extension Content/Rules for all slices
.... extension:type 0..1 Extension Patch resource type
..... extension 0..0
..... url 1..1 uri "type"
..... value[x] 1..1 code Value of extension
Binding: ResourceType (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* TemplateExtractExtension Template Extract Extension Extended
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:template 1..1 Extension Reference to contained resource template
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "template"
..... value[x] 1..1 Reference() {c} Contained reference to the resource template
.... extension:fullUrl 0..1 Extension A fhirpath expression to evaluate to populate the fullUrl property in the `Bundle.entry` (uri/string result)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "fullUrl"
..... value[x] 1..1 string Fhirpath Expression value
.... extension:resourceId 0..1 Extension A fhirpath expression to evaluate to populate the resourceId property (string result)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "resourceId"
..... value[x] 1..1 string Fhirpath Expression value
.... extension:ifNoneMatch 0..1 Extension A fhirpath expression to evaluate to populate the ifNoneMatch property (string result)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "ifNoneMatch"
..... value[x] 1..1 string Fhirpath Expression value
.... extension:ifModifiedSince 0..1 Extension A fhirpath expression to evaluate to populate the ifModifiedSince property (instant result)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "ifModifiedSince"
..... value[x] 1..1 string Fhirpath Expression value
.... extension:ifMatch 0..1 Extension A fhirpath expression to evaluate to populate the ifMatch property (string result)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "ifMatch"
..... value[x] 1..1 string Fhirpath Expression value
.... extension:ifNoneExist 0..1 Extension A fhirpath expression to evaluate to populate the ifNoneExist property (string result)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "ifNoneExist"
..... value[x] 1..1 string Fhirpath Expression value
.... extension:type 0..1 Extension Patch resource type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "type"
..... value[x] 1..1 code Value of extension
Binding: ResourceType (required)
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-templateExtract"

doco Documentation for this format

This structure is derived from TemplateExtractExtension

Summary

Complex Extension: This extension is used to extend the Extract Template - Resource extension to include additional information that supports the extraction of a Parameters resource to be used with the FHIRPath patch mechanism of updating resources. An additional subextension is included to specify the type of resource that is being patched, which is necessary for constructing the request URL of an entry in a transaction bundle.

  • template: Reference: A reference to a contained resource to use as a template to put into the output transaction bundle.
  • fullUrl: string: A fhirpath expression to evaluate to extract the value into the fullUrl property. If no value is evaluated, then the element is not extracted.
  • resourceId: string: A fhirpath expression to evaluate to extract the value into the ifNoneMatch property. If no value is evaluated, then the element is not extracted.
  • ifNoneMatch: string: A fhirpath expression to evaluate to extract the value into the ifNoneMatch property. If no value is evaluated, then the element is not extracted.
  • ifModifiedSince: string: A fhirpath expression to evaluate to extract the value into the ifModifiedSince property. If no value is evaluated, then the element is not extracted.
  • ifMatch: string: A fhirpath expression to evaluate to extract the value into the ifMatch property. If no value is evaluated, then the element is not extracted.
  • ifNoneExist: string: A fhirpath expression to evaluate to extract the value into the ifNoneExist property. If no value is evaluated, then the element is not extracted.
  • type: code: When templating a Parameters resource, this is the kind of resource to be patched. It is used to construct the request URL for the entry in a transaction bundle.

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:type.value[x]requiredResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard

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()