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 Thu May 16 12:32:10 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
Summary
Mandatory: 3 elements (2 nested mandatory elements)
Extensions
This structure refers to these extensions:
This structure is derived from Questionnaire
This structure is derived from Questionnaire
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | 0..* | A structured set of questions intended to guide the collection of answers from end-users. | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-questionnaire-recommendation | 0..1 | CodeableConcept | Recommendation URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-recommendation Binding: QuestionnaireRecommendation (required) | |
ehealth-questionnaire-intendedOrganization | 0..* | Reference(eHealth Organization) {r} | 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..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision | |
ehealth-modifier-role | 1..* | (Complex) | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role | |
ehealth-questionnaire-type | 1..* | CodeableConcept | Concept that represents the overall questionnaire URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-type Binding: QuestionnaireTypes (required) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Logical URI to reference this questionnaire (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire |
version | Σ | 1..1 | string | Business version of the questionnaire |
name | Σ | 0..1 | string | Name for this questionnaire (computer friendly) |
title | Σ | 0..1 | string | Name for this questionnaire (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date this was last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
description | 0..1 | markdown | Natural language description of the questionnaire | |
purpose | 0..1 | markdown | Why this questionnaire is defined | |
approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |
lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used |
useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: Questionnaire Question Codes (example) |
subjectType | Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required) |
item | I | 0..* | BackboneElement | Questions and sections within the Questionnaire que-9: Read-only can't be specified for "display" items que-8: Default values can't be specified for groups or display items que-6: Required and repeat aren't permitted for display items que-5: Only 'choice' items can have options que-4: A question cannot have both option and options que-3: Display items cannot have a "code" asserted que-10: Maximum length can only be declared for simple question types que-1: Group items must have nested items, display items cannot have nested items |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
questionnaire-minOccurs | I | 0..* | integer | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs" | |
valueInteger | 1..1 | integer | Value of extension | |
ehealth-questionnaire-feedback | 0..1 | (Complex) | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-feedback | |
questionnaire-maxOccurs | I | 0..* | integer | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" | |
valueInteger | 1..1 | integer | Value of extension | |
minValue | I | 0..* | date, dateTime, time, instant, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue |
maxValue | I | 0..* | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue |
ehealth-questionnaire-sliderStepValue | 0..1 | integer | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-sliderStepValue | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
linkId | 1..1 | string | Unique id for item in questionnaire | |
definition | 0..1 | uri | ElementDefinition - details for the item | |
code | ΣI | 0..* | Coding | Corresponding concept for this item in a terminology Binding: Questionnaire Question Codes (example) |
prefix | 0..1 | string | E.g. "1(a)", "2.5.3" | |
text | Σ | 0..1 | string | Primary text for the item |
type | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required) | |
enableWhen | ?!ΣI | 0..* | BackboneElement | Only allow data when que-7: enableWhen must contain either a 'answer' or a 'hasAnswer' element |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
question | 1..1 | string | Question that determines whether item is enabled | |
hasAnswer | I | 0..1 | boolean | Enable when answered or not |
answer[x] | I | 0..1 | boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Value question must have Binding: Questionnaire Answer Codes (example) |
required | I | 0..1 | boolean | Whether the item must be included in data results |
repeats | I | 0..1 | boolean | Whether the item may repeat |
readOnly | I | 0..1 | boolean | Don't allow human editing |
maxLength | I | 0..1 | integer | No more than this many characters |
options | I | 0..1 | Reference(ValueSet) | Valueset containing permitted answers |
option | I | 0..* | BackboneElement | Permitted answer |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
value[x] | 1..1 | integer, date, time, string, Coding | Answer value Binding: Questionnaire Answer Codes (example) | |
initial[x] | I | 0..1 | boolean, 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 | I | 0..* | Unknown reference to #Questionnaire.item Nested questionnaire items | |
Documentation for this format |
This structure is derived from Questionnaire
Summary
Mandatory: 3 elements (2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Questionnaire
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | 0..* | A structured set of questions intended to guide the collection of answers from end-users. | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-questionnaire-recommendation | 0..1 | CodeableConcept | Recommendation URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-recommendation Binding: QuestionnaireRecommendation (required) | |
ehealth-questionnaire-intendedOrganization | 0..* | Reference(eHealth Organization) {r} | 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..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision | |
ehealth-modifier-role | 1..* | (Complex) | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role | |
ehealth-questionnaire-type | 1..* | CodeableConcept | Concept that represents the overall questionnaire URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-type Binding: QuestionnaireTypes (required) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Logical URI to reference this questionnaire (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire |
version | Σ | 1..1 | string | Business version of the questionnaire |
name | Σ | 0..1 | string | Name for this questionnaire (computer friendly) |
title | Σ | 0..1 | string | Name for this questionnaire (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date this was last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
description | 0..1 | markdown | Natural language description of the questionnaire | |
purpose | 0..1 | markdown | Why this questionnaire is defined | |
approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |
lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used |
useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: Questionnaire Question Codes (example) |
subjectType | Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required) |
item | I | 0..* | BackboneElement | Questions and sections within the Questionnaire que-9: Read-only can't be specified for "display" items que-8: Default values can't be specified for groups or display items que-6: Required and repeat aren't permitted for display items que-5: Only 'choice' items can have options que-4: A question cannot have both option and options que-3: Display items cannot have a "code" asserted que-10: Maximum length can only be declared for simple question types que-1: Group items must have nested items, display items cannot have nested items |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
questionnaire-minOccurs | I | 0..* | integer | Minimum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs" | |
valueInteger | 1..1 | integer | Value of extension | |
ehealth-questionnaire-feedback | 0..1 | (Complex) | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-feedback | |
questionnaire-maxOccurs | I | 0..* | integer | Maximum repetitions URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" | |
valueInteger | 1..1 | integer | Value of extension | |
minValue | I | 0..* | date, dateTime, time, instant, decimal, integer | Must be >= this value URL: http://hl7.org/fhir/StructureDefinition/minValue |
maxValue | I | 0..* | date, dateTime, time, instant, decimal, integer | Must be <= this value URL: http://hl7.org/fhir/StructureDefinition/maxValue |
ehealth-questionnaire-sliderStepValue | 0..1 | integer | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-questionnaire-sliderStepValue | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
linkId | 1..1 | string | Unique id for item in questionnaire | |
definition | 0..1 | uri | ElementDefinition - details for the item | |
code | ΣI | 0..* | Coding | Corresponding concept for this item in a terminology Binding: Questionnaire Question Codes (example) |
prefix | 0..1 | string | E.g. "1(a)", "2.5.3" | |
text | Σ | 0..1 | string | Primary text for the item |
type | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required) | |
enableWhen | ?!ΣI | 0..* | BackboneElement | Only allow data when que-7: enableWhen must contain either a 'answer' or a 'hasAnswer' element |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
question | 1..1 | string | Question that determines whether item is enabled | |
hasAnswer | I | 0..1 | boolean | Enable when answered or not |
answer[x] | I | 0..1 | boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Value question must have Binding: Questionnaire Answer Codes (example) |
required | I | 0..1 | boolean | Whether the item must be included in data results |
repeats | I | 0..1 | boolean | Whether the item may repeat |
readOnly | I | 0..1 | boolean | Don't allow human editing |
maxLength | I | 0..1 | integer | No more than this many characters |
options | I | 0..1 | Reference(ValueSet) | Valueset containing permitted answers |
option | I | 0..* | BackboneElement | Permitted answer |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
value[x] | 1..1 | integer, date, time, string, Coding | Answer value Binding: Questionnaire Answer Codes (example) | |
initial[x] | I | 0..1 | boolean, 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 | I | 0..* | Unknown reference to #Questionnaire.item Nested questionnaire items | |
Documentation for this format |
Path | Name | Conformance | ValueSet |
Questionnaire.language | Common Languages | extensible | Common Languages |
Questionnaire.status | PublicationStatus | required | PublicationStatus |
Questionnaire.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
Questionnaire.code | Questionnaire Question Codes | example | Questionnaire Question Codes |
Questionnaire.subjectType | ResourceType | required | ResourceType |
Questionnaire.item.code | Questionnaire Question Codes | example | Questionnaire Question Codes |
Questionnaire.item.type | QuestionnaireItemType | required | QuestionnaireItemType |
Questionnaire.item.enableWhen.answer[x] | Questionnaire Answer Codes | example | Questionnaire Answer Codes |
Questionnaire.item.option.value[x] | Questionnaire Answer Codes | example | Questionnaire Answer Codes |
Questionnaire.item.initial[x] | Questionnaire Answer Codes | example | Questionnaire Answer Codes |
Id | Path | Details | Requirements |
dom-2 | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-3 | Questionnaire | If 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-2 | Questionnaire | The link ids for groups and questions must be unique within the questionnaire : descendants().linkId.isDistinct() | |
ele-1 | Questionnaire.item | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
que-9 | Questionnaire.item | Read-only can't be specified for "display" items : type!='display' or readOnly.empty() | |
que-8 | Questionnaire.item | Default values can't be specified for groups or display items : (type!='group' and type!='display') or initial.empty() | |
que-6 | Questionnaire.item | Required and repeat aren't permitted for display items : type!='display' or (required.empty() and repeats.empty()) | |
que-5 | Questionnaire.item | Only 'choice' items can have options : (type ='choice' or type = 'open-choice') or (options.empty() and option.empty()) | |
que-4 | Questionnaire.item | A question cannot have both option and options : option.empty() or options.empty() | |
que-3 | Questionnaire.item | Display items cannot have a "code" asserted : type!='display' or code.empty() | |
que-10 | Questionnaire.item | Maximum length can only be declared for simple question types : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty() | |
que-1 | Questionnaire.item | Group items must have nested items, display items cannot have nested items : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()) | |
ele-1 | Questionnaire.item.enableWhen | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
que-7 | Questionnaire.item.enableWhen | enableWhen must contain either a 'answer' or a 'hasAnswer' element : hasAnswer.exists() xor answer.exists() | |
ele-1 | Questionnaire.item.option | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |