eHealth Infrastructure (v2020.7)

StructureDefinition: ehealth-definedquestion

Introduction

The ehealth-definedquestion profile of StructureDefinition represents the concept of a DefinedQuestion. A DefinedQuestion is a standalone representation of a question and possibly its answer options that can be used in one or more Questionnaire resources. Although a Questionnaire can be constructed without being based on any DefinedQuestion, it is expected that a catalogue of DefinedQuestion will emerge over time and the particular DefinedQuestion will be reused in multiple Questionnaire.

The DefinedQuestion concept is based on ideas described in https://www.hl7.org/fhir/stu3/questionnaire.html#2.38.5.4. Whether a DefinedQuestion is referenced in a Questionnaire or not, it is the Questionnaire’s own definition which takes precedence.

Scope and Usage

In the eHealth Infrastructure, a reference to a DefinedQuestion by url in a Questionnaire question is used to enable robust extraction in automated processing rule(s) of answer(s) to that question from corresponding QuestionnaireResponse. An answer in a QuestionnaireResponse is already unambiguously related to a question in a Questionnaire through the question’s linkId. If the same question is used in another Questionnaire it will likely end up with a different linkId in that Questionnaire. By referencing a DefinedQuestion by its url in Questionnaire.item.definition, the same question can be referenced unambiguously in multiple Questionnaire.

Multiple DefinedQuestion with identical url can coexist as long as they have differing business versions in version. This way, different versions of the same question can have different answer options.

When using a DefinedQuestion in a Questionnaire, the Questionnaire.item.definition element must contain the url followed by a pipe and the business version thereby referencing a versioned DefinedQuestion.

An automated processing rule captured in a Library resource can, when extracting answer(s) to the question in a QuestionnaireResponse, choose to search for either the versioned reference or the version-less reference to a DefinedQuestion. The latter can be obtained by disregarding the pipe and business version in the rule logic.

The actual details of the DefinedQuestion’s question and possible answers are described in the ElementDefinition found in either snapshot.element or differential.element.

Formal Views of Profile Content

The official URL for this profile is:

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

This profile builds on StructureDefinition.

This profile was published on Tue Oct 27 14:11:48 UTC 2020 as a draft by null.

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

This structure is derived from StructureDefinition

Summary

 

Terminology Bindings

PathConformanceValueSet
StructureDefinition.languageextensibleCommon Languages
Max Binding: All Languages
StructureDefinition.statusrequiredPublicationStatus
StructureDefinition.jurisdictionextensibleJurisdiction ValueSet
StructureDefinition.keywordexampleStructure Definition Codes
StructureDefinition.kindrequiredStructureDefinitionKind
StructureDefinition.contextTyperequiredExtensionContext
StructureDefinition.typeextensibleFHIRDefinedType
StructureDefinition.derivationrequiredTypeDerivationRule

Constraints

IdPathDetailsRequirements
dom-2StructureDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1StructureDefinitionIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4StructureDefinitionIf 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-3StructureDefinitionIf 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()
sdf-9StructureDefinitionIn any snapshot or differential, no label, code or requirements on the an element without a "." in the path (e.g. the first element)
: children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()
Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition
sdf-19StructureDefinitionCustom types can only be used in logical models
: kind = 'logical' or (differential.element.type.code.all(hasValue() implies matches('^[a-zA-Z0-9]+$')) and snapshot.element.type.code.all(hasValue() implies matches('^[a-zA-Z0-9]+$')))
custom types only in logical models
sdf-16StructureDefinitionAll element definitions must have unique ids (snapshot)
: snapshot.element.id.trace('ids').isDistinct()
element ids need to be unique
sdf-18StructureDefinitionContext Invariants can only be used for extensions
: contextInvariant.exists() implies type = 'Extension'
contextInvariant
sdf-17StructureDefinitionAll element definitions must have unique ids (diff)
: differential.element.id.trace('ids').isDistinct()
element ids need to be unique
sdf-11StructureDefinitionIf there's a type, its content must match the path name in the first element of a snapshot
: snapshot.empty() or snapshot.element.first().path = type
Ensure that the type is not inconsistent with the other information in the structure
sdf-14StructureDefinitionAll element definitions must have an id
: snapshot.element.all(id.exists()) and differential.element.all(id.exists())
elements have id
sdf-1StructureDefinitionElement paths must be unique unless the structure is a constraint
: derivation = 'constraint' or snapshot.element.select(path).isDistinct()
sdf-7StructureDefinitionIf the structure describes a base Resource or Type, the URL has to start with "http://hl7.org/fhir/StructureDefinition/" and the tail must match the id
: (derivation = 'constraint') or (kind = 'logical') or (url = 'http://hl7.org/fhir/StructureDefinition/'+id)
sdf-6StructureDefinitionA structure must have either a differential, or a snapshot (or both)
: snapshot.exists() or differential.exists()
sdf-5StructureDefinitionIf the structure defines an extension then the structure must have context information
: type != 'Extension' or derivation = 'specialization' or (context.exists() and contextType.exists())
sdf-4StructureDefinitionIf the structure is not abstract, then there SHALL be a baseDefinition
: abstract = true or baseDefinition.exists()
Ensure that the base types are abstract
ele-1StructureDefinition.mappingAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
sdf-2StructureDefinition.mappingMust have at least a name or a uri (or both)
: name.exists() or uri.exists()
ele-1StructureDefinition.snapshotAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
sdf-15StructureDefinition.snapshotThe first element in a snapshot has no type
: kind!='logical' implies snapshot.element.first().type.empty()
No Type on the root element (snapshot)
sdf-8StructureDefinition.snapshotIn any snapshot, all the elements must be in the specified type
: (%resource.kind = 'logical' or element.first().path = %resource.type) and element.tail().all(path.startsWith(%resource.snapshot.element.first().path&'.'))
sdf-3StructureDefinition.snapshotEach element definition in a snapshot must have a formal definition and cardinalities
: element.all(definition and min and max)
ele-1StructureDefinition.differentialAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
sdf-15aStructureDefinition.differentialIf the first element in a differential has no "." in the path, it has no type
: element.first().path.contains('.').not() implies element.first().type.empty()
No Type on the root element (differential)
sdf-20StructureDefinition.differentialNo slicing on the root element
: element.where(path.contains('.').not()).slicing.empty()
no slicing on root
sdf-8aStructureDefinition.differentialIn any differential, all the elements must be in the specified type
: element.first().path.startsWith(%resource.type) and element.tail().all(path.startsWith(%resource.type&'.'))
.