eHealth Infrastructure (v1.0.0)

StructureDefinition: ehealth-questionnaire

Formal Views of Profile Content

The official URL for this profile is:

http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire

This profile builds on Questionnaire.

This profile was published on Wed Mar 06 14:43:56 UTC 2019 as a draft by ehealth.sundhed.dk.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..*A structured set of questions intended to guide the collection of answers from end-users.
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... ehealth-questionnaire-recommendation 0..1CodingRecommendation
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-recommendation
Binding: QuestionnaireRecommendation (required)
... ehealth-questionnaire-custodian 1..1Reference(eHealth Organization)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-custodian
... ehealth-questionnaire-author 1..1Reference(eHealth Organization)Optional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-author
... ehealth-questionnaire-intendedOrganization 0..*Reference(eHealth Organization)Optional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-intendedOrganization
... ehealth-questionnaire-reuseCriteria 0..*(Complex)Optional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-reuseCriteria
... ehealth-revision 0..1stringOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision
... version 1..1string
... code 1..*CodingThe type of the Questionnaire
Binding: QuestionnaireTypes (required)
... item 0..*BackboneElementQuestions and sections within the Questionnaire
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... questionnaire-minOccurs 0..*integerMinimum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
..... valueInteger 1..1integer
.... ehealth-questionnaire-feedback 0..1(Complex)Optional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-feedback
.... questionnaire-maxOccurs 0..*integerMaximum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
..... valueInteger 1..1integer
.... minValue 0..*date, dateTime, time, instant, decimal, integerMust be >= this value
URL: http://hl7.org/fhir/StructureDefinition/minValue
.... maxValue 0..*date, dateTime, time, instant, decimal, integerMust be <= this value
URL: http://hl7.org/fhir/StructureDefinition/maxValue
.... ehealth-questionnaire-sliderStepValue 0..1integerOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-sliderStepValue

doco Documentation for this format

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire I0..*A structured set of questions intended to guide the collection of answers from end-users.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-questionnaire-recommendation 0..1CodingRecommendation
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-recommendation
Binding: QuestionnaireRecommendation (required)
... ehealth-questionnaire-custodian 1..1Reference(eHealth Organization)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-custodian
... ehealth-questionnaire-author 1..1Reference(eHealth Organization)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-author
... ehealth-questionnaire-intendedOrganization 0..*Reference(eHealth Organization)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-intendedOrganization
... ehealth-questionnaire-reuseCriteria 0..*(Complex)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-reuseCriteria
... ehealth-revision 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical URI to reference this questionnaire (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the questionnaire
... version Σ1..1stringBusiness version of the questionnaire
... name Σ0..1stringName for this questionnaire (computer friendly)
... title Σ0..1stringName for this questionnaire (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... description 0..1markdownNatural language description of the questionnaire
... purpose 0..1markdownWhy this questionnaire is defined
... approvalDate 0..1dateWhen the questionnaire was approved by publisher
... lastReviewDate 0..1dateWhen the questionnaire was last reviewed
... effectivePeriod Σ0..1PeriodWhen the questionnaire is expected to be used
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... code Σ1..*CodingThe type of the Questionnaire
Binding: QuestionnaireTypes (required)
... subjectType Σ0..*codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required)
... item I0..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... questionnaire-minOccurs I0..*integerMinimum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs"
..... valueInteger 1..1integerValue of extension
.... ehealth-questionnaire-feedback 0..1(Complex)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-feedback
.... questionnaire-maxOccurs I0..*integerMaximum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs"
..... valueInteger 1..1integerValue of extension
.... minValue I0..*date, dateTime, time, instant, decimal, integerMust be >= this value
URL: http://hl7.org/fhir/StructureDefinition/minValue
.... maxValue I0..*date, dateTime, time, instant, decimal, integerMust be <= this value
URL: http://hl7.org/fhir/StructureDefinition/maxValue
.... ehealth-questionnaire-sliderStepValue 0..1integerExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-sliderStepValue
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... linkId 1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code ΣI0..*CodingCorresponding concept for this item in a terminology
Binding: Questionnaire Question Codes (example)
.... prefix 0..1stringE.g. "1(a)", "2.5.3"
.... text Σ0..1stringPrimary text for the item
.... type 1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required)
.... enableWhen ?!ΣI0..*BackboneElementOnly allow data when
que-7: enableWhen must contain either a 'answer' or a 'hasAnswer' element
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... question 1..1stringQuestion that determines whether item is enabled
..... hasAnswer I0..1booleanEnable when answered or not
..... answer[x] I0..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Value question must have
Binding: Questionnaire Answer Codes (example)
.... required I0..1booleanWhether the item must be included in data results
.... repeats I0..1booleanWhether the item may repeat
.... readOnly I0..1booleanDon't allow human editing
.... maxLength I0..1integerNo more than this many characters
.... options I0..1Reference(ValueSet)Valueset containing permitted answers
.... option I0..*BackboneElementPermitted answer
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... value[x] 1..1integer, date, time, string, CodingAnswer value
Binding: Questionnaire Answer Codes (example)
.... initial[x] I0..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Default value when item is first rendered
Binding: Questionnaire Answer Codes (example)
.... item I0..*Unknown reference to #Questionnaire.item
Nested questionnaire items

