Structured Data Capture
3.0.0 - STU 3 International flag

This page is part of the Structured Data Capture FHIR IG (v3.0.0: STU 3) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). 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: 3.0.0
Standards status: Trial-use Maturity Level: 3 Computable Name: SDCParametersQuestionnaireResponseExtractIn

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.

Formal Views of Profile Content

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

This structure is derived from Parameters

Summary

Fixed Value: 1 element
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:name

Maturity: 3

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter 0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:in 0..*BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: in
..... value[x] 0..0
..... resource 0..1SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractStructureMapExtractable Questionnaire - Observation
..... part 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣI0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
..... value[x] ΣI0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:in ΣI0..*BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Fixed Value: in
..... resource I0..1SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractStructureMapExtractable Questionnaire - Observation

doco Documentation for this format

This structure is derived from Parameters

Summary

Fixed Value: 1 element
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:name

Maturity: 3

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter 0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:in 0..*BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: in
..... value[x] 0..0
..... resource 0..1SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractStructureMapExtractable Questionnaire - Observation
..... part 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣI0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
..... value[x] ΣI0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:in ΣI0..*BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Fixed Value: in
..... resource I0..1SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractStructureMapExtractable Questionnaire - Observation

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Max Binding: AllLanguages

Constraints

IdGradePathDetailsRequirements
ele-1errorParameters.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1errorParameters.parameterA 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()))
ele-1errorParameters.parameter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorParameters.parameter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorParameters.parameter.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorParameters.parameter.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorParameters.parameter.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter.partAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter:inAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1errorParameters.parameter:inA 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()))
ele-1errorParameters.parameter:in.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorParameters.parameter:in.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorParameters.parameter:in.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorParameters.parameter:in.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorParameters.parameter:in.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
dom-2errorParameters.parameter:in.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorParameters.parameter:in.resourceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorParameters.parameter:in.resourceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorParameters.parameter:in.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeParameters.parameter:in.resourceA resource should have narrative for robust management
: text.`div`.exists()
que-0warningParameters.parameter:in.resourceName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
que-2errorParameters.parameter:in.resourceThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()