Structured Data Capture
4.0.0-ballot - STU 4 ballot 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-ballot 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 Definition - Extract value

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-definitionExtractValue Version: 4.0.0-ballot
Standards status: Draft Maturity Level: 0 Computable Name: DefinitionExtractValueExtension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.82

Provide either a fixed value, or an expression to evaluate, to be used as the value for the extracted resource's property based on the definition value.

Context of Use

This extension will only be processed while extracting a resource based on a parent item (or root) using either the definitionExtract or itemExtractionContext (legacy) extension.

It is used to define the value of a property on the resource being extracted, without requiring an item/answer in the questionnaire response (typically for fixed, or derived/calculated values).

The property is based on the value in the definition property, where the prefix (before the #) must exactly match the profile's canonical URL from the extraction context in a parent item/root.

Additional details on the use of this extension can be found on the Data Extraction page.

Usage info

Usage:

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 & Constraintsdoco
.. Extension C 0..* Extension Fixed or calculated value to extract
dev-1: Either `expression` or a `fixed-value` must be provided.
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:definition 1..1 Extension ElementDefintion to extract value into
..... extension 0..0
..... url 1..1 uri "definition"
..... value[x] 1..1 uri Profile canonical URL and element id
.... extension:expression 0..1 Extension An expression to evaluate
..... extension 0..0
..... url 1..1 uri "expression"
..... value[x] 1..1 Expression Expression value
.... extension:fixed-value 0..1 Extension A fixed value to extract
..... extension 0..0
..... url 1..1 uri "fixed-value"
..... value[x] 1..1 base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta Fixed value
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-definitionExtractValue"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
dev-1errorExtensionEither `expression` or a `fixed-value` must be provided.
: extension('expression').value.exists() xor extension('fixed-value').value.exists()