doco Documentation for this format

Differential View

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..*A structured set of questions intended to guide the collection of answers from end-users.
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... ehealth-questionnaire-recommendation 0..1CodingRecommendation
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-recommendation
Binding: QuestionnaireRecommendation (required)
... ehealth-questionnaire-custodian 1..1Reference(eHealth Organization)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-custodian
... ehealth-questionnaire-author 1..1Reference(eHealth Organization)Optional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-author
... ehealth-questionnaire-intendedOrganization 0..*Reference(eHealth Organization)Optional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-intendedOrganization
... ehealth-questionnaire-reuseCriteria 0..*(Complex)Optional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-reuseCriteria
... ehealth-revision 0..1stringOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision
... version 1..1string
... code 1..*CodingThe type of the Questionnaire
Binding: QuestionnaireTypes (required)
... item 0..*BackboneElementQuestions and sections within the Questionnaire
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... questionnaire-minOccurs 0..*integerMinimum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
..... valueInteger 1..1integer
.... ehealth-questionnaire-feedback 0..1(Complex)Optional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-feedback
.... questionnaire-maxOccurs 0..*integerMaximum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
..... valueInteger 1..1integer
.... minValue 0..*date, dateTime, time, instant, decimal, integerMust be >= this value
URL: http://hl7.org/fhir/StructureDefinition/minValue
.... maxValue 0..*date, dateTime, time, instant, decimal, integerMust be <= this value
URL: http://hl7.org/fhir/StructureDefinition/maxValue
.... ehealth-questionnaire-sliderStepValue 0..1integerOptional Extensions Element
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-sliderStepValue

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire I0..*A structured set of questions intended to guide the collection of answers from end-users.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-questionnaire-recommendation 0..1CodingRecommendation
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-recommendation
Binding: QuestionnaireRecommendation (required)
... ehealth-questionnaire-custodian 1..1Reference(eHealth Organization)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-custodian
... ehealth-questionnaire-author 1..1Reference(eHealth Organization)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-author
... ehealth-questionnaire-intendedOrganization 0..*Reference(eHealth Organization)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-intendedOrganization
... ehealth-questionnaire-reuseCriteria 0..*(Complex)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-reuseCriteria
... ehealth-revision 0..1stringExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical URI to reference this questionnaire (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the questionnaire
... version Σ1..1stringBusiness version of the questionnaire
... name Σ0..1stringName for this questionnaire (computer friendly)
... title Σ0..1stringName for this questionnaire (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... description 0..1markdownNatural language description of the questionnaire
... purpose 0..1markdownWhy this questionnaire is defined
... approvalDate 0..1dateWhen the questionnaire was approved by publisher
... lastReviewDate 0..1dateWhen the questionnaire was last reviewed
... effectivePeriod Σ0..1PeriodWhen the questionnaire is expected to be used
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... code Σ1..*CodingThe type of the Questionnaire
Binding: QuestionnaireTypes (required)
... subjectType Σ0..*codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required)
... item I0..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... questionnaire-minOccurs I0..*integerMinimum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs"
..... valueInteger 1..1integerValue of extension
.... ehealth-questionnaire-feedback 0..1(Complex)Extension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-feedback
.... questionnaire-maxOccurs I0..*integerMaximum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs"
..... valueInteger 1..1integerValue of extension
.... minValue I0..*date, dateTime, time, instant, decimal, integerMust be >= this value
URL: http://hl7.org/fhir/StructureDefinition/minValue
.... maxValue I0..*date, dateTime, time, instant, decimal, integerMust be <= this value
URL: http://hl7.org/fhir/StructureDefinition/maxValue
.... ehealth-questionnaire-sliderStepValue 0..1integerExtension
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-sliderStepValue
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... linkId 1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code ΣI0..*CodingCorresponding concept for this item in a terminology
Binding: Questionnaire Question Codes (example)
.... prefix 0..1stringE.g. "1(a)", "2.5.3"
.... text Σ0..1stringPrimary text for the item
.... type 1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required)
.... enableWhen ?!ΣI0..*BackboneElementOnly allow data when
que-7: enableWhen must contain either a 'answer' or a 'hasAnswer' element
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... question 1..1stringQuestion that determines whether item is enabled
..... hasAnswer I0..1booleanEnable when answered or not
..... answer[x] I0..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Value question must have
Binding: Questionnaire Answer Codes (example)
.... required I0..1booleanWhether the item must be included in data results
.... repeats I0..1booleanWhether the item may repeat
.... readOnly I0..1booleanDon't allow human editing
.... maxLength I0..1integerNo more than this many characters
.... options I0..1Reference(ValueSet)Valueset containing permitted answers
.... option I0..*BackboneElementPermitted answer
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... value[x] 1..1integer, date, time, string, CodingAnswer value
Binding: Questionnaire Answer Codes (example)
.... initial[x] I0..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Default value when item is first rendered
Binding: Questionnaire Answer Codes (example)
.... item I0..*Unknown reference to #Questionnaire.item
Nested questionnaire items

