Finnish Base Profiles
0.2.0 - ci-build Finland flag

Finnish Base Profiles - Local Development build (v0.2.0). See the Directory of published versions

Resource Profile: fiphr-sd-questionnaire

Official URL: http://phr.kanta.fi/StructureDefinition/fiphr-sd-questionnaire-r4 Version: 0.2.0
Draft as of 2021-02-22 Computable Name: FIPHRSDQuestionnaire

Finnish PHR StructureDefinition for Questionnaire Resource

Usage:

  • Refer to this Resource Profile:

Formal Views of Profile Content

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

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..*QuestionnaireFinnish PHR Questionnaire profile
... meta 1..1MetaMetadata about the resource
.... Slices for profile 1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by type:$this
..... profile:fiphrProfile 1..1canonical(StructureDefinition)Profiles this resource claims to conform to
Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-questionnaire-r4
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (required)
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... url 1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier 1..*IdentifierAdditional identifier for the questionnaire
.... use 0..1codeusual | official | temp | secondary | old (If known)
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
... version 1..1stringBusiness version of the questionnaire
... name 1..1stringName for this questionnaire (computer friendly)
... title 1..1stringName for this questionnaire (human friendly)
... subjectType 0..1codeResource that can be subject of QuestionnaireResponse
Fixed Value: Patient
... date 1..1dateTimeDate last changed
... description 1..1markdownNatural language description of the questionnaire
... useContext 0..0
... jurisdiction 0..0
... Slices for code 1..*CodingConcept that represents the overall questionnaire
Slice: Unordered, Open by value:code, value:system
Binding: https://simplifier.net/finnishphr/fiphr-vs-questionnairecode (extensible)
.... code:fiphrCode 1..1CodingConcept that represents the overall questionnaire
..... system 1..1uriIdentity of the terminology system
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-questionnairecode
..... code 1..1codeFinnish PHR: Code for questionnaire
... item 1..*BackboneElementQuestions and sections within the Questionnaire

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Questionnaire.languagerequiredCommonLanguages
Questionnaire.codeextensiblehttps://simplifier.net/finnishphr/fiphr-vs-questionnairecode
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C0..*QuestionnaireFinnish PHR Questionnaire profile
... meta Σ1..1MetaMetadata about the resource
.... Slices for profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by type:$this
..... profile:fiphrProfile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to

Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-questionnaire-r4
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (required)
... myExtension 0..*(Complex)Application identification
URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier Σ1..*IdentifierAdditional identifier for the questionnaire
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... version Σ1..1stringBusiness version of the questionnaire
... name ΣC1..1stringName for this questionnaire (computer friendly)
... title Σ1..1stringName for this questionnaire (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... subjectType Σ0..1codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.



Fixed Value: Patient
... date Σ1..1dateTimeDate last changed
... description 1..1markdownNatural language description of the questionnaire
... Slices for code Σ1..*CodingConcept that represents the overall questionnaire
Slice: Unordered, Open by value:code, value:system
Binding: https://simplifier.net/finnishphr/fiphr-vs-questionnairecode (extensible)
.... code:fiphrCode Σ1..1CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-questionnairecode
..... code Σ1..1codeFinnish PHR: Code for questionnaire
... item C1..*BackboneElementQuestions and sections within the Questionnaire
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId 1..1stringUnique id for item in questionnaire
.... type 1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!C0..*BackboneElementOnly allow data when
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] C1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... answerValueSet C0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption C0..*BackboneElementPermitted answer
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
.... initial C0..*BackboneElementInitial value(s) when item is first rendered
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Questionnaire.languagerequiredCommonLanguages
Questionnaire.identifier.userequiredIdentifierUse
Questionnaire.statusrequiredPublicationStatus
Questionnaire.subjectTyperequiredFixed Value: Patient
Questionnaire.codeextensiblehttps://simplifier.net/finnishphr/fiphr-vs-questionnairecode
Questionnaire.code:fiphrCodeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorQuestionnaireIf 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-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
que-1errorQuestionnaire.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())
que-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly '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-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C0..*QuestionnaireFinnish PHR Questionnaire profile
... id Σ0..1idLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... Slices for profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by type:$this
..... profile:fiphrProfile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to

Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-questionnaire-r4
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (required)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... myExtension 0..*(Complex)Application identification
URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier Σ1..*IdentifierAdditional identifier for the questionnaire
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... version Σ1..1stringBusiness version of the questionnaire
... name ΣC1..1stringName for this questionnaire (computer friendly)
... title Σ1..1stringName for this questionnaire (human friendly)
... derivedFrom 0..*canonical(Questionnaire)Instantiates protocol or definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subjectType Σ0..1codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.



