Structured Data Capture
4.0.0 - International flag

Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

Extension: Extract - Allocate new uuid

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extractAllocateId Version: 4.0.0
Standards status: Draft Draft as of 2025-10-22 Maturity Level: 0 Computable Name: ExtractAllocateIdExtension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.84

Allocate a new uuid in a named variable for use in extraction. This is usually used to set the fullUrl for a resource in the output extraction bundle, and then referenced in other resources within that transaction bundle (via fhirpath expressions).

Context of Use

Scope and Usage

This extension currently only applies to either the definition or template extraction processing.

The value will be made available as a named variable in extract fhirpath expressions, and only within the scope of the item that contains the extension, and any child items of that collection.

When defined at the root of a questionnaire, the value will be available for all items in the questionnaire (and only allocated once).

When defined on a repeating item, the value will be new for each iteration of the item in the QuestionnaireResponse answers.

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Variable name for the new uuid.
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extractAllocateId"
... value[x] 1..1 string Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Variable name for the new uuid.
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extractAllocateId"

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Simple Extension with the type string: Allocate a new uuid in a named variable for use in extraction. This is usually used to set the fullUrl for a resource in the output extraction bundle, and then referenced in other resources within that transaction bundle (via fhirpath expressions).

Maturity: 0

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Variable name for the new uuid.
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extractAllocateId"
... value[x] 1..1 string Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Variable name for the new uuid.
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extractAllocateId"

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Simple Extension with the type string: Allocate a new uuid in a named variable for use in extraction. This is usually used to set the fullUrl for a resource in the output extraction bundle, and then referenced in other resources within that transaction bundle (via fhirpath expressions).

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron