JASPEHR Implementation Guide
0.5.5 - draft
JASPEHR Implementation Guide - Local Development build (v0.5.5). See the Directory of published versions
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from QuestionnaireResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | 0..* | QuestionnaireResponse | A structured set of questions and their answers | |
identifier | S | 1..1 | Identifier | Unique 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..1 | canonical(QuestionnaireJaspehr) | Form being answered 【JASPEHR】 QuestionnaireJaspehr URL/"+{name}+"|"+{version} |
status | S | 1..1 | code | 【JASPEHR】 新規:"completed"、更新:"amended"、削除:"stopped" |
subject | S | 1..1 | Reference(Patient) | The subject of the questions |
encounter | 0..1 | Reference(Encounter) | Encounter created as part of | |
authored | S | 1..1 | dateTime | Date the answers were gathered |
author | S | 1..1 | Reference(Practitioner) | Person who received and recorded the answers |
source | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | |
item | SC | 0..* | BackboneElement | Groups and questions jsr-1: LinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them |
linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
text | S | 0..1 | string | Name for group or question text |
answer | S | 0..* | BackboneElement | The response(s) to the question |
value[x] | S | 0..1 | Single-valued answer to the question | |
valueDecimal | decimal | |||
valueInteger | integer | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueString | string | |||
valueCoding | Coding | |||
item | S | 0..* | Nested groups and questions | |
item | S | 0..* | Nested questionnaire response items | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
jsr-1 | error | QuestionnaireResponse.item | LinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them : linkId.matches('([A-Za-z0-9!#%/:;?@_~]{1,255})') |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | 0..* | QuestionnaireResponse | A structured set of questions and their answers | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..1 | Identifier | Unique 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..1 | canonical(QuestionnaireJaspehr) | Form being answered 【JASPEHR】 QuestionnaireJaspehr URL/"+{name}+"|"+{version} |
status | ?!SΣ | 1..1 | code |
【JASPEHR】
新規:"completed"、更新:"amended"、削除:"stopped"
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. |
subject | SΣ | 1..1 | Reference(Patient) | The subject of the questions |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
authored | SΣ | 1..1 | dateTime | Date the answers were gathered |
author | SΣ | 1..1 | Reference(Practitioner) | Person who received and recorded the answers |
source | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions |
item | SC | 0..* | BackboneElement | Groups and questions jsr-1: LinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
text | S | 0..1 | string | Name for group or question text |
answer | S | 0..* | BackboneElement | The response(s) to the question |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value[x] | S | 0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |
valueDecimal | decimal | |||
valueInteger | integer | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueString | string | |||
valueCoding | Coding | |||
item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions |
item | S | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items |
Documentation for this format |
Path | Conformance | ValueSet |
QuestionnaireResponse.status | required | QuestionnaireResponseStatus |
QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | QuestionnaireResponse | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | QuestionnaireResponse | If 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-4 | error | QuestionnaireResponse | 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-5 | error | QuestionnaireResponse | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | QuestionnaireResponse | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
jsr-1 | error | QuestionnaireResponse.item | LinkID 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-1 | error | QuestionnaireResponse.item | Nested item can't be beneath both item and answer : (answer.exists() and item.exists()).not() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
QuestionnaireResponse | 0..* | QuestionnaireResponse | A structured set of questions and their answers | |||||
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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..1 | Identifier | Unique 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..1 | canonical(QuestionnaireJaspehr) | Form being answered 【JASPEHR】 QuestionnaireJaspehr URL/"+{name}+"|"+{version} | ||||
status | ?!SΣ | 1..1 | code |
【JASPEHR】
新規:"completed"、更新:"amended"、削除:"stopped"
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
subject | SΣ | 1..1 | Reference(Patient) | The subject of the questions | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
authored | SΣ | 1..1 | dateTime | Date the answers were gathered | ||||
author | SΣ | 1..1 | Reference(Practitioner) | Person who received and recorded the answers | ||||
source | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | ||||
item | SC | 0..* | BackboneElement | Groups and questions jsr-1: LinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
linkId | S | 1..1 | string | Pointer to specific item from Questionnaire | ||||
definition | 0..1 | uri | ElementDefinition - details for the item | |||||
text | S | 0..1 | string | Name for group or question text | ||||
answer | S | 0..* | BackboneElement | The response(s) to the question | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | S | 0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueCoding | Coding | |||||||
item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | ||||
item | S | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
QuestionnaireResponse.language | preferred | CommonLanguages
| ||||
QuestionnaireResponse.status | required | QuestionnaireResponseStatus | ||||
QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
jsr-1 | error | QuestionnaireResponse.item | LinkID 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-1 | error | QuestionnaireResponse.item | Nested item can't be beneath both item and answer : (answer.exists() and item.exists()).not() |
This structure is derived from QuestionnaireResponse
Differential View
This structure is derived from QuestionnaireResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | 0..* | QuestionnaireResponse | A structured set of questions and their answers | |
identifier | S | 1..1 | Identifier | Unique 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..1 | canonical(QuestionnaireJaspehr) | Form being answered 【JASPEHR】 QuestionnaireJaspehr URL/"+{name}+"|"+{version} |
status | S | 1..1 | code | 【JASPEHR】 新規:"completed"、更新:"amended"、削除:"stopped" |
subject | S | 1..1 | Reference(Patient) | The subject of the questions |
encounter | 0..1 | Reference(Encounter) | Encounter created as part of | |
authored | S | 1..1 | dateTime | Date the answers were gathered |
author | S | 1..1 | Reference(Practitioner) | Person who received and recorded the answers |
source | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | |
item | SC | 0..* | BackboneElement | Groups and questions jsr-1: LinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them |
linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
text | S | 0..1 | string | Name for group or question text |
answer | S | 0..* | BackboneElement | The response(s) to the question |
value[x] | S | 0..1 | Single-valued answer to the question | |
valueDecimal | decimal | |||
valueInteger | integer | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueString | string | |||
valueCoding | Coding | |||
item | S | 0..* | Nested groups and questions | |
item | S | 0..* | Nested questionnaire response items | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
jsr-1 | error | QuestionnaireResponse.item | LinkID 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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
QuestionnaireResponse | 0..* | QuestionnaireResponse | A structured set of questions and their answers | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..1 | Identifier | Unique 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..1 | canonical(QuestionnaireJaspehr) | Form being answered 【JASPEHR】 QuestionnaireJaspehr URL/"+{name}+"|"+{version} |
status | ?!SΣ | 1..1 | code |
【JASPEHR】
新規:"completed"、更新:"amended"、削除:"stopped"
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. |
subject | SΣ | 1..1 | Reference(Patient) | The subject of the questions |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
authored | SΣ | 1..1 | dateTime | Date the answers were gathered |
author | SΣ | 1..1 | Reference(Practitioner) | Person who received and recorded the answers |
source | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions |
item | SC | 0..* | BackboneElement | Groups and questions jsr-1: LinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
linkId | S | 1..1 | string | Pointer to specific item from Questionnaire |
text | S | 0..1 | string | Name for group or question text |
answer | S | 0..* | BackboneElement | The response(s) to the question |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
value[x] | S | 0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |
valueDecimal | decimal | |||
valueInteger | integer | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueTime | time | |||
valueString | string | |||
valueCoding | Coding | |||
item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions |
item | S | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items |
Documentation for this format |
Path | Conformance | ValueSet |
QuestionnaireResponse.status | required | QuestionnaireResponseStatus |
QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | QuestionnaireResponse | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | QuestionnaireResponse | If 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-4 | error | QuestionnaireResponse | 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-5 | error | QuestionnaireResponse | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | QuestionnaireResponse | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
jsr-1 | error | QuestionnaireResponse.item | LinkID 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-1 | error | QuestionnaireResponse.item | Nested item can't be beneath both item and answer : (answer.exists() and item.exists()).not() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
QuestionnaireResponse | 0..* | QuestionnaireResponse | A structured set of questions and their answers | |||||
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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..1 | Identifier | Unique 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..1 | canonical(QuestionnaireJaspehr) | Form being answered 【JASPEHR】 QuestionnaireJaspehr URL/"+{name}+"|"+{version} | ||||
status | ?!SΣ | 1..1 | code |
【JASPEHR】
新規:"completed"、更新:"amended"、削除:"stopped"
Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. | ||||
subject | SΣ | 1..1 | Reference(Patient) | The subject of the questions | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
authored | SΣ | 1..1 | dateTime | Date the answers were gathered | ||||
author | SΣ | 1..1 | Reference(Practitioner) | Person who received and recorded the answers | ||||
source | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | The person who answered the questions | ||||
item | SC | 0..* | BackboneElement | Groups and questions jsr-1: LinkID should consist of half-width English numbers, letters, and several symbolic-characters, or either of them | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
linkId | S | 1..1 | string | Pointer to specific item from Questionnaire | ||||
definition | 0..1 | uri | ElementDefinition - details for the item | |||||
text | S | 0..1 | string | Name for group or question text | ||||
answer | S | 0..* | BackboneElement | The response(s) to the question | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
value[x] | S | 0..1 | Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question. | |||||
valueDecimal | decimal | |||||||
valueInteger | integer | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueTime | time | |||||||
valueString | string | |||||||
valueCoding | Coding | |||||||
item | S | 0..* | See item (QuestionnaireResponse) | Nested groups and questions | ||||
item | S | 0..* | See item (QuestionnaireResponse) | Nested questionnaire response items | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
QuestionnaireResponse.language | preferred | CommonLanguages
| ||||
QuestionnaireResponse.status | required | QuestionnaireResponseStatus | ||||
QuestionnaireResponse.item.answer.value[x] | example | QuestionnaireAnswerCodes (a valid code from SNOMED CT) |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
jsr-1 | error | QuestionnaireResponse.item | LinkID 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-1 | error | QuestionnaireResponse.item | Nested item can't be beneath both item and answer : (answer.exists() and item.exists()).not() |
This structure is derived from QuestionnaireResponse
Other representations of profile: CSV, Excel, Schematron