Structured Data Capture
4.0.0-ballot - STU 4 ballot International flag

This page is part of the Structured Data Capture FHIR IG (v4.0.0-ballot: STU 4 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 3.0.0. For a full list of available versions, 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-ballot
Standards status: Trial-use 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.

Usage:

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

Formal Views of Profile Content

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

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... Slices for parameter 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:in 0..* BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: in
..... value[x] 0..0
..... resource 0..1 SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractStructureMap Extractable Questionnaire - Observation
..... 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 Questionnaire If parameter is a whole resource
..... part 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for parameter ΣC 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
.... parameter:in ΣC 0..* BackboneElement Operation Parameter
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: in
..... resource 0..1 SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractStructureMap Extractable Questionnaire - Observation
.... parameter:questionnaire ΣC 0..1 BackboneElement Questionnaire reference for extraction
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: questionnaire
..... resource ΣC 0..1 Questionnaire If parameter is a whole resource

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
inv-1: A parameter must have one and only one of (value, resource, part)
.... 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:in ΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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: in
..... resource 0..1 SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractStructureMap Extractable Questionnaire - Observation
.... parameter:questionnaire ΣC 0..1 BackboneElement Questionnaire reference for extraction
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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 ΣC 0..1 Questionnaire If parameter is a whole resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

This structure is derived from Parameters

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... Slices for parameter 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:in 0..* BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: in
..... value[x] 0..0
..... resource 0..1 SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractStructureMap Extractable Questionnaire - Observation
..... 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 Questionnaire If parameter is a whole resource
..... part 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for parameter ΣC 0..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
.... parameter:in ΣC 0..* BackboneElement Operation Parameter
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: in
..... resource 0..1 SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractStructureMap Extractable Questionnaire - Observation
.... parameter:questionnaire ΣC 0..1 BackboneElement Questionnaire reference for extraction
ele-1: All FHIR elements must have a @value or children
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name Σ 1..1 string Name from the definition
ele-1: All FHIR elements must have a @value or children
Fixed Value: questionnaire
..... resource ΣC 0..1 Questionnaire If parameter is a whole resource

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
inv-1: A parameter must have one and only one of (value, resource, part)
.... 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:in ΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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: in
..... resource 0..1 SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractStructureMap Extractable Questionnaire - Observation
.... parameter:questionnaire ΣC 0..1 BackboneElement Questionnaire reference for extraction
inv-1: A parameter must have one and only one of (value, resource, part)
..... 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 ΣC 0..1 Questionnaire If parameter is a whole resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

This structure is derived from Parameters

 

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.