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

Resource Profile: Questionnaire extract operation input parameters

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/parameters-questionnaireresponse-extract-in Version: 4.0.0
Standards status: Trial-use Active as of 2025-10-22 Maturity Level: 4 Computable Name: SDCParametersQuestionnaireResponseExtractIn
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.5

Profile used to validate the parameters that are the input of the 'extract' questionnaire response operation

Scope and Usage

This profile defines the constraints on the 'input' Parameters for the QuestionnaireResponse extract operation.

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:questionnaire-response ΣC 0..1 BackboneElement QuestionnarieResponse to extract from
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: questionnaire-response
..... resource 0..1 SDCQuestionnaireResponse Standard Questionnaire Response
.... parameter:questionnaire ΣC 0..1 BackboneElement Questionnaire reference for extraction
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: questionnaire
..... resource 0..1 SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractTemplate, SDCQuestionnaireExtractStructureMap Extractable Questionnaire - Observation

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()
inv-1 error Parameters.parameter, Parameters.parameter:questionnaire-response, Parameters.parameter:questionnaire A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... Slices for parameter 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:questionnaire-response 0..1 BackboneElement QuestionnarieResponse to extract from
..... name 1..1 string Name from the definition
Fixed Value: questionnaire-response
..... value[x] 0..0
..... resource 0..1 SDCQuestionnaireResponse Standard Questionnaire Response
..... part 0..0
.... parameter:questionnaire 0..1 BackboneElement Questionnaire reference for extraction
..... name 1..1 string Name from the definition
Fixed Value: questionnaire
..... value[x] 0..0
..... resource 0..1 SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractTemplate, SDCQuestionnaireExtractStructureMap Extractable Questionnaire - Observation
..... part 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:questionnaire-response ΣC 0..1 BackboneElement QuestionnarieResponse to extract from
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: questionnaire-response
..... resource 0..1 SDCQuestionnaireResponse Standard Questionnaire Response
.... parameter:questionnaire ΣC 0..1 BackboneElement Questionnaire reference for extraction
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: questionnaire
..... resource 0..1 SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractTemplate, SDCQuestionnaireExtractStructureMap Extractable Questionnaire - Observation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.

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()
inv-1 error Parameters.parameter, Parameters.parameter:questionnaire-response, Parameters.parameter:questionnaire A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:questionnaire-response ΣC 0..1 BackboneElement QuestionnarieResponse to extract from
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: questionnaire-response
..... resource 0..1 SDCQuestionnaireResponse Standard Questionnaire Response
.... parameter:questionnaire ΣC 0..1 BackboneElement Questionnaire reference for extraction
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: questionnaire
..... resource 0..1 SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractTemplate, SDCQuestionnaireExtractStructureMap Extractable Questionnaire - Observation

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()
inv-1 error Parameters.parameter, Parameters.parameter:questionnaire-response, Parameters.parameter:questionnaire A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... Slices for parameter 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:questionnaire-response 0..1 BackboneElement QuestionnarieResponse to extract from
..... name 1..1 string Name from the definition
Fixed Value: questionnaire-response
..... value[x] 0..0
..... resource 0..1 SDCQuestionnaireResponse Standard Questionnaire Response
..... part 0..0
.... parameter:questionnaire 0..1 BackboneElement Questionnaire reference for extraction
..... name 1..1 string Name from the definition
Fixed Value: questionnaire
..... value[x] 0..0
..... resource 0..1 SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractTemplate, SDCQuestionnaireExtractStructureMap Extractable Questionnaire - Observation
..... part 0..0

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:questionnaire-response ΣC 0..1 BackboneElement QuestionnarieResponse to extract from
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: questionnaire-response
..... resource 0..1 SDCQuestionnaireResponse Standard Questionnaire Response
.... parameter:questionnaire ΣC 0..1 BackboneElement Questionnaire reference for extraction
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: questionnaire
..... resource 0..1 SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractTemplate, SDCQuestionnaireExtractStructureMap Extractable Questionnaire - Observation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.

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()
inv-1 error Parameters.parameter, Parameters.parameter:questionnaire-response, Parameters.parameter:questionnaire A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

 

Other representations of profile: CSV, Excel, Schematron

Notes:

A service performing extraction should be able to resolve the Questionnaire in one of the following ways: as a contained resource (if referenced that way), as an instance on the server, or via the 'questionnaire' parameter. The Questionnaire provided SHALL have the same canonical URL (and, if present, version) as the QuestionnaireResponse.questionnaire.