Smart Bear Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions
Resource Profile: PHQ-9 Questionnaire
| Defining URL: | https://140.164.14.210/fhir/StructureDefinition/PHQ9Questionnaire |
| Version: | 1.0.0 |
| Name: | PHQ9Questionnaire |
| Title: | PHQ-9 Questionnaire |
| Status: | Active as of 2021-06-09T14:27:31+02:00 |
| Definition: | Patient Health Questionnaire |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://140.164.14.210/fhir/StructureDefinition/PHQ9Questionnaire
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Questionnaire
Summary
Mandatory: 5 elements (1 nested mandatory element)
Must-Support: 5 elements
Slices
This structure defines the following Slices:
- The element Questionnaire.item.answerOption.value[x] is sliced based on the value of type:$this
This structure is derived from Questionnaire
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Questionnaire | 0..* | Questionnaire | A structured set of questions | |
  url | S | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
| name | S | 1..1 | string | Name for this questionnaire (computer friendly) Required Pattern: PHQ9 |
| title | S | 1..1 | string | Name for this questionnaire (human friendly) Required Pattern: Patient Health Questionnaire |
| date | S | 1..1 | dateTime | Date last changed |
 item | S | 1..* | BackboneElement | Questions and sections within the Questionnaire |
 linkId | 1..1 | string | Unique id for item in questionnaire Binding: PHQ-9 Questions Value Set (required) | |
| answerOption | ||||
 value[x] | 1..1 | (Slice Definition) | Answer value Slice: Unordered, Open by type:$this | |
| valueCoding | 1..1 | Coding | Answer value | |
 code | 0..1 | code | Symbol in syntax defined by the system Binding: PHQ-9 Answers Value Set (required) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire | I | 0..* | Questionnaire | A structured set of questions |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 |
| url | SΣ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
| identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire |
| version | Σ | 0..1 | string | Business version of the questionnaire |
| name | SΣI | 1..1 | string | Name for this questionnaire (computer friendly) Required Pattern: PHQ9 |
| title | SΣ | 1..1 | string | Name for this questionnaire (human friendly) Required Pattern: Patient Health Questionnaire |
| derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
| subjectType | Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
| date | SΣ | 1..1 | dateTime | Date last changed |
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | 0..1 | markdown | Natural language description of the questionnaire | |
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| purpose | 0..1 | markdown | Why this questionnaire is defined | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |
| lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |
| effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used |
| code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
| item | SI | 1..* | BackboneElement | Questions and sections within the Questionnaire |
| 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 | 1..1 | string | Unique id for item in questionnaire Binding: PHQ-9 Questions Value Set (required) | |
| definition | 0..1 | uri | ElementDefinition - details for the item | |
| code | I | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
| prefix | 0..1 | string | E.g. "1(a)", "2.5.3" | |
| text | 0..1 | string | Primary text for the item | |
| type | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | |
 enableWhen | ?!I | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean |
 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 |
| question | 1..1 | string | Question that determines whether item is enabled | |
| operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
 answer[x] | I | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| answerBoolean | boolean | |||
| answerDecimal | decimal | |||
| answerInteger | integer | |||
| answerDate | date | |||
| answerDateTime | dateTime | |||
| answerTime | time | |||
| answerString | string | |||
| answerCoding | Coding | |||
| answerQuantity | Quantity | |||
 answerReference | Reference(Resource) | |||
| enableBehavior | I | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. |
| required | I | 0..1 | boolean | Whether the item must be included in data results |
| repeats | I | 0..1 | boolean | Whether the item may repeat |
| readOnly | I | 0..1 | boolean | Don't allow human editing |
| maxLength | I | 0..1 | integer | No more than this many characters |
| answerValueSet | I | 0..1 | canonical(ValueSet) | Valueset containing permitted answers |
| answerOption | I | 0..* | BackboneElement | Permitted answer |
| 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] | 1..1 | (Slice Definition) | Answer value Slice: Unordered, Closed by type:$this Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
  value[x]:valueCoding | 1..1 | Coding | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: PHQ-9 Answers Value Set (required) |
| display | Σ | 0..1 | string | Representation defined by the system |
 userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| initialSelected | 0..1 | boolean | Whether option is selected by default | |
