Questionnaire | Medplum
Elements
| Name | Required | Type | Description |
|---|---|---|---|
| url | uri | Canonical identifier for this questionnaire, represented as a URI (globally unique) Details An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers. The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension. |
|
| identifier | Identifier[] | Additional identifier for the questionnaire Details A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI. |
|
| version | string | Business version of the questionnaire Details The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different questionnaire instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the questionnaire with the format [url] |
|
| name | string | Name for this questionnaire (computer friendly) Details A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
|
| title | string | Name for this questionnaire (human friendly) Details A short, descriptive, user-friendly title for the questionnaire. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
|
| derivedFrom | canonical[] | Instantiates protocol or definition Details The URL of a Questionnaire that this Questionnaire is based on. |
|
| status | ✓ | code | draft | active | retired | unknown Details The status of this questionnaire. Enables tracking the life-cycle of the content. Allows filtering of questionnaires that are appropriate for use versus not. |
| experimental | boolean | For testing purposes, not real usage Details A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of questionnaires that are appropriate for use versus not. |
|
| subjectType | code[] | Resource that can be subject of QuestionnaireResponse Details The types of subjects that can be the subject of responses created for the questionnaire. If none are specified, then the subject is unlimited. |
|
| date | dateTime | Date last changed Details The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
|
| publisher | string | Name of the publisher (organization or individual) Details The name of the organization or individual that published the questionnaire. Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the questionnaire. This item SHOULD be populated unless the information is available from context. |
|
| contact | ContactDetail[] | Contact details for the publisher Details Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc. |
|
| description | markdown | Natural language description of the questionnaire Details A free text natural language description of the questionnaire from a consumer's perspective. This description can be used to capture details such as why the questionnaire was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created). |
|
| useContext | UsageContext[] | The context that the content is intended to support Details The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
|
| jurisdiction | CodeableConcept[] | Intended jurisdiction for questionnaire (if applicable) Details A legal or geographic region in which the questionnaire is intended to be used. It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended. |
|
| purpose | markdown | Why this questionnaire is defined Details Explanation of why this questionnaire is needed and why it has been designed as it has. This element does not describe the usage of the questionnaire. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this questionnaire. |
|
| copyright | markdown | Use and/or publishing restrictions Details A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire. |
|
| approvalDate | date | When the questionnaire was approved by publisher Details The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. |
|
| lastReviewDate | date | When the questionnaire was last reviewed Details The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. If specified, this date follows the original approval date. |
|
| effectivePeriod | Period | When the questionnaire is expected to be used Details The period during which the questionnaire content was or is planned to be in active use. The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. |
|
| code | Coding[] | Concept that represents the overall questionnaire Details An identifier for this question or group of questions in a particular terminology such as LOINC. |
|
| item | QuestionnaireItem[] | Questions and sections within the Questionnaire Details A particular question, question grouping or display text that is part of the questionnaire. The content of the questionnaire is constructed from an ordered, hierarchical collection of items. |
|
| id | string | Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
|
| extension | Extension[] | Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| question | ✓ | string | Question that determines whether item is enabled Details The linkId for the question whose answer (or lack of answer) governs whether this item is enabled. If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis. |
| operator | ✓ | code | exists | = | != | > | < | >= | <= Details Specifies the criteria by which the question is enabled. |
| answer[x] | ✓ | boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference |
Value for question comparison based on operator Details A value that the referenced question is tested using the specified operator in order for the item to be enabled. |
| enableBehavior | code | all | any Details Controls how multiple enableWhen values are interpreted - whether all or any must be true. This element must be specified if more than one enableWhen value is provided. |
|
| required | boolean | Whether the item must be included in data results Details An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire. Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). The value may come from the ElementDefinition referred to by .definition. |
|
| repeats | boolean | Whether the item may repeat Details An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups. If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. "repeat the question") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items. The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values. The value may come from the ElementDefinition referred to by .definition. |
|
| readOnly | boolean | Don't allow human editing Details An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire. The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers. |
|
| maxLength | integer | No more than this many characters Details The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse. For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition. |
|
| answerValueSet | canonical | Valueset containing permitted answers Details A reference to a value set containing a list of codes representing permitted answers for a "choice" or "open-choice" question. LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists. The value may come from the ElementDefinition referred to by .definition. |
|
| answerOption | QuestionnaireItemAnswerOption[] | Permitted answer Details One of the permitted answers for a "choice" or "open-choice" question. This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes. |
|
| id | string | Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
|
| extension | Extension[] | Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| value[x] | ✓ | integer, date, time, string, Coding, Reference |
Answer value Details A potential answer that's allowed as the answer to this question. The data type of the value must agree with the item.type. |
| initialSelected | boolean | Whether option is selected by default Details Indicates whether the answer value is selected when the list of possible answers is initially shown. Use this instead of initial[v] if answerValueSet is present. |
|
| initial | QuestionnaireItemInitial[] | Initial value(s) when item is first rendered Details One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input. The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial[x] must agree with the item.type, and only repeating items can have more then one initial value. |
|
| id | string | Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
|
| extension | Extension[] | Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| item | [] | Nested questionnaire items Details Text, questions and other groups to be nested beneath a question or group. There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting. |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| code | token | A code that corresponds to one of its items in the questionnaire | Questionnaire.item.code |
| context | token | A use context assigned to the questionnaire | Questionnaire.useContext.value.ofType(CodeableConcept) |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the questionnaire | Questionnaire.useContext.value.ofType(Quantity) | Questionnaire.useContext.value.ofType(Range) |
| context-type | token | A type of use context assigned to the questionnaire | Questionnaire.useContext.code |
| date | date | The questionnaire publication date | Questionnaire.date |
| definition | uri | ElementDefinition - details for the item | Questionnaire.item.definition |
| description | string | The description of the questionnaire | Questionnaire.description |
| effective | date | The time during which the questionnaire is intended to be in use | Questionnaire.effectivePeriod |
| identifier | token | External identifier for the questionnaire | Questionnaire.identifier |
| jurisdiction | token | Intended jurisdiction for the questionnaire | Questionnaire.jurisdiction |
| name | string | Computationally friendly name of the questionnaire | Questionnaire.name |
| publisher | string | Name of the publisher of the questionnaire | Questionnaire.publisher |
| status | token | The current status of the questionnaire | Questionnaire.status |
| subject-type | token | Resource that can be subject of QuestionnaireResponse | Questionnaire.subjectType |
| title | string | The human-friendly name of the questionnaire | Questionnaire.title |
| url | uri | The uri that identifies the questionnaire | Questionnaire.url |
| version | token | The business version of the questionnaire | Questionnaire.version |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the questionnaire | Questionnaire.useContext |
| context-type-value | composite | A use context type and value assigned to the questionnaire | Questionnaire.useContext |
Inherited Elements
| Name | Required | Type | Description |
|---|---|---|---|
| id | string | Logical id of this artifact Details The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
|
| meta | Meta | Metadata about the resource Details The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
|
| implicitRules | uri | A set of rules under which this content was created Details A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
|
| language | code | Language of the resource content Details The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
|
| text | Narrative | Text summary of the resource, for human interpretation Details A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). |
|
| contained | Resource[] | Contained, inline Resources Details These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
|
| extension | Extension[] | Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| modifierExtension | Extension[] | Extensions that cannot be ignored Details May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |