Questionnaire
| Canonical URL | http://ihis.sg/StructureDefinition/GetQuestionnaireOutputProfile |
|---|---|
| Status | Active |
This resource represents the questionnaires in the health plan.
Key Design Considerations
As this resource is used for both onboarding and healthplan questionnaires, code will be used to indicate the questionnaire type.
Resource Structure
profile-Questionnaire-get-questionnaire-output-profile (Questionnaire) C Questionnaire There are no (further) constraints on this elementElement idQuestionnaire
Short descriptionA structured set of questions
Alternate namesForm, CRF, Survey
DefinitionA structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
Data typeConstraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-4: 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-3: 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - que-2: The link ids for groups and questions must be unique within the questionnaire
descendants().linkId.isDistinct() - que-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
Mappings- rim: Entity. Role, or Act
- workflow: Definition
- rim: Observation[moodCode=DEF]
- w5: infrastructure.information
id Σ 0..0 id There are no (further) constraints on this elementElement idQuestionnaire.id
Short descriptionLogical id of this artifact
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
meta Σ 0..0 Meta There are no (further) constraints on this elementElement idQuestionnaire.meta
Short descriptionMetadata about the resource
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A
implicitRules Σ ?! 0..0 uri There are no (further) constraints on this elementElement idQuestionnaire.implicitRules
Short descriptionA set of rules under which this content was created
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
CommentsAsserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
language 0..0 codeBinding There are no (further) constraints on this elementElement idQuestionnaire.language
Short descriptionLanguage of the resource content
DefinitionThe base language in which the resource is written.
CommentsLanguage is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Data typeBindingIETF language tag
Binding extensionsmaxValueSet AllLanguages
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
text 0..0 Narrative There are no (further) constraints on this elementElement idQuestionnaire.text
Short descriptionText summary of the resource, for human interpretation
Alternate namesnarrative, html, xhtml, display
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
CommentsContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A
- rim: Act.text?
contained C 0..0 Resource There are no (further) constraints on this elementElement idQuestionnaire.contained
Short descriptionContained, inline Resources
Alternate namesinline resources, anonymous resources, contained resources
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
CommentsThis should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Data typeConstraints- dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
Mappings- rim: Entity. Role, or Act
- rim: N/A
extension C 0..0 Extension There are no (further) constraints on this elementElement idQuestionnaire.extension
Short descriptionAdditional content defined by implementations
Alternate namesextensions, user content
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeSlicingUnordered, Open, by url(Value)
Extensions are always sliced by (at least) url
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
modifierExtension ?! C 0..0 Extension There are no (further) constraints on this elementElement idQuestionnaire.modifierExtension
Short descriptionExtensions that cannot be ignored
Alternate namesextensions, user content
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeSlicingUnordered, Open, by url(Value)
Extensions are always sliced by (at least) url
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
url Σ 1..1 uri Element idQuestionnaire.url
Short descriptionn/a
DefinitionCanonical identifier for this questionnaire, represented as a URI. Fixed value for each questionnaire template
Requirementsn/a
CommentsRefer to PlanDefinition resource, onboarding questionnaire (action #2) and health questionnaire (action #3) url.
Possible Value:
"/Questionnaire/hsg-oq-001"
"/Questionnaire/hsg-hq-001"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- workflow: Definition.url
- w5: FiveWs.identifier
- rim: .identifier[scope=BUSN;reliability=ISS]
identifier Σ 0..0 Identifier There are no (further) constraints on this elementElement idQuestionnaire.identifier
Short descriptionAdditional identifier for the questionnaire
DefinitionA formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.
RequirementsAllows externally provided and/or usable business identifiers to be easily associated with the module.
CommentsTypically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- workflow: Definition.identifier
- w5: FiveWs.identifier
- rim: .identifier
- objimpl: no-gen-base
version Σ C 1..1 string Element idQuestionnaire.version
Short descriptionn/a
DefinitionBusiness version of the questionnaire
CommentsSample Value:
1.0, 1.1 2.0, 11.0
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - VersionStringLength: string length not greater than 255
$this.length<256
Mappings- rim: n/a
- workflow: Definition.version
- w5: FiveWs.version
- rim: N/A (to add?)
name Σ 0..0 string There are no (further) constraints on this elementElement idQuestionnaire.name
Short descriptionName for this questionnaire (computer friendly)
DefinitionA natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.
RequirementsSupport human navigation and code generation.
CommentsThe name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A
title Σ C 0..1 string Element idQuestionnaire.title
Short descriptionn/a
DefinitionName of this questionnaire (human friendly)
CommentsSample Value: "HealthierSG Onboarding Questionnaire"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - TitleStringLength: string length not greater than 255
$this.length<256
Mappings- rim: n/a
- workflow: Definition.title
- rim: .title
derivedFrom 0..0 canonical(Questionnaire) There are no (further) constraints on this elementElement idQuestionnaire.derivedFrom
Short descriptionInstantiates protocol or definition
DefinitionThe URL of a Questionnaire that this Questionnaire is based on.
RequirementsAllows a Questionnaire to be created based on another Questionnaire.
CommentsData typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- workflow: Definition.derivedFrom
- rim: .outboundRelationship[typeCode=DRIV].target[classCode=OBS, moodCode=DEFN]
status Σ ?! 1..1 codeBindingFixed Value Element idQuestionnaire.status
Short descriptionn/a
DefinitionFHIR value set "PublicationStatus", fixed to "active"
CommentsFixed Value: "active"
Data typeBindingThe lifecycle status of an artifact.
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Fixed valueactive
Mappings- rim: n/a
- workflow: Definition.status
- w5: FiveWs.status
- rim: .status
experimental Σ 0..0 boolean There are no (further) constraints on this elementElement idQuestionnaire.experimental
Short descriptionFor testing purposes, not real usage
DefinitionA Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
RequirementsEnables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.
CommentsAllows filtering of questionnaires that are appropriate for use versus not.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- workflow: Definition.experimental
- w5: FiveWs.class
- rim: N/A
subjectType Σ 0..0 codeBinding There are no (further) constraints on this elementElement idQuestionnaire.subjectType
Short descriptionResource that can be subject of QuestionnaireResponse
DefinitionThe types of subjects that can be the subject of responses created for the questionnaire.
CommentsIf none are specified, then the subject is unlimited.
Data typeBindingOne of the resource types defined as part of this version of FHIR.
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- workflow: Definition.subject[x]
- rim: .outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode
date Σ 1..1 dateTime Element idQuestionnaire.date
Short descriptionn/a
Alternate namesRevision Date
Definitiondate last changed
To check when the latest version is changed
CommentsSample Value: "2022-06-01T10:30:01+08:00", "2023-05-03T18:18:38.358+08:00"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- workflow: Definition.date
- w5: FiveWs.recorded
- rim: .participation[typeCode=AUT].time
publisher Σ 0..0 string There are no (further) constraints on this elementElement idQuestionnaire.publisher
Short descriptionName of the publisher (organization or individual)
DefinitionThe name of the organization or individual that published the questionnaire.
RequirementsHelps establish the "authority/credibility" of the questionnaire. May also allow for contact.
CommentsUsually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the questionnaire. This item SHOULD be populated unless the information is available from context.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- workflow: Definition.publisher
- w5: FiveWs.witness
- rim: .participation[typeCode=AUT].role
contact Σ 0..0 ContactDetail There are no (further) constraints on this elementElement idQuestionnaire.contact
Short descriptionContact details for the publisher
DefinitionContact details to assist a user in finding and communicating with the publisher.
CommentsMay be a web site, an email address, a telephone number, etc.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- workflow: Definition.contact
- rim: .participation[typeCode=CALLBCK].role
description 1..1 markdown Element idQuestionnaire.description
Short descriptionn/a
DefinitionNatural language description of the questionnaire
CommentsSample Value:
onboarding questionnaire
"Complete a simple questionnaire to facilitate your first onboarding health consultation and receive recommendations that may be relevant to your health needs."
health questionniare
"Complete the questionnaire to find out your level of dependence on smoking and allow your family doctor to recommend suitable smoking cessation methods.
*You may attempt the questionnaire multiple times to check your dependence score."
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- workflow: Definition.description
- rim: .text
useContext Σ 0..0 UsageContext There are no (further) constraints on this elementElement idQuestionnaire.useContext
Short descriptionThe context that the content is intended to support
DefinitionThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.
RequirementsAssist in searching for appropriate content.
CommentsWhen multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- workflow: Definition.useContext
- rim: N/A (to add?)
jurisdiction Σ 0..0 CodeableConceptBinding There are no (further) constraints on this elementElement idQuestionnaire.jurisdiction
Short descriptionIntended jurisdiction for questionnaire (if applicable)
DefinitionA legal or geographic region in which the questionnaire is intended to be used.
CommentsIt may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.
Data typeBindingCountries and regions within which this artifact is targeted for use.
Jurisdiction ValueSet (extensible)
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow: Definition.jurisdiction
- rim: N/A (to add?)
purpose 0..0 markdown There are no (further) constraints on this elementElement idQuestionnaire.purpose
Short descriptionWhy this questionnaire is defined
DefinitionExplanation of why this questionnaire is needed and why it has been designed as it has.
CommentsThis element does not describe the usage of the questionnaire. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this questionnaire.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- workflow: Definition.purpose
- w5: FiveWs.why[x]
- rim: .reasonCode.text
- objimpl: no-gen-base
copyright 0..0 markdown There are no (further) constraints on this elementElement idQuestionnaire.copyright
Short descriptionUse and/or publishing restrictions
Alternate namesLicense, Restrictions
DefinitionA copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.
RequirementsConsumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content.
CommentsSystems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- workflow: Definition.copyright
- rim: N/A (to add?)
- objimpl: no-gen-base
approvalDate 0..0 date There are no (further) constraints on this elementElement idQuestionnaire.approvalDate
Short descriptionWhen the questionnaire was approved by publisher
DefinitionThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
CommentsThe 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- workflow: Definition.approvalDate
- rim: .outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime
- objimpl: no-gen-base
lastReviewDate 0..0 date There are no (further) constraints on this elementElement idQuestionnaire.lastReviewDate
Short descriptionWhen the questionnaire was last reviewed
DefinitionThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
RequirementsGives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
CommentsIf specified, this date follows the original approval date.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- workflow: Definition.lastReviewDate
- rim: .outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime
- objimpl: no-gen-base
effectivePeriod Σ C 0..0 Period There are no (further) constraints on this elementElement idQuestionnaire.effectivePeriod
Short descriptionWhen the questionnaire is expected to be used
DefinitionThe period during which the questionnaire content was or is planned to be in active use.
RequirementsAllows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the questionnaire are or are expected to be used instead.
CommentsThe effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- workflow: Definition.effectivePeriod
- rim: N/A (to add?)
- objimpl: no-gen-base
code Σ 1..1 Coding Element idQuestionnaire.code
Short descriptionn/a
DefinitionDifferent type of questinaire use in the Healthier SG Patient journey
Requirementsn/a
Commentsn/a
Data typeBindingCodes for questionnaires, groups and individual questions.
QuestionnaireQuestionCodes (example)
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
- rim: .code
id 0..0 id There are no (further) constraints on this elementElement idQuestionnaire.code.id
Short descriptionUnique id for inter-element referencing
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typeMappings- rim: n/a
extension C 0..0 Extension There are no (further) constraints on this elementElement idQuestionnaire.code.extension
Short descriptionAdditional content defined by implementations
Alternate namesextensions, user content
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeSlicingUnordered, Open, by url(Value)
Extensions are always sliced by (at least) url
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
system Σ 1..1 uriFixed Value Element idQuestionnaire.code.system
Short descriptionn/a
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Requirementsn/a
CommentsFixed Value : "http://ihis.sg/ValueSet/hsg-questionnaire-type"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Fixed valuehttp://ihis.sg/ValueSet/hsg-questionnaire-type
Mappings- rim: n/a
- v2: C*E.3
- rim: ./codeSystem
- orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version Σ 0..0 string There are no (further) constraints on this elementElement idQuestionnaire.code.version
Short descriptionVersion of the system - if relevant
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
CommentsWhere the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code Σ 1..1 code Element idQuestionnaire.code.code
Short descriptionn/a
DefinitionSymbol in syntax defined by the system. It shall be one of the code defined in value set.
"http://ihis.sg/ValueSet/hsg-questionnaire-type"
Requirementsn/a
CommentsSample Value : "onboarding-questionnaire"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: C*E.1
- rim: ./code
- orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display Σ 0..1 string Element idQuestionnaire.code.display
Short descriptionn/a
DefinitionRepresentation defined by the system.
Display value of the coding.
Requirementsn/a
CommentsSample Value : "Onboarding-Questionnaire"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: C*E.2 - but note this is not well followed
- rim: CV.displayName
- orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected Σ 0..0 boolean There are no (further) constraints on this elementElement idQuestionnaire.code.userSelected
Short descriptionIf this coding was chosen directly by the user
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
RequirementsThis has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
CommentsAmongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: Sometimes implied by being first
- rim: CD.codingRationale
- orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
item C 0..* BackboneElement Element idQuestionnaire.item
Short descriptionn/a
DefinitionGrouping of item
Commentsn/a
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-3
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - que-9: Read-only can't be specified for "display" items
type!='display' or readOnly.empty() - que-8: Initial values can't be specified for groups or display items
(type!='group' and type!='display') or initial.empty() - que-6: Required and repeat aren't permitted for display items
type!='display' or (required.empty() and repeats.empty()) - que-5: 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-4: A question cannot have both answerOption and answerValueSet
answerOption.empty() or answerValueSet.empty() - que-3: Display items cannot have a "code" asserted
type!='display' or code.empty() - que-1c: Display items cannot have child items
type='display' implies item.empty() - que-1a: Group items must have nested items when Questionanire is complete
(type='group' and %resource.status='complete') implies item.empty().not() - que-1b: Groups should have items
type='group' implies item.empty().not() - que-10: Maximum length can only be declared for simple question types
(type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty() - que-13: Can only have multiple initial values for repeating items
repeats=true or initial.count() <= 1 - que-11: If one or more answerOption is present, initial[x] must be missing
answerOption.empty() or initial.empty() - que-12: If there are more than one enableWhen, enableBehavior must be specified
enableWhen.count() > 1 implies enableBehavior.exists()
Mappings- rim: n/a
- rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]
id 0..0 id There are no (further) constraints on this elementElement idQuestionnaire.item.id
Short descriptionUnique id for inter-element referencing
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typeMappings- rim: n/a
extension C 0..0 Extension There are no (further) constraints on this elementElement idQuestionnaire.item.extension
Short descriptionAdditional content defined by implementations
Alternate namesextensions, user content
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeSlicingUnordered, Open, by url(Value)
Extensions are always sliced by (at least) url
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! C 0..0 Extension There are no (further) constraints on this elementElement idQuestionnaire.item.modifierExtension
Short descriptionExtensions that cannot be ignored even if unrecognized
Alternate namesextensions, user content, modifiers
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
linkId C 1..1 string Element idQuestionnaire.item.linkId
Short descriptionn/a
DefinitionAn identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.
Requirementsn/a
Commentsn/a
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - LinkidStringLength: string length not greater than 255
$this.length<256
Mappings- rim: n/a
- rim: .id
definition 0..0 uri There are no (further) constraints on this elementElement idQuestionnaire.item.definition
Short descriptionElementDefinition - details for the item
DefinitionThis element is a URI that refers to an ElementDefinition that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. If this element is present then the following element values MAY be derived from the Element Definition if the corresponding elements of this Questionnaire resource instance have no value:
- code (ElementDefinition.code)
- type (ElementDefinition.type)
- required (ElementDefinition.min)
- repeats (ElementDefinition.max)
- maxLength (ElementDefinition.maxLength)
- answerValueSet (ElementDefinition.binding)
- options (ElementDefinition.binding).
RequirementsA common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition.
CommentsThe uri refers to an ElementDefinition in a StructureDefinition and always starts with the canonical URL for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id Element.id. E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: .outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]
code C 0..1 Coding Element idQuestionnaire.item.code
Short descriptionn/a
Definitioncode that represents each question
Requirementsn/a
Commentsn/a
Data typeBindingCodes for questionnaires, groups and individual questions.
QuestionnaireQuestionCodes (example)
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-3
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
- rim: .code
id 0..0 id There are no (further) constraints on this elementElement idQuestionnaire.item.code.id
Short descriptionUnique id for inter-element referencing
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typeMappings- rim: n/a
extension C 0..0 Extension There are no (further) constraints on this elementElement idQuestionnaire.item.code.extension
Short descriptionAdditional content defined by implementations
Alternate namesextensions, user content
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeSlicingUnordered, Open, by url(Value)
Extensions are always sliced by (at least) url
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
system Σ 1..1 uriFixed Value Element idQuestionnaire.item.code.system
Short descriptionn/a
DefinitionIdentity of the terminology system
Requirementsn/a
CommentsSample Value: "http://ihis.sg/ValueSet/hsg-oq-identifier-code"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Fixed valuehttp://ihis.sg/ValueSet/hsg-oq-identifier-code
Mappings- rim: n/a
- v2: C*E.3
- rim: ./codeSystem
- orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version Σ 0..0 string There are no (further) constraints on this elementElement idQuestionnaire.item.code.version
Short descriptionVersion of the system - if relevant
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
CommentsWhere the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code Σ 1..1 code Element idQuestionnaire.item.code.code
Short descriptionn/a
Definitioninternal code for the terminology code
Requirementsn/a
CommentsSample Value: "oq001", "oq002"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: C*E.1
- rim: ./code
- orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display Σ 0..1 string Element idQuestionnaire.item.code.display
Short descriptionn/a
DefinitionThe display value of the code
Requirementsn/a
Commentsn/a
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: C*E.2 - but note this is not well followed
- rim: CV.displayName
- orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected Σ 0..0 boolean There are no (further) constraints on this elementElement idQuestionnaire.item.code.userSelected
Short descriptionIf this coding was chosen directly by the user
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
RequirementsThis has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
CommentsAmongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: Sometimes implied by being first
- rim: CD.codingRationale
- orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
prefix C 0..1 string Element idQuestionnaire.item.prefix
Short descriptionn/a
Alternate nameslabel
DefinitionA short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire
Requirementsn/a
CommentsSample Value: "1", "2", "3"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - PrefixStringLength: string length not greater than 255
$this.length<256
Mappings- rim: n/a
- rim: Not supported
text C 0..1 string Element idQuestionnaire.item.text
Short descriptionn/a
DefinitionName of the group or question text
CommentsSample Value: "Please enter your latest height(cm)___"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - TextStringLength: string length not greater than 255
$this.length<256
Mappings- rim: n/a
- rim: .text
type 1..1 codeBinding Element idQuestionnaire.item.type
Short descriptionn/a
DefinitionQuestionnaireItemType. Possible value: group, display, boolean, decimal, integer, date, datetime
Requirementsn/a
CommentsSample Value: "decimal", "choice"
Data typeBindingDistinguishes groups from questions and display text and indicates data type for questions.
QuestionnaireItemType (required)
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
enableWhen ?! C 0..* BackboneElement Element idQuestionnaire.item.enableWhen
Short descriptionn/a
DefinitionOnly allow data when
The criteria to enable this item
Requirementsn/a
Commentsn/a
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - que-7: If the operator is 'exists', the value must be a boolean
operator = 'exists' implies (answer is boolean)
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
id 0..0 id There are no (further) constraints on this elementElement idQuestionnaire.item.enableWhen.id
Short descriptionUnique id for inter-element referencing
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typeMappings- rim: n/a
extension C 0..0 Extension There are no (further) constraints on this elementElement idQuestionnaire.item.enableWhen.extension
Short descriptionAdditional content defined by implementations
Alternate namesextensions, user content
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeSlicingUnordered, Open, by url(Value)
Extensions are always sliced by (at least) url
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
modifierExtension Σ ?! C 0..0 Extension There are no (further) constraints on this elementElement idQuestionnaire.item.enableWhen.modifierExtension
Short descriptionExtensions that cannot be ignored even if unrecognized
Alternate namesextensions, user content, modifiers
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
question 1..1 string Element idQuestionnaire.item.enableWhen.question
Short descriptionn/a
Definitionthe linkId for the question whose answer (or lack of answer) governs whether this item is enabled.
CommentsSample Value: "medical-history.1"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
operator 1..1 codeBinding Element idQuestionnaire.item.enableWhen.operator
Short descriptionn/a
DefinitionSpecify the criteria by which the question is enable.
code, possible value exist, =, !=, > , <, >=, <=
CommentsSample Value: "="
Data typeBindingThe criteria by which a question is enabled.
QuestionnaireItemOperator (required)
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
answer[x] C 1..1 Element idQuestionnaire.item.enableWhen.answer[x]
Short descriptionn/a
DefinitionAnswer value for the referenced question
SlicingUnordered, Open, by $this(Type)
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-7
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
answerBoolean C 0..1 boolean Element idQuestionnaire.item.enableWhen.answer[x]:answerBoolean
Short descriptionn/a
DefinitionPopulate this if the answer type is boolean
CommentsSample Value: true
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-7
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
id 0..1 id There are no (further) constraints on this elementElement idQuestionnaire.item.enableWhen.answer[x]:answerBoolean.id
Short descriptionUnique id for inter-element referencing
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typeMappings- rim: n/a
extension C 0..0 Extension There are no (further) constraints on this elementElement idQuestionnaire.item.enableWhen.answer[x]:answerBoolean.extension
Short descriptionAdditional content defined by implementations
Alternate namesextensions, user content
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeSlicingUnordered, Open, by url(Value)
Extensions are always sliced by (at least) url
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
value 0..1 System.Boolean There are no (further) constraints on this elementElement idQuestionnaire.item.enableWhen.answer[x]:answerBoolean.value
Short descriptionPrimitive value for boolean
DefinitionPrimitive value for boolean
Data typeSystem.Boolean
answerCoding C 0..1 Coding Element idQuestionnaire.item.enableWhen.answer[x]:answerCoding
Short descriptionn/a
DefinitionPopulate this if the answer type is coding
Data typeBindingAllowed values to answer questions.
QuestionnaireAnswerCodes (example)
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-7
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
id 0..0 id There are no (further) constraints on this elementElement idQuestionnaire.item.enableWhen.answer[x]:answerCoding.id
Short descriptionUnique id for inter-element referencing
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typeMappings- rim: n/a
extension C 0..0 Extension There are no (further) constraints on this elementElement idQuestionnaire.item.enableWhen.answer[x]:answerCoding.extension
Short descriptionAdditional content defined by implementations
Alternate namesextensions, user content
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data typeSlicingUnordered, Open, by url(Value)
Extensions are always sliced by (at least) url
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
system Σ 1..1 uri Element idQuestionnaire.item.enableWhen.answer[x]:answerCoding.system
Short descriptionn/a
DefinitionIdentity of the terminology system
Requirementsn/a
CommentsSample Value: "http://ihis.sg/ValueSet/hsg-yes-no"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: C*E.3
- rim: ./codeSystem
- orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version Σ 0..0 string There are no (further) constraints on this elementElement idQuestionnaire.item.enableWhen.answer[x]:answerCoding.version
Short descriptionVersion of the system - if relevant
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
CommentsWhere the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code Σ 1..1 code Element idQuestionnaire.item.enableWhen.answer[x]:answerCoding.code
Short descriptionn/a
Definitioninternal code for the terminology code
Requirementsn/a
CommentsSample Value: "yes"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: C*E.1
- rim: ./code
- orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display Σ 0..0 string There are no (further) constraints on this elementElement idQuestionnaire.item.enableWhen.answer[x]:answerCoding.display
Short descriptionRepresentation defined by the system
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
RequirementsNeed to be able to carry a human-readable meaning of the code for readers that do not know the system.
CommentsNote that FHIR strings SHALL NOT exceed 1MB in size
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: C*E.2 - but note this is not well followed
- rim: CV.displayName
- orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected Σ 0..0 boolean There are no (further) constraints on this elementElement idQuestionnaire.item.enableWhen.answer[x]:answerCoding.userSelected
Short descriptionIf this coding was chosen directly by the user
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
RequirementsThis has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
CommentsAmongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: Sometimes implied by being first
- rim: CD.codingRationale
- orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
enableBehavior C 0..0 codeBinding There are no (further) constraints on this elementElement idQuestionnaire.item.enableBehavior
Short descriptionall | any
DefinitionControls how multiple enableWhen values are interpreted - whether all or any must be true.
CommentsThis element must be specified if more than one enableWhen value is provided.
Data typeBindingControls how multiple enableWhen values are interpreted - whether all or any must be true.
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-12
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
required C 0..1 boolean Element idQuestionnaire.item.required
Short descriptionn/a
DefinitionIs required.
To indicate if this item is mandatory to answer when answering the questionnaire
CommentsSample Value: "true"
Meaning when missingn/a
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-6
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
repeats C 0..0 boolean There are no (further) constraints on this elementElement idQuestionnaire.item.repeats
Short descriptionWhether the item may repeat
DefinitionAn indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.
RequirementsItems may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.
CommentsIf a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. "repeat the question") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.
The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values.
The value may come from the ElementDefinition referred to by .definition.
Meaning when missingItems are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-6
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
readOnly C 0..0 boolean There are no (further) constraints on this elementElement idQuestionnaire.item.readOnly
Short descriptionDon't allow human editing
DefinitionAn indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.
RequirementsAllows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc.
CommentsThe value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-9
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
maxLength C 0..0 integer There are no (further) constraints on this elementElement idQuestionnaire.item.maxLength
Short descriptionNo more than this many characters
DefinitionThe maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.
CommentsFor base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-10
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- v2: N/A
- rim: N/A - MIF rather than RIM level
answerValueSet C 0..1 canonical(ValueSet) Element idQuestionnaire.item.answerValueSet
Short descriptionn/a
DefinitionPossible answer value for each of the question
CommentsReference for question with permitted answer from valueset
Sample Value: "http://ihis.sg/ValueSet/hsg-oq-identifier-code"
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-4, que-5
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
answerOption C 0..0 BackboneElement There are no (further) constraints on this elementElement idQuestionnaire.item.answerOption
Short descriptionPermitted answer
DefinitionOne of the permitted answers for a "choice" or "open-choice" question.
CommentsThis element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-4, que-5
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
initial C 0..0 BackboneElement There are no (further) constraints on this elementElement idQuestionnaire.item.initial
Short descriptionInitial value(s) when item is first rendered
DefinitionOne or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.
RequirementsIn some workflows, having defaults saves time.
CommentsThe user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial[x] must agree with the item.type, and only repeating items can have more then one initial value.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, que-8, que-13
Constraints- ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Mappings- rim: n/a
- rim: N/A - MIF rather than RIM level
item C 0..0 see (item) There are no (further) constraints on this elementElement idQuestionnaire.item.item
Short descriptionNested questionnaire items
DefinitionText, questions and other groups to be nested beneath a question or group.
RequirementsReports can consist of complex nested groups.
CommentsThere is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting.
ConditionsThe cardinality or value of this element may be affected by these constraints: que-1a, que-1b, que-1c
Mappings- rim: .outboundRelationship[typeCode=COMP].target
Terminology Bindings
Constraints
| Path | Id | Grade | Details | Expression |
|---|---|---|---|---|
| Questionnaire.version, Questionnaire.title, Questionnaire.item.linkId, Questionnaire.item.prefix, Questionnaire.item.text | VersionStringLength, TitleStringLength, LinkidStringLength, PrefixStringLength, TextStringLength | error, error, error, error, error | string length not greater than 255, string length not greater than 255, string length not greater than 255, string length not greater than 255, string length not greater than 255 | $this.length<256, $this.length<256, $this.length<256, $this.length<256, $this.length<256 |