Fixed Value: Patient
... date Σ1..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the questionnaire
... purpose 0..1markdownWhy this questionnaire is defined
... copyright 0..1markdownUse and/or publishing restrictions
... 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
... Slices for code Σ1..*CodingConcept that represents the overall questionnaire
Slice: Unordered, Open by value:code, value:system
Binding: https://simplifier.net/finnishphr/fiphr-vs-questionnairecode (extensible)
.... code:fiphrCode Σ1..1CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-questionnairecode
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeFinnish PHR: Code for questionnaire
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... item C1..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId 1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code C0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


.... 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): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!C0..*BackboneElementOnly allow data when
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] C1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... enableBehavior C0..1codeall | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.

.... required C0..1booleanWhether the item must be included in data results
.... repeats C0..1booleanWhether the item may repeat
.... readOnly C0..1booleanDon't allow human editing
.... maxLength C0..1integerNo more than this many characters
.... answerValueSet C0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption C0..*BackboneElementPermitted answer
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
..... initialSelected 0..1booleanWhether option is selected by default
.... initial C0..*BackboneElementInitial value(s) when item is first rendered
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)
.... item C0..*See item (Questionnaire)Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Questionnaire.meta.securityextensibleAll Security Labels
Questionnaire.meta.tagexampleCommonTags
Questionnaire.languagerequiredCommonLanguages
Questionnaire.identifier.userequiredIdentifierUse
Questionnaire.identifier.typeextensibleIdentifier Type Codes
Questionnaire.statusrequiredPublicationStatus
Questionnaire.subjectTyperequiredFixed Value: Patient
Questionnaire.codeextensiblehttps://simplifier.net/finnishphr/fiphr-vs-questionnairecode
Questionnaire.code:fiphrCodeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.enableBehaviorrequiredEnableWhenBehavior
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-1errorQuestionnaire.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())
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly '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-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1

This structure is derived from Questionnaire

Summary

Mandatory: 17 elements
Fixed Value: 3 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Questionnaire.meta.profile is sliced based on the value of type:$this
  • The element Questionnaire.code is sliced based on the values of value:code, value:system

Differential View

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..*QuestionnaireFinnish PHR Questionnaire profile
... meta 1..1MetaMetadata about the resource
.... Slices for profile 1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by type:$this
..... profile:fiphrProfile 1..1canonical(StructureDefinition)Profiles this resource claims to conform to
Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-questionnaire-r4
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (required)
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... url 1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier 1..*IdentifierAdditional identifier for the questionnaire
.... use 0..1codeusual | official | temp | secondary | old (If known)
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
... version 1..1stringBusiness version of the questionnaire
... name 1..1stringName for this questionnaire (computer friendly)
... title 1..1stringName for this questionnaire (human friendly)
... subjectType 0..1codeResource that can be subject of QuestionnaireResponse
Fixed Value: Patient
... date 1..1dateTimeDate last changed
... description 1..1markdownNatural language description of the questionnaire
... useContext 0..0
... jurisdiction 0..0
... Slices for code 1..*CodingConcept that represents the overall questionnaire
Slice: Unordered, Open by value:code, value:system
Binding: https://simplifier.net/finnishphr/fiphr-vs-questionnairecode (extensible)
.... code:fiphrCode 1..1CodingConcept that represents the overall questionnaire
..... system 1..1uriIdentity of the terminology system
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-questionnairecode
..... code 1..1codeFinnish PHR: Code for questionnaire
... item 1..*BackboneElementQuestions and sections within the Questionnaire

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Questionnaire.languagerequiredCommonLanguages
Questionnaire.codeextensiblehttps://simplifier.net/finnishphr/fiphr-vs-questionnairecode

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C0..*QuestionnaireFinnish PHR Questionnaire profile
... meta Σ1..1MetaMetadata about the resource
.... Slices for profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by type:$this
..... profile:fiphrProfile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to

Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-questionnaire-r4
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (required)
... myExtension 0..*(Complex)Application identification
URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier Σ1..*IdentifierAdditional identifier for the questionnaire
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... version Σ1..1stringBusiness version of the questionnaire
... name ΣC1..1stringName for this questionnaire (computer friendly)
... title Σ1..1stringName for this questionnaire (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... subjectType Σ0..1codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.



Fixed Value: Patient
... date Σ1..1dateTimeDate last changed
... description 1..1markdownNatural language description of the questionnaire
... Slices for code Σ1..*CodingConcept that represents the overall questionnaire
Slice: Unordered, Open by value:code, value:system
Binding: https://simplifier.net/finnishphr/fiphr-vs-questionnairecode (extensible)
.... code:fiphrCode Σ1..1CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-questionnairecode
..... code Σ1..1codeFinnish PHR: Code for questionnaire
... item C1..*BackboneElementQuestions and sections within the Questionnaire
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId 1..1stringUnique id for item in questionnaire
.... type 1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!C0..*BackboneElementOnly allow data when
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] C1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... answerValueSet C0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption C0..*BackboneElementPermitted answer
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
.... initial C0..*BackboneElementInitial value(s) when item is first rendered
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Questionnaire.languagerequiredCommonLanguages
Questionnaire.identifier.userequiredIdentifierUse
Questionnaire.statusrequiredPublicationStatus
Questionnaire.subjectTyperequiredFixed Value: Patient
Questionnaire.codeextensiblehttps://simplifier.net/finnishphr/fiphr-vs-questionnairecode
Questionnaire.code:fiphrCodeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorQuestionnaireIf 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-5errorQuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-0warningQuestionnaireName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
que-1errorQuestionnaire.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())
que-2errorQuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly '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-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire C0..*QuestionnaireFinnish PHR Questionnaire profile
... id Σ0..1idLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... Slices for profile Σ1..*canonical(StructureDefinition)Profiles this resource claims to conform to
Slice: Unordered, Open by type:$this
..... profile:fiphrProfile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to

Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-questionnaire-r4
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (required)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... myExtension 0..*(Complex)Application identification
URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier Σ1..*IdentifierAdditional identifier for the questionnaire
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... version Σ1..1stringBusiness version of the questionnaire
... name ΣC1..1stringName for this questionnaire (computer friendly)
... title Σ1..1stringName for this questionnaire (human friendly)
... derivedFrom 0..*canonical(Questionnaire)Instantiates protocol or definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subjectType Σ0..1codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.