doco Documentation for this format

 

Terminology Bindings

PathNameConformanceValueSet
Questionnaire.languageCommon LanguagesextensibleCommon Languages
Questionnaire.statusPublicationStatusrequiredPublicationStatus
Questionnaire.jurisdictionJurisdiction ValueSetextensibleJurisdiction ValueSet
Questionnaire.codeQuestionnaireTypesrequiredQuestionnaireTypes
Questionnaire.subjectTypeResourceTyperequiredResourceType
Questionnaire.item.codeQuestionnaire Question CodesexampleQuestionnaire Question Codes
Questionnaire.item.typeQuestionnaireItemTyperequiredQuestionnaireItemType
Questionnaire.item.enableWhen.answer[x]Questionnaire Answer CodesexampleQuestionnaire Answer Codes
Questionnaire.item.option.value[x]Questionnaire Answer CodesexampleQuestionnaire Answer Codes
Questionnaire.item.initial[x]Questionnaire Answer CodesexampleQuestionnaire Answer Codes

Constraints

IdPathDetailsRequirements
dom-2QuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1QuestionnaireIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4QuestionnaireIf 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-3QuestionnaireIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
que-2QuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
ele-1Questionnaire.itemAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
que-9Questionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-8Questionnaire.itemDefault values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-6Questionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-5Questionnaire.itemOnly 'choice' items can have options
: (type ='choice' or type = 'open-choice') or (options.empty() and option.empty())
que-4Questionnaire.itemA question cannot have both option and options
: option.empty() or options.empty()
que-3Questionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-10Questionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty()
que-1Questionnaire.itemGroup 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())
ele-1Questionnaire.item.enableWhenAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
que-7Questionnaire.item.enableWhenenableWhen must contain either a 'answer' or a 'hasAnswer' element
: hasAnswer.exists() xor answer.exists()
ele-1Questionnaire.item.optionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
.