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
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
This profile defines the constraints on the 'input' Parameters for the QuestionnaireResponse extract operation.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Parameters
This structure is derived from Parameters
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
id | Σ | 0..1 | string | 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 |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
Slices for parameter | ΣI | 0..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name |
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] | ΣI | 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 | ΣI | 0..1 | Resource | If parameter is a whole resource |
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
parameter:in | ΣI | 0..* | BackboneElement | Operation Parameter |
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 | I | 0..1 | SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractStructureMap | Extractable Questionnaire - Observation |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
Documentation for this format |
This structure is derived from Parameters
Differential View
This structure is derived from Parameters
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
id | Σ | 0..1 | string | 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 |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
Slices for parameter | ΣI | 0..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name |
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] | ΣI | 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 | ΣI | 0..1 | Resource | If parameter is a whole resource |
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
parameter:in | ΣI | 0..* | BackboneElement | Operation Parameter |
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 | I | 0..1 | SDCQuestionnaireExtractObservation, SDCQuestionnaireExtractDefinition, SDCQuestionnaireExtractStructureMap | Extractable Questionnaire - Observation |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Parameters.language | preferred | CommonLanguages Max Binding: AllLanguages |
Id | Grade | Path | Details | Requirements |
ele-1 | error | Parameters.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Parameters.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Parameters.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Parameters.parameter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
inv-1 | error | Parameters.parameter | 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())) | |
ele-1 | error | Parameters.parameter.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Parameters.parameter.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Parameters.parameter.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Parameters.parameter.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Parameters.parameter.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Parameters.parameter.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Parameters.parameter.part | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Parameters.parameter:in | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
inv-1 | error | Parameters.parameter:in | 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())) | |
ele-1 | error | Parameters.parameter:in.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Parameters.parameter:in.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Parameters.parameter:in.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Parameters.parameter:in.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Parameters.parameter:in.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
dom-2 | error | Parameters.parameter:in.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Parameters.parameter:in.resource | If 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-4 | error | Parameters.parameter:in.resource | If 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-5 | error | Parameters.parameter:in.resource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Best Practice | Parameters.parameter:in.resource | A resource should have narrative for robust management : text.`div`.exists() | |
que-0 | warning | Parameters.parameter:in.resource | Name 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-2 | error | Parameters.parameter:in.resource | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() |