| initial | I | 0..* | BackboneElement | Initial value(s) when item is first rendered |
| 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] | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
| valueBoolean | boolean | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueString | string | |||
| valueUri | uri | |||
| valueAttachment | Attachment | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
| valueReference | Reference(Resource) | |||
| item | I | 0..* | See item (Questionnaire) | Nested questionnaire items |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire | I | 0..* | Questionnaire | A structured set of questions |
| url | Σ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
| name | ΣI | 1..1 | string | Name for this questionnaire (computer friendly) Required Pattern: PHQ9 |
| title | Σ | 1..1 | string | Name for this questionnaire (human friendly) Required Pattern: Patient Health Questionnaire |
| date | Σ | 1..1 | dateTime | Date last changed |
| item | I | 1..* | BackboneElement | Questions and sections within the Questionnaire |
| Documentation for this format | ||||
This structure is derived from Questionnaire
Summary
Mandatory: 5 elements (1 nested mandatory element)
Must-Support: 5 elements
Slices
This structure defines the following Slices:
- The element Questionnaire.item.answerOption.value[x] is sliced based on the value of type:$this
Differential View
This structure is derived from Questionnaire
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire | 0..* | Questionnaire | A structured set of questions | |
| url | S | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
| name | S | 1..1 | string | Name for this questionnaire (computer friendly) Required Pattern: PHQ9 |
| title | S | 1..1 | string | Name for this questionnaire (human friendly) Required Pattern: Patient Health Questionnaire |
| date | S | 1..1 | dateTime | Date last changed |
| item | S | 1..* | BackboneElement | Questions and sections within the Questionnaire |
| linkId | 1..1 | string | Unique id for item in questionnaire Binding: PHQ-9 Questions Value Set (required) | |
| answerOption | ||||
| value[x] | 1..1 | (Slice Definition) | Answer value Slice: Unordered, Open by type:$this | |
| valueCoding | 1..1 | Coding | Answer value | |
| code | 0..1 | code | Symbol in syntax defined by the system Binding: PHQ-9 Answers Value Set (required) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Questionnaire | I | 0..* | Questionnaire | A structured set of questions |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 |
| url | SΣ | 1..1 | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
| identifier | Σ | 0..* | Identifier | Additional identifier for the questionnaire |
| version | Σ | 0..1 | string | Business version of the questionnaire |
| name | SΣI | 1..1 | string | Name for this questionnaire (computer friendly) Required Pattern: PHQ9 |
| title | SΣ | 1..1 | string | Name for this questionnaire (human friendly) Required Pattern: Patient Health Questionnaire |
| derivedFrom | 0..* | canonical(Questionnaire) | Instantiates protocol or definition | |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
| subjectType | Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
| date | SΣ | 1..1 | dateTime | Date last changed |
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | 0..1 | markdown | Natural language description of the questionnaire | |
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| purpose | 0..1 | markdown | Why this questionnaire is defined | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| approvalDate | 0..1 | date | When the questionnaire was approved by publisher | |
| lastReviewDate | 0..1 | date | When the questionnaire was last reviewed | |
| effectivePeriod | Σ | 0..1 | Period | When the questionnaire is expected to be used |
| code | Σ | 0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
| item | SI | 1..* | BackboneElement | Questions and sections within the Questionnaire |
| 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 | 1..1 | string | Unique id for item in questionnaire Binding: PHQ-9 Questions Value Set (required) | |
| definition | 0..1 | uri | ElementDefinition - details for the item | |
| code | I | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. |
| prefix | 0..1 | string | E.g. "1(a)", "2.5.3" | |
| text | 0..1 | string | Primary text for the item | |
| type | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | |
| enableWhen | ?!I | 0..* | BackboneElement | Only allow data when que-7: If the operator is 'exists', the value must be a boolean |
| 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 |
| question | 1..1 | string | Question that determines whether item is enabled | |
| operator | 1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
| answer[x] | I | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| answerBoolean | boolean | |||
| answerDecimal | decimal | |||
| answerInteger | integer | |||
| answerDate | date | |||
| answerDateTime | dateTime | |||
| answerTime | time | |||
| answerString | string | |||
| answerCoding | Coding | |||
| answerQuantity | Quantity | |||
| answerReference | Reference(Resource) | |||
| enableBehavior | I | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. |
| required | I | 0..1 | boolean | Whether the item must be included in data results |
| repeats | I | 0..1 | boolean | Whether the item may repeat |
| readOnly | I | 0..1 | boolean | Don't allow human editing |
| maxLength | I | 0..1 | integer | No more than this many characters |
| answerValueSet | I | 0..1 | canonical(ValueSet) | Valueset containing permitted answers |
| answerOption | I | 0..* | BackboneElement | Permitted answer |
| 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] | 1..1 | (Slice Definition) | Answer value Slice: Unordered, Closed by type:$this Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| value[x]:valueCoding | 1..1 | Coding | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 0..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: PHQ-9 Answers Value Set (required) |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| initialSelected | 0..1 | boolean | Whether option is selected by default | |
| initial | I | 0..* | BackboneElement | Initial value(s) when item is first rendered |
| 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] | 1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
| valueBoolean | boolean | |||
| valueDecimal | decimal | |||
| valueInteger | integer | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueString | string | |||
| valueUri | uri | |||
| valueAttachment | Attachment | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
| valueReference | Reference(Resource) | |||
| item | I | 0..* | See item (Questionnaire) | Nested questionnaire items |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| Questionnaire.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Questionnaire.status | required | PublicationStatus |
| Questionnaire.subjectType | required | ResourceType |
| Questionnaire.jurisdiction | extensible | Jurisdiction ValueSet |
| Questionnaire.code | example | QuestionnaireQuestionCodes |
| Questionnaire.item.linkId | required | PHQ9QuestionsVS |
| Questionnaire.item.code | example | QuestionnaireQuestionCodes |
| Questionnaire.item.type | required | QuestionnaireItemType |
| Questionnaire.item.enableWhen.operator | required | QuestionnaireItemOperator |
| Questionnaire.item.enableWhen.answer[x] | example | QuestionnaireAnswerCodes |
| Questionnaire.item.enableBehavior | required | EnableWhenBehavior |
| Questionnaire.item.answerOption.value[x] | example | QuestionnaireAnswerCodes |
| Questionnaire.item.answerOption.value[x]:valueCoding | example | QuestionnaireAnswerCodes |
| Questionnaire.item.answerOption.value[x]:valueCoding.code | required | PHQ9AnswersVS |
| Questionnaire.item.initial.value[x] | example | QuestionnaireAnswerCodes |
Constraints
| Id | Path | Details | Requirements |
| que-7 | Questionnaire.item.enableWhen | If the operator is 'exists', the value must be a boolean : operator = 'exists' implies (answer is Boolean) |