Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CRMI Publishable Questionnaire

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablequestionnaire Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: CRMIPublishableQuestionnaire
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.41

Supports declaration of the Questionnaire metadata required by HL7 and other organizations that share and publish questionnaires with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Questionnaire C 1..1 Questionnaire A structured set of questions
Constraints: que-0, que-2, pub-1
Questionnaire.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Questionnaire.meta.Slices for extension Content/Rules for all slices
Questionnaire.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Questionnaire.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Questionnaire.Slices for extension Content/Rules for all slices
Questionnaire.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Questionnaire.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
Questionnaire.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Questionnaire.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Questionnaire.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Questionnaire.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Questionnaire.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Questionnaire.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Questionnaire.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Questionnaire.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
Questionnaire.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
Questionnaire.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Questionnaire.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Questionnaire.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Questionnaire.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Questionnaire.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the questionnaire
Questionnaire.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Questionnaire.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
Questionnaire.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Questionnaire.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Questionnaire.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Questionnaire.purpose This element must be supported. 0..1 markdown Why this questionnaire is defined
Questionnaire.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Questionnaire.approvalDate This element must be supported. 0..1 date When the questionnaire was approved by publisher
Questionnaire.lastReviewDate This element must be supported. 0..1 date When the questionnaire was last reviewed
Questionnaire.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the questionnaire is expected to be used

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Questionnaire.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Questionnaire.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Questionnaire.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Questionnaire 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 Questionnaire 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 Questionnaire If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Questionnaire A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error Questionnaire If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
que-0 warning Questionnaire 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 Questionnaire The link ids for groups and questions must be unique within the questionnaire descendants().linkId.isDistinct()

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Questionnaire C 1..1 Questionnaire A structured set of questions
Constraints: pub-1
Questionnaire.meta
Questionnaire.meta.Slices for extension Content/Rules for all slices
Questionnaire.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Questionnaire.Slices for extension Content/Rules for all slices
Questionnaire.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Questionnaire.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
Questionnaire.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Questionnaire.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Questionnaire.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Questionnaire.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Questionnaire.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Questionnaire.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Questionnaire.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Questionnaire.Slices for extension.extension:relatedArtifact.value[x]
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Questionnaire.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Questionnaire.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Questionnaire.identifier This element must be supported. 0..* Identifier Additional identifier for the questionnaire
Questionnaire.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
Questionnaire.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
Questionnaire.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Questionnaire.purpose This element must be supported. 0..1 markdown Why this questionnaire is defined
Questionnaire.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Questionnaire.approvalDate This element must be supported. 0..1 date When the questionnaire was approved by publisher
Questionnaire.lastReviewDate This element must be supported. 0..1 date When the questionnaire was last reviewed
Questionnaire.effectivePeriod This element must be supported. 0..1 Period When the questionnaire is expected to be used

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error Questionnaire If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Questionnaire C 1..1 Questionnaire A structured set of questions
Constraints: que-0, que-2, pub-1
Questionnaire.id This element is included in summaries. 0..1 id Logical id of this artifact
Questionnaire.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Questionnaire.meta.id 0..1 string Unique id for inter-element referencing
Questionnaire.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Questionnaire.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Questionnaire.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Questionnaire.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
Questionnaire.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Questionnaire.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Questionnaire.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Questionnaire.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Questionnaire.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Questionnaire.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Questionnaire.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Questionnaire.contained 0..* Resource Contained, inline Resources
Questionnaire.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Questionnaire.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Questionnaire.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
Questionnaire.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Questionnaire.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Questionnaire.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Questionnaire.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Questionnaire.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Questionnaire.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Questionnaire.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Questionnaire.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
Questionnaire.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
Questionnaire.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
Questionnaire.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
Questionnaire.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Questionnaire.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Questionnaire.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Questionnaire.url This element is included in summaries. 0..1 uri Canonical identifier for this questionnaire, represented as a URI (globally unique)
Questionnaire.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the questionnaire
Questionnaire.version This element is included in summaries. 0..1 string Business version of the questionnaire
Questionnaire.name This element is included in summaries. C 0..1 string Name for this questionnaire (computer friendly)
Questionnaire.title This element is included in summaries. 0..1 string Name for this questionnaire (human friendly)
Questionnaire.derivedFrom 0..* canonical(Questionnaire) Instantiates protocol or definition
Questionnaire.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Questionnaire.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Questionnaire.subjectType This element is included in summaries. 0..* code Resource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
Questionnaire.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
Questionnaire.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
Questionnaire.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Questionnaire.description 0..1 markdown Natural language description of the questionnaire
Questionnaire.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Questionnaire.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Questionnaire.purpose This element must be supported. 0..1 markdown Why this questionnaire is defined
Questionnaire.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Questionnaire.approvalDate This element must be supported. 0..1 date When the questionnaire was approved by publisher
Questionnaire.lastReviewDate This element must be supported. 0..1 date When the questionnaire was last reviewed
Questionnaire.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the questionnaire is expected to be used
Questionnaire.code This element is included in summaries. 0..* Coding Concept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
Questionnaire.item C 0..* BackboneElement Questions and sections within the Questionnaire
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13
Questionnaire.item.id 0..1 string Unique id for inter-element referencing
Questionnaire.item.extension 0..* Extension Additional content defined by implementations
Questionnaire.item.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Questionnaire.item.linkId 1..1 string Unique id for item in questionnaire
Questionnaire.item.definition 0..1 uri ElementDefinition - details for the item
Questionnaire.item.code C 0..* Coding Corresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
Questionnaire.item.prefix 0..1 string E.g. "1(a)", "2.5.3"
Questionnaire.item.text 0..1 string Primary text for the item
Questionnaire.item.type 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.
Questionnaire.item.enableWhen This element is a modifier element. C 0..* BackboneElement Only allow data when
Constraints: que-7
Questionnaire.item.enableWhen.id 0..1 string Unique id for inter-element referencing
Questionnaire.item.enableWhen.extension 0..* Extension Additional content defined by implementations
Questionnaire.item.enableWhen.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Questionnaire.item.enableWhen.question 1..1 string Question that determines whether item is enabled
Questionnaire.item.enableWhen.operator 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.
Questionnaire.item.enableWhen.answer[x] C 1..1 Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
Questionnaire.item.enableWhen.answer[x].answerBoolean boolean
Questionnaire.item.enableWhen.answer[x].answerDecimal decimal
Questionnaire.item.enableWhen.answer[x].answerInteger integer
Questionnaire.item.enableWhen.answer[x].answerDate date
Questionnaire.item.enableWhen.answer[x].answerDateTime dateTime
Questionnaire.item.enableWhen.answer[x].answerTime time
Questionnaire.item.enableWhen.answer[x].answerString string
Questionnaire.item.enableWhen.answer[x].answerCoding Coding
Questionnaire.item.enableWhen.answer[x].answerQuantity Quantity
Questionnaire.item.enableWhen.answer[x].answerReference Reference(Resource)
Questionnaire.item.enableBehavior C 0..1 code all | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
Questionnaire.item.required C 0..1 boolean Whether the item must be included in data results
Questionnaire.item.repeats C 0..1 boolean Whether the item may repeat
Questionnaire.item.readOnly C 0..1 boolean Don't allow human editing
Questionnaire.item.maxLength C 0..1 integer No more than this many characters
Questionnaire.item.answerValueSet C 0..1 canonical(ValueSet) Valueset containing permitted answers
Questionnaire.item.answerOption C 0..* BackboneElement Permitted answer
Questionnaire.item.answerOption.id 0..1 string Unique id for inter-element referencing
Questionnaire.item.answerOption.extension 0..* Extension Additional content defined by implementations
Questionnaire.item.answerOption.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Questionnaire.item.answerOption.value[x] 1..1 Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
Questionnaire.item.answerOption.value[x].valueInteger integer
Questionnaire.item.answerOption.value[x].valueDate date
Questionnaire.item.answerOption.value[x].valueTime time
Questionnaire.item.answerOption.value[x].valueString string
Questionnaire.item.answerOption.value[x].valueCoding Coding
Questionnaire.item.answerOption.value[x].valueReference Reference(Resource)
Questionnaire.item.answerOption.initialSelected 0..1 boolean Whether option is selected by default
Questionnaire.item.initial C 0..* BackboneElement Initial value(s) when item is first rendered
Questionnaire.item.initial.id 0..1 string Unique id for inter-element referencing
Questionnaire.item.initial.extension 0..* Extension Additional content defined by implementations
Questionnaire.item.initial.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Questionnaire.item.initial.value[x] 1..1 Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
Questionnaire.item.initial.value[x].valueBoolean boolean
Questionnaire.item.initial.value[x].valueDecimal decimal
Questionnaire.item.initial.value[x].valueInteger integer
Questionnaire.item.initial.value[x].valueDate date
Questionnaire.item.initial.value[x].valueDateTime dateTime
Questionnaire.item.initial.value[x].valueTime time
Questionnaire.item.initial.value[x].valueString string
Questionnaire.item.initial.value[x].valueUri uri
Questionnaire.item.initial.value[x].valueAttachment Attachment
Questionnaire.item.initial.value[x].valueCoding Coding
Questionnaire.item.initial.value[x].valueQuantity Quantity
Questionnaire.item.initial.value[x].valueReference Reference(Resource)
Questionnaire.item.item C 0..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Questionnaire.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Questionnaire.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Questionnaire.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Questionnaire.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Questionnaire.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Questionnaire.subjectType Base required ResourceType 📍4.0.1 FHIR Std.
Questionnaire.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Questionnaire.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item.type Base required QuestionnaireItemType 📍4.0.1 FHIR Std.
Questionnaire.item.enableWhen.​operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.enableWhen.​answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.enableBehavior Base required EnableWhenBehavior 📍4.0.1 FHIR Std.
Questionnaire.item.answerOption.​value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.initial.​value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Questionnaire 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 Questionnaire 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 Questionnaire If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Questionnaire A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error Questionnaire If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
que-0 warning Questionnaire 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-1 error Questionnaire.item Group items must have nested items, display items cannot have nested items (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())
que-2 error Questionnaire The link ids for groups and questions must be unique within the questionnaire descendants().linkId.isDistinct()
que-3 error Questionnaire.item Display items cannot have a "code" asserted type!='display' or code.empty()
que-4 error Questionnaire.item A question cannot have both answerOption and answerValueSet answerOption.empty() or answerValueSet.empty()
que-5 error Questionnaire.item Only 'choice' and 'open-choice' items can have answerValueSet (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())
que-6 error Questionnaire.item Required and repeat aren't permitted for display items type!='display' or (required.empty() and repeats.empty())
que-7 error Questionnaire.item.enableWhen If the operator is 'exists', the value must be a boolean operator = 'exists' implies (answer is Boolean)
que-8 error Questionnaire.item Initial values can't be specified for groups or display items (type!='group' and type!='display') or initial.empty()
que-9 error Questionnaire.item Read-only can't be specified for "display" items type!='display' or readOnly.empty()
que-10 error Questionnaire.item Maximum length can only be declared for simple question types (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11 error Questionnaire.item If one or more answerOption is present, initial[x] must be missing answerOption.empty() or initial.empty()
que-12 error Questionnaire.item If there are more than one enableWhen, enableBehavior must be specified enableWhen.count() > 2 implies enableBehavior.exists()
que-13 error Questionnaire.item Can only have multiple initial values for repeating items repeats=true or initial.count() <= 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Questionnaire C 1..1 Questionnaire A structured set of questions
Constraints: que-0, que-2, pub-1
Questionnaire.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Questionnaire.meta.Slices for extension Content/Rules for all slices
Questionnaire.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Questionnaire.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Questionnaire.Slices for extension Content/Rules for all slices
Questionnaire.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Questionnaire.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
Questionnaire.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Questionnaire.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Questionnaire.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Questionnaire.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Questionnaire.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Questionnaire.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Questionnaire.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Questionnaire.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
Questionnaire.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
Questionnaire.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Questionnaire.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Questionnaire.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Questionnaire.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Questionnaire.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the questionnaire
Questionnaire.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Questionnaire.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
Questionnaire.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Questionnaire.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Questionnaire.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Questionnaire.purpose This element must be supported. 0..1 markdown Why this questionnaire is defined
Questionnaire.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Questionnaire.approvalDate This element must be supported. 0..1 date When the questionnaire was approved by publisher
Questionnaire.lastReviewDate This element must be supported. 0..1 date When the questionnaire was last reviewed
Questionnaire.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the questionnaire is expected to be used

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Questionnaire.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Questionnaire.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Questionnaire.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Questionnaire 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 Questionnaire 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 Questionnaire If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Questionnaire A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error Questionnaire If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
que-0 warning Questionnaire 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 Questionnaire The link ids for groups and questions must be unique within the questionnaire descendants().linkId.isDistinct()

Differential View

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Questionnaire C 1..1 Questionnaire A structured set of questions
Constraints: pub-1
Questionnaire.meta
Questionnaire.meta.Slices for extension Content/Rules for all slices
Questionnaire.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Questionnaire.Slices for extension Content/Rules for all slices
Questionnaire.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Questionnaire.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
Questionnaire.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Questionnaire.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Questionnaire.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Questionnaire.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Questionnaire.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Questionnaire.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Questionnaire.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Questionnaire.Slices for extension.extension:relatedArtifact.value[x]
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Questionnaire.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Questionnaire.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Questionnaire.identifier This element must be supported. 0..* Identifier Additional identifier for the questionnaire
Questionnaire.date This element must be supported. 1..1 dateTime Date last changed
Questionnaire.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
Questionnaire.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
Questionnaire.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Questionnaire.purpose This element must be supported. 0..1 markdown Why this questionnaire is defined
Questionnaire.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Questionnaire.approvalDate This element must be supported. 0..1 date When the questionnaire was approved by publisher
Questionnaire.lastReviewDate This element must be supported. 0..1 date When the questionnaire was last reviewed
Questionnaire.effectivePeriod This element must be supported. 0..1 Period When the questionnaire is expected to be used

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error Questionnaire If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Questionnaire C 1..1 Questionnaire A structured set of questions
Constraints: que-0, que-2, pub-1
Questionnaire.id This element is included in summaries. 0..1 id Logical id of this artifact
Questionnaire.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Questionnaire.meta.id 0..1 string Unique id for inter-element referencing
Questionnaire.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Questionnaire.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Questionnaire.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Questionnaire.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
Questionnaire.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Questionnaire.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Questionnaire.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Questionnaire.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Questionnaire.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Questionnaire.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Questionnaire.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Questionnaire.contained 0..* Resource Contained, inline Resources
Questionnaire.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Questionnaire.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Questionnaire.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
Questionnaire.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Questionnaire.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Questionnaire.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Questionnaire.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Questionnaire.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Questionnaire.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Questionnaire.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Questionnaire.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
Questionnaire.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
Questionnaire.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
Questionnaire.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
Questionnaire.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
Questionnaire.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Questionnaire.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Questionnaire.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Questionnaire.url This element is included in summaries. 0..1 uri Canonical identifier for this questionnaire, represented as a URI (globally unique)
Questionnaire.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the questionnaire
Questionnaire.version This element is included in summaries. 0..1 string Business version of the questionnaire
Questionnaire.name This element is included in summaries. C 0..1 string Name for this questionnaire (computer friendly)
Questionnaire.title This element is included in summaries. 0..1 string Name for this questionnaire (human friendly)
Questionnaire.derivedFrom 0..* canonical(Questionnaire) Instantiates protocol or definition
Questionnaire.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Questionnaire.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Questionnaire.subjectType This element is included in summaries. 0..* code Resource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
Questionnaire.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
Questionnaire.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
Questionnaire.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Questionnaire.description 0..1 markdown Natural language description of the questionnaire
Questionnaire.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Questionnaire.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Questionnaire.purpose This element must be supported. 0..1 markdown Why this questionnaire is defined
Questionnaire.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
Questionnaire.approvalDate This element must be supported. 0..1 date When the questionnaire was approved by publisher
Questionnaire.lastReviewDate This element must be supported. 0..1 date When the questionnaire was last reviewed
Questionnaire.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the questionnaire is expected to be used
Questionnaire.code This element is included in summaries. 0..* Coding Concept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
Questionnaire.item C 0..* BackboneElement Questions and sections within the Questionnaire
Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13
Questionnaire.item.id 0..1 string Unique id for inter-element referencing
Questionnaire.item.extension 0..* Extension Additional content defined by implementations
Questionnaire.item.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Questionnaire.item.linkId 1..1 string Unique id for item in questionnaire
Questionnaire.item.definition 0..1 uri ElementDefinition - details for the item
Questionnaire.item.code C 0..* Coding Corresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.
Questionnaire.item.prefix 0..1 string E.g. "1(a)", "2.5.3"
Questionnaire.item.text 0..1 string Primary text for the item
Questionnaire.item.type 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.
Questionnaire.item.enableWhen This element is a modifier element. C 0..* BackboneElement Only allow data when
Constraints: que-7
Questionnaire.item.enableWhen.id 0..1 string Unique id for inter-element referencing
Questionnaire.item.enableWhen.extension 0..* Extension Additional content defined by implementations
Questionnaire.item.enableWhen.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Questionnaire.item.enableWhen.question 1..1 string Question that determines whether item is enabled
Questionnaire.item.enableWhen.operator 1..1 code exists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.
Questionnaire.item.enableWhen.answer[x] C 1..1 Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
Questionnaire.item.enableWhen.answer[x].answerBoolean boolean
Questionnaire.item.enableWhen.answer[x].answerDecimal decimal
Questionnaire.item.enableWhen.answer[x].answerInteger integer
Questionnaire.item.enableWhen.answer[x].answerDate date
Questionnaire.item.enableWhen.answer[x].answerDateTime dateTime
Questionnaire.item.enableWhen.answer[x].answerTime time
Questionnaire.item.enableWhen.answer[x].answerString string
Questionnaire.item.enableWhen.answer[x].answerCoding Coding
Questionnaire.item.enableWhen.answer[x].answerQuantity Quantity
Questionnaire.item.enableWhen.answer[x].answerReference Reference(Resource)
Questionnaire.item.enableBehavior C 0..1 code all | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
Questionnaire.item.required C 0..1 boolean Whether the item must be included in data results
Questionnaire.item.repeats C 0..1 boolean Whether the item may repeat
Questionnaire.item.readOnly C 0..1 boolean Don't allow human editing
Questionnaire.item.maxLength C 0..1 integer No more than this many characters
Questionnaire.item.answerValueSet C 0..1 canonical(ValueSet) Valueset containing permitted answers
Questionnaire.item.answerOption C 0..* BackboneElement Permitted answer
Questionnaire.item.answerOption.id 0..1 string Unique id for inter-element referencing
Questionnaire.item.answerOption.extension 0..* Extension Additional content defined by implementations
Questionnaire.item.answerOption.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Questionnaire.item.answerOption.value[x] 1..1 Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
Questionnaire.item.answerOption.value[x].valueInteger integer
Questionnaire.item.answerOption.value[x].valueDate date
Questionnaire.item.answerOption.value[x].valueTime time
Questionnaire.item.answerOption.value[x].valueString string
Questionnaire.item.answerOption.value[x].valueCoding Coding
Questionnaire.item.answerOption.value[x].valueReference Reference(Resource)
Questionnaire.item.answerOption.initialSelected 0..1 boolean Whether option is selected by default
Questionnaire.item.initial C 0..* BackboneElement Initial value(s) when item is first rendered
Questionnaire.item.initial.id 0..1 string Unique id for inter-element referencing
Questionnaire.item.initial.extension 0..* Extension Additional content defined by implementations
Questionnaire.item.initial.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Questionnaire.item.initial.value[x] 1..1 Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.
Questionnaire.item.initial.value[x].valueBoolean boolean
Questionnaire.item.initial.value[x].valueDecimal decimal
Questionnaire.item.initial.value[x].valueInteger integer
Questionnaire.item.initial.value[x].valueDate date
Questionnaire.item.initial.value[x].valueDateTime dateTime
Questionnaire.item.initial.value[x].valueTime time
Questionnaire.item.initial.value[x].valueString string
Questionnaire.item.initial.value[x].valueUri uri
Questionnaire.item.initial.value[x].valueAttachment Attachment
Questionnaire.item.initial.value[x].valueCoding Coding
Questionnaire.item.initial.value[x].valueQuantity Quantity
Questionnaire.item.initial.value[x].valueReference Reference(Resource)
Questionnaire.item.item C 0..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Questionnaire.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Questionnaire.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Questionnaire.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Questionnaire.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
Questionnaire.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Questionnaire.subjectType Base required ResourceType 📍4.0.1 FHIR Std.
Questionnaire.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Questionnaire.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item.code Base example Questionnaire Question Codes 📍4.0.1 FHIR Std.
Questionnaire.item.type Base required QuestionnaireItemType 📍4.0.1 FHIR Std.
Questionnaire.item.enableWhen.​operator Base required QuestionnaireItemOperator 📍4.0.1 FHIR Std.
Questionnaire.item.enableWhen.​answer[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.enableBehavior Base required EnableWhenBehavior 📍4.0.1 FHIR Std.
Questionnaire.item.answerOption.​value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.
Questionnaire.item.initial.​value[x] Base example Questionnaire Answer Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Questionnaire 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 Questionnaire 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 Questionnaire If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Questionnaire A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error Questionnaire If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
que-0 warning Questionnaire 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-1 error Questionnaire.item Group items must have nested items, display items cannot have nested items (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())
que-2 error Questionnaire The link ids for groups and questions must be unique within the questionnaire descendants().linkId.isDistinct()
que-3 error Questionnaire.item Display items cannot have a "code" asserted type!='display' or code.empty()
que-4 error Questionnaire.item A question cannot have both answerOption and answerValueSet answerOption.empty() or answerValueSet.empty()
que-5 error Questionnaire.item Only 'choice' and 'open-choice' items can have answerValueSet (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())
que-6 error Questionnaire.item Required and repeat aren't permitted for display items type!='display' or (required.empty() and repeats.empty())
que-7 error Questionnaire.item.enableWhen If the operator is 'exists', the value must be a boolean operator = 'exists' implies (answer is Boolean)
que-8 error Questionnaire.item Initial values can't be specified for groups or display items (type!='group' and type!='display') or initial.empty()
que-9 error Questionnaire.item Read-only can't be specified for "display" items type!='display' or readOnly.empty()
que-10 error Questionnaire.item Maximum length can only be declared for simple question types (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11 error Questionnaire.item If one or more answerOption is present, initial[x] must be missing answerOption.empty() or initial.empty()
que-12 error Questionnaire.item If there are more than one enableWhen, enableBehavior must be specified enableWhen.count() > 2 implies enableBehavior.exists()
que-13 error Questionnaire.item Can only have multiple initial values for repeating items repeats=true or initial.count() <= 1

 

Other representations of profile: CSV, Excel, Schematron