FHIR Clinical Guidelines (v1.0.0) (STU1)

Clinical Practice Guidelines, published by Clinical Decision Support WG. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

D.4.1 StructureDefinition-cpg-questionnaireresponse

Introduction:

Examples:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-questionnaireresponse

The response to a particular questionnaire as an activity within the context of a computable clinical practice guideline

This profile builds on QuestionnaireResponse.

This profile was published on Thu Jun 06 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseA structured set of questions and their answers
... identifier S0..1IdentifierUnique id for this set of answers
... questionnaire S0..1canonical(Questionnaire)Form being answered
... status S1..1codein-progress | completed | amended | entered-in-error | stopped
... subject S0..1Reference(CPGPatient | CPGRelatedPerson)The subject of the questions
... encounter S0..1Reference(CPGEncounter)Encounter created as part of
... authored S0..1dateTimeDate the answers were gathered
... author S0..1Reference(CPGPatient | CPGPractitioner | CPGPractitionerRole | CPGRelatedPerson)Person who received and recorded the answers
... source S0..1Reference(CPGPatient | CPGPractitioner | CPGPractitionerRole | CPGRelatedPerson)The person who answered the questions
... item S0..*BackboneElementGroups and questions

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseA structured set of questions and their answers
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..1IdentifierUnique id for this set of answers
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)Request fulfilled by this QuestionnaireResponse
... partOf Σ0..*Reference(Observation | Procedure)Part of this action
... questionnaire SΣ0..1canonical(Questionnaire)Form being answered
... status ?!SΣ1..1codein-progress | completed | amended | entered-in-error | stopped
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.

... subject SΣ0..1Reference(CPGPatient | CPGRelatedPerson)The subject of the questions
... encounter SΣ0..1Reference(CPGEncounter)Encounter created as part of
... authored SΣ0..1dateTimeDate the answers were gathered
... author SΣ0..1Reference(CPGPatient | CPGPractitioner | CPGPractitionerRole | CPGRelatedPerson)Person who received and recorded the answers
... source SΣ0..1Reference(CPGPatient | CPGPractitioner | CPGPractitionerRole | CPGRelatedPerson)The person who answered the questions
... item SI0..*BackboneElementGroups and questions
.... 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
.... linkId 1..1stringPointer to specific item from Questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... text 0..1stringName for group or question text
.... answer 0..*BackboneElementThe response(s) to the question
..... 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
..... value[x] 0..1Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)
..... item 0..*See item (QuestionnaireResponse)Nested groups and questions
.... item 0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseA structured set of questions and their answers
... identifier S0..1IdentifierUnique id for this set of answers
... questionnaire S0..1canonical(Questionnaire)Form being answered
... status S1..1codein-progress | completed | amended | entered-in-error | stopped
... subject S0..1Reference(CPGPatient | CPGRelatedPerson)The subject of the questions
... encounter S0..1Reference(CPGEncounter)Encounter created as part of
... authored S0..1dateTimeDate the answers were gathered
... author S0..1Reference(CPGPatient | CPGPractitioner | CPGPractitionerRole | CPGRelatedPerson)Person who received and recorded the answers
... source S0..1Reference(CPGPatient | CPGPractitioner | CPGPractitionerRole | CPGRelatedPerson)The person who answered the questions
... item S0..*BackboneElementGroups and questions

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseA structured set of questions and their answers
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..1IdentifierUnique id for this set of answers
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)Request fulfilled by this QuestionnaireResponse
... partOf Σ0..*Reference(Observation | Procedure)Part of this action
... questionnaire SΣ0..1canonical(Questionnaire)Form being answered
... status ?!SΣ1..1codein-progress | completed | amended | entered-in-error | stopped
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.

... subject SΣ0..1Reference(CPGPatient | CPGRelatedPerson)The subject of the questions
... encounter SΣ0..1Reference(CPGEncounter)Encounter created as part of
... authored SΣ0..1dateTimeDate the answers were gathered
... author SΣ0..1Reference(CPGPatient | CPGPractitioner | CPGPractitionerRole | CPGRelatedPerson)Person who received and recorded the answers
... source SΣ0..1Reference(CPGPatient | CPGPractitioner | CPGPractitionerRole | CPGRelatedPerson)The person who answered the questions
... item SI0..*BackboneElementGroups and questions
.... 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
.... linkId 1..1stringPointer to specific item from Questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... text 0..1stringName for group or question text
.... answer 0..*BackboneElementThe response(s) to the question
..... 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
..... value[x] 0..1Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)
..... item 0..*See item (QuestionnaireResponse)Nested groups and questions
.... item 0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
QuestionnaireResponse.languagepreferredCommonLanguages
Max Binding: AllLanguages
QuestionnaireResponse.statusrequiredQuestionnaireResponseStatus
QuestionnaireResponse.item.answer.value[x]exampleQuestionnaireAnswerCodes

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2QuestionnaireResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3QuestionnaireResponseIf 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-4QuestionnaireResponseIf 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-5QuestionnaireResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6QuestionnaireResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1QuestionnaireResponse.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.questionnaireAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.authoredAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.sourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.itemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
qrs-1QuestionnaireResponse.itemNested item can't be beneath both item and answer
: (answer.exists() and item.exists()).not()
ele-1QuestionnaireResponse.item.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.item.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.item.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.item.linkIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.item.definitionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.item.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.item.answerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.item.answer.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.item.answer.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.item.answer.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1QuestionnaireResponse.item.answer.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1QuestionnaireResponse.item.answer.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.item.answer.itemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1QuestionnaireResponse.item.itemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())