2.7.0 - STU 3 (2nd ballot)

This page is part of the Structured Data Capture FHIR IG (v2.7.0: STU 3 Ballot 2) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: ParametersQuestionnaireResponseExtractIn

The official URL for this profile is:

http://hl7.org/fhir/uv/sdc/StructureDefinition/parameters-questionnaireresponse-extract-in

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

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*Operation Request or Response
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... parameter ΣIBackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... 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..1base64Binary, 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, DosageIf parameter is a data type
.... resource ΣI0..1ResourceIf parameter is a whole resource
.... part Σ0..*Unknown reference to #Parameters.parameter
Named part of a multi-part parameter
... parameter Σ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..1QuestionnaireExtractExtractable Questionnaire

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

Differential View

This structure is derived from Parameters

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*Operation Request or Response
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... parameter ΣIBackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... 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..1base64Binary, 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, DosageIf parameter is a data type
.... resource ΣI0..1ResourceIf parameter is a whole resource
.... part Σ0..*Unknown reference to #Parameters.parameter
Named part of a multi-part parameter
... parameter Σ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..1QuestionnaireExtractExtractable Questionnaire

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Constraints

IdPathDetailsRequirements
ele-1Parameters.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1Parameters.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()))
dom-2Parameters.parameter.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4Parameters.parameter.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-3Parameters.parameter.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-6Parameters.parameter.resourceA resource should have narrative for robust management
: text.div.exists()
dom-5Parameters.parameter.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
que-2Parameters.parameter.resourceThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-0Parameters.parameter.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}')
ele-1Parameters.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1Parameters.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()))
dom-2Parameters.parameter.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4Parameters.parameter.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-3Parameters.parameter.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-6Parameters.parameter.resourceA resource should have narrative for robust management
: text.div.exists()
dom-5Parameters.parameter.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
que-2Parameters.parameter.resourceThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-0Parameters.parameter.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}')