JASPEHR Implementation Guide
0.5.5 - draft

JASPEHR Implementation Guide - Local Development build (v0.5.5). See the Directory of published versions

Resource Profile: QuestionnaireResponseJaspehr

Official URL: http://www.hosp.ncgm.go.jp/JASPEHR/fhir/StructureDefinition/jaspehr-questionnaireResponse Version: 0.5.5
Draft as of 2023-03-09 Computable Name: QuestionnaireResponseJaspehr

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from QuestionnaireResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseA structured set of questions and their answers
... identifier S1..1IdentifierUnique id for this set of answers
... basedOn 0..*Reference(CarePlan | ServiceRequest)Request fulfilled by this QuestionnaireResponse
... partOf 0..*Reference(Observation | Procedure)Part of this action
... status S1..1code 【JASPEHR】 新規:"completed"、更新:"amended"、削除:"stopped"
... subject S1..1Reference(Patient)The subject of the questions
... encounter 0..1Reference(Encounter)Encounter created as part of
... authored S1..1dateTimeDate the answers were gathered
... author S1..1Reference(Practitioner)Person who received and recorded the answers
... source 0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)The person who answered the questions
... item SC0..*BackboneElementGroups and questions
jsr-1: LinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them
.... linkId S1..1stringPointer to specific item from Questionnaire
.... text S0..1stringName for group or question text
.... answer S0..*BackboneElementThe response(s) to the question
..... value[x] S0..1Single-valued answer to the question
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
..... item S0..*Nested groups and questions
.... item S0..*Nested questionnaire response items

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
jsr-1errorQuestionnaireResponse.itemLinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them
: linkId.matches('([A-Za-z0-9!#%/:;?@_~]{1,255})')
NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseA structured set of questions and their answers
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1IdentifierUnique id for this set of answers
... partOf Σ0..*Reference(Observation | Procedure)Part of this action
... questionnaire SΣ1..1canonical(QuestionnaireJaspehr) Form being answered 【JASPEHR】 QuestionnaireJaspehr URL/"+{name}+"|"+{version}
... status ?!SΣ1..1code 【JASPEHR】 新規:"completed"、更新:"amended"、削除:"stopped"
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.

... subject SΣ1..1Reference(Patient)The subject of the questions
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... authored SΣ1..1dateTimeDate the answers were gathered
... author SΣ1..1Reference(Practitioner)Person who received and recorded the answers
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)The person who answered the questions
... item SC0..*BackboneElementGroups and questions
jsr-1: LinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringPointer to specific item from Questionnaire
.... text S0..1stringName for group or question text
.... answer S0..*BackboneElementThe response(s) to the question
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] S0..1Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.

...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
..... item S0..*See item (QuestionnaireResponse)Nested groups and questions
.... item S0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
QuestionnaireResponse.statusrequiredQuestionnaireResponseStatus
QuestionnaireResponse.item.answer.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireResponseIf 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-4errorQuestionnaireResponseIf 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-5errorQuestionnaireResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireResponseA 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()
jsr-1errorQuestionnaireResponse.itemLinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them
: linkId.matches('([A-Za-z0-9!#%/:;?@_~]{1,255})')
qrs-1errorQuestionnaireResponse.itemNested item can't be beneath both item and answer
: (answer.exists() and item.exists()).not()
NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseA structured set of questions and their answers
... 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1IdentifierUnique id for this set of answers
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)Request fulfilled by this QuestionnaireResponse
... partOf Σ0..*Reference(Observation | Procedure)Part of this action
... questionnaire SΣ1..1canonical(QuestionnaireJaspehr) Form being answered 【JASPEHR】 QuestionnaireJaspehr URL/"+{name}+"|"+{version}
... status ?!SΣ1..1code 【JASPEHR】 新規:"completed"、更新:"amended"、削除:"stopped"
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.

... subject SΣ1..1Reference(Patient)The subject of the questions
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... authored SΣ1..1dateTimeDate the answers were gathered
... author SΣ1..1Reference(Practitioner)Person who received and recorded the answers
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)The person who answered the questions
... item SC0..*BackboneElementGroups and questions
jsr-1: LinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them
.... 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 S1..1stringPointer to specific item from Questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... text S0..1stringName for group or question text
.... answer S0..*BackboneElementThe response(s) to the question
..... 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] S0..1Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.

...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
..... item S0..*See item (QuestionnaireResponse)Nested groups and questions
.... item S0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
QuestionnaireResponse.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
QuestionnaireResponse.statusrequiredQuestionnaireResponseStatus
QuestionnaireResponse.item.answer.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()
jsr-1errorQuestionnaireResponse.itemLinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them
: linkId.matches('([A-Za-z0-9!#%/:;?@_~]{1,255})')
qrs-1errorQuestionnaireResponse.itemNested item can't be beneath both item and answer
: (answer.exists() and item.exists()).not()

This structure is derived from QuestionnaireResponse

Summary