Fixed Value: Patient
... date Σ1..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 1..1markdownNatural language description of the questionnaire
... purpose 0..1markdownWhy this questionnaire is defined
... copyright 0..1markdownUse and/or publishing restrictions
... 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
... Slices for code Σ1..*CodingConcept that represents the overall questionnaire
Slice: Unordered, Open by value:code, value:system
Binding: https://simplifier.net/finnishphr/fiphr-vs-questionnairecode (extensible)
.... code:fiphrCode Σ1..1CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-questionnairecode
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeFinnish PHR: Code for questionnaire
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... item C1..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId 1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code C0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions.


.... 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): Distinguishes groups from questions and display text and indicates data type for questions.

.... enableWhen ?!C0..*BackboneElementOnly allow data when
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... question 1..1stringQuestion that determines whether item is enabled
..... operator 1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled.

..... answer[x] C1..1Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... answerBooleanboolean
...... answerDecimaldecimal
...... answerIntegerinteger
...... answerDatedate
...... answerDateTimedateTime
...... answerTimetime
...... answerStringstring
...... answerCodingCoding
...... answerQuantityQuantity
...... answerReferenceReference(Resource)
.... enableBehavior C0..1codeall | any
Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.

.... required C0..1booleanWhether the item must be included in data results
.... repeats C0..1booleanWhether the item may repeat
.... readOnly C0..1booleanDon't allow human editing
.... maxLength C0..1integerNo more than this many characters
.... answerValueSet C0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption C0..*BackboneElementPermitted answer
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Answer value
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueIntegerinteger
...... valueDatedate
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
...... valueReferenceReference(Resource)
..... initialSelected 0..1booleanWhether option is selected by default
.... initial C0..*BackboneElementInitial value(s) when item is first rendered
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] 1..1Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions.

...... valueBooleanboolean
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueUriuri
...... valueAttachmentAttachment
...... valueCodingCoding
...... valueQuantityQuantity
...... valueReferenceReference(Resource)
.... item C0..*See item (Questionnaire)Nested questionnaire items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Questionnaire.meta.securityextensibleAll Security Labels
Questionnaire.meta.tagexampleCommonTags
Questionnaire.languagerequiredCommonLanguages
Questionnaire.identifier.userequiredIdentifierUse
Questionnaire.identifier.typeextensibleIdentifier Type Codes
Questionnaire.statusrequiredPublicationStatus
Questionnaire.subjectTyperequiredFixed Value: Patient
Questionnaire.codeextensiblehttps://simplifier.net/finnishphr/fiphr-vs-questionnairecode
Questionnaire.code:fiphrCodeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.codeexampleQuestionnaireQuestionCodes (a valid code from LOINC)
Questionnaire.item.typerequiredQuestionnaireItemType
Questionnaire.item.enableWhen.operatorrequiredQuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.enableBehaviorrequiredEnableWhenBehavior
Questionnaire.item.answerOption.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)
Questionnaire.item.initial.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
que-1errorQuestionnaire.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())
que-3errorQuestionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-4errorQuestionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.empty()
que-5errorQuestionnaire.itemOnly '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-6errorQuestionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-7errorQuestionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
que-8errorQuestionnaire.itemInitial values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-9errorQuestionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-10errorQuestionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url' | 'open-choice')) or maxLength.empty()
que-11errorQuestionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12errorQuestionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
que-13errorQuestionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1

This structure is derived from Questionnaire

Summary

Mandatory: 17 elements
Fixed Value: 3 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Questionnaire.meta.profile is sliced based on the value of type:$this
  • The element Questionnaire.code is sliced based on the values of value:code, value:system

 

Other representations of profile: CSV, Excel, Schematron