Mandatory: 5 elements
Must-Support: 13 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from QuestionnaireResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseA structured set of questions and their answers
... identifier S1..1IdentifierUnique id for this set of answers
... basedOn 0..*Reference(CarePlan | ServiceRequest)Request fulfilled by this QuestionnaireResponse
... partOf 0..*Reference(Observation | Procedure)Part of this action
... status S1..1code 【JASPEHR】 新規:"completed"、更新:"amended"、削除:"stopped"
... subject S1..1Reference(Patient)The subject of the questions
... encounter 0..1Reference(Encounter)Encounter created as part of
... authored S1..1dateTimeDate the answers were gathered
... author S1..1Reference(Practitioner)Person who received and recorded the answers
... source 0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)The person who answered the questions
... item SC0..*BackboneElementGroups and questions
jsr-1: LinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them
.... linkId S1..1stringPointer to specific item from Questionnaire
.... text S0..1stringName for group or question text
.... answer S0..*BackboneElementThe response(s) to the question
..... value[x] S0..1Single-valued answer to the question
...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
..... item S0..*Nested groups and questions
.... item S0..*Nested questionnaire response items

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
jsr-1errorQuestionnaireResponse.itemLinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them
: linkId.matches('([A-Za-z0-9!#%/:;?@_~]{1,255})')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseA structured set of questions and their answers
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1IdentifierUnique id for this set of answers
... partOf Σ0..*Reference(Observation | Procedure)Part of this action
... questionnaire SΣ1..1canonical(QuestionnaireJaspehr) Form being answered 【JASPEHR】 QuestionnaireJaspehr URL/"+{name}+"|"+{version}
... status ?!SΣ1..1code 【JASPEHR】 新規:"completed"、更新:"amended"、削除:"stopped"
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.

... subject SΣ1..1Reference(Patient)The subject of the questions
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... authored SΣ1..1dateTimeDate the answers were gathered
... author SΣ1..1Reference(Practitioner)Person who received and recorded the answers
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)The person who answered the questions
... item SC0..*BackboneElementGroups and questions
jsr-1: LinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId S1..1stringPointer to specific item from Questionnaire
.... text S0..1stringName for group or question text
.... answer S0..*BackboneElementThe response(s) to the question
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] S0..1Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.

...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
..... item S0..*See item (QuestionnaireResponse)Nested groups and questions
.... item S0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
QuestionnaireResponse.statusrequiredQuestionnaireResponseStatus
QuestionnaireResponse.item.answer.value[x]exampleQuestionnaireAnswerCodes (a valid code from SNOMED CT)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorQuestionnaireResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorQuestionnaireResponseIf 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-4errorQuestionnaireResponseIf 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-5errorQuestionnaireResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceQuestionnaireResponseA 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()
jsr-1errorQuestionnaireResponse.itemLinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them
: linkId.matches('([A-Za-z0-9!#%/:;?@_~]{1,255})')
qrs-1errorQuestionnaireResponse.itemNested item can't be beneath both item and answer
: (answer.exists() and item.exists()).not()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. QuestionnaireResponse 0..*QuestionnaireResponseA structured set of questions and their answers
... 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1IdentifierUnique id for this set of answers
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)Request fulfilled by this QuestionnaireResponse
... partOf Σ0..*Reference(Observation | Procedure)Part of this action
... questionnaire SΣ1..1canonical(QuestionnaireJaspehr) Form being answered 【JASPEHR】 QuestionnaireJaspehr URL/"+{name}+"|"+{version}
... status ?!SΣ1..1code 【JASPEHR】 新規:"completed"、更新:"amended"、削除:"stopped"
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response.

... subject SΣ1..1Reference(Patient)The subject of the questions
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... authored SΣ1..1dateTimeDate the answers were gathered
... author SΣ1..1Reference(Practitioner)Person who received and recorded the answers
... source Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)The person who answered the questions
... item SC0..*BackboneElementGroups and questions
jsr-1: LinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them
.... 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 S1..1stringPointer to specific item from Questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... text S0..1stringName for group or question text
.... answer S0..*BackboneElementThe response(s) to the question
..... 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] S0..1Single-valued answer to the question
Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.

...... valueDecimaldecimal
...... valueIntegerinteger
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueStringstring
...... valueCodingCoding
..... item S0..*See item (QuestionnaireResponse)Nested groups and questions
.... item S0..*See item (QuestionnaireResponse)Nested questionnaire response items

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
QuestionnaireResponse.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
QuestionnaireResponse.statusrequiredQuestionnaireResponseStatus
QuestionnaireResponse.item.answer.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()
jsr-1errorQuestionnaireResponse.itemLinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them
: linkId.matches('([A-Za-z0-9!#%/:;?@_~]{1,255})')
qrs-1errorQuestionnaireResponse.itemNested item can't be beneath both item and answer
: (answer.exists() and item.exists()).not()

This structure is derived from QuestionnaireResponse

Summary

Mandatory: 5 elements
Must-Support: 13 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron