Release 5 Ballot
FoundationThis page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
This is a representation of the json schema for Questionnaire, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/Questionnaire",
"$ref": "#/definitions/Questionnaire",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"Questionnaire": {
"description": "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.",
"properties": {
"resourceType": {
"description": "This is a Questionnaire resource",
"const": "Questionnaire"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "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.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "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.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "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.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "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 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.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"version": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "Element.schema.json#/definitions/Element"
},
"versionAlgorithmString": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_versionAlgorithmString": {
"description": "Extensions for versionAlgorithmString",
"$ref": "Element.schema.json#/definitions/Element"
},
"versionAlgorithmCoding": {
"description": "Indicates the mechanism used to compare versions to determine which is more current.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"name": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the questionnaire.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "Element.schema.json#/definitions/Element"
},
"status": {
"description": "The status of this questionnaire. Enables tracking the life-cycle of the content.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"experimental": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "Element.schema.json#/definitions/Element"
},
"date": {
"description": "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.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual responsible for the release and ongoing maintenance of the questionnaire.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "Element.schema.json#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the questionnaire from a consumer\u0027s perspective.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"useContext": {
"description": "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.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the questionnaire is intended to be used.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this questionnaire is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyright": {
"description": "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.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyrightLabel": {
"description": "A short string (\u003c50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. \u0027All rights reserved\u0027, \u0027Some rights reserved\u0027).",
"$ref": "#/definitions/string"
},
"_copyrightLabel": {
"description": "Extensions for copyrightLabel",
"$ref": "Element.schema.json#/definitions/Element"
},
"approvalDate": {
"description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"$ref": "#/definitions/date"
},
"_approvalDate": {
"description": "Extensions for approvalDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"lastReviewDate": {
"description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"$ref": "#/definitions/date"
},
"_lastReviewDate": {
"description": "Extensions for lastReviewDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"effectivePeriod": {
"description": "The period during which the questionnaire content was or is planned to be in active use.",
"$ref": "Period.schema.json#/definitions/Period"
},
"topic": {
"description": "Descriptive topics related to the content of the {{title}}. Topics provide a high-level categorization as well as keywords for the {{title}} that can be useful for filtering and searching.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"author": {
"description": "An individiual or organization primarily involved in the creation and maintenance of the {{title}}.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"editor": {
"description": "An individual or organization primarily responsible for internal coherence of the {{title}}.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"reviewer": {
"description": "An individual or organization primarily responsible for review of some aspect of the {{title}}.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"endorser": {
"description": "An individual or organization responsible for officially endorsing the {{title}} for use in some setting.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"relatedArtifact": {
"description": "Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.",
"items": {
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"type": "array"
},
"derivedFrom": {
"description": "The URL of a Questionnaire that this Questionnaire is based on.",
"items": {
"$ref": "canonical.schema.json#/definitions/canonical"
},
"type": "array"
},
"subjectType": {
"description": "The types of subjects that can be the subject of responses created for the questionnaire.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_subjectType": {
"description": "Extensions for subjectType",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"code": {
"description": "An identifier for this question or group of questions in a particular terminology such as LOINC.",
"items": {
"$ref": "Coding.schema.json#/definitions/Coding"
},
"type": "array"
},
"item": {
"description": "A particular question, question grouping or display text that is part of the questionnaire.",
"items": {
"$ref": "#/definitions/Questionnaire_Item"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"Questionnaire_Item": {
"description": "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"linkId": {
"description": "An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.",
"$ref": "#/definitions/string"
},
"_linkId": {
"description": "Extensions for linkId",
"$ref": "Element.schema.json#/definitions/Element"
},
"definition": {
"description": "This element is a URI that refers to an [ElementDefinition](elementdefinition.html) that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in [Comments](questionnaire.html#definition), below.",
"$ref": "#/definitions/uri"
},
"_definition": {
"description": "Extensions for definition",
"$ref": "Element.schema.json#/definitions/Element"
},
"code": {
"description": "A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).",
"items": {
"$ref": "Coding.schema.json#/definitions/Coding"
},
"type": "array"
},
"prefix": {
"description": "A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.",
"$ref": "#/definitions/string"
},
"_prefix": {
"description": "Extensions for prefix",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "The name of a section, the text of a question or text content for a display item.",
"$ref": "#/definitions/string"
},
"_text": {
"description": "Extensions for text",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, Coding, etc.).",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"enableWhen": {
"description": "A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.",
"items": {
"$ref": "#/definitions/Questionnaire_EnableWhen"
},
"type": "array"
},
"enableBehavior": {
"description": "Controls how multiple enableWhen values are interpreted - whether all or any must be true.",
"$ref": "#/definitions/code"
},
"_enableBehavior": {
"description": "Extensions for enableBehavior",
"$ref": "Element.schema.json#/definitions/Element"
},
"disabledDisplay": {
"description": "Indicates if and how items that are disabled (because enableWhen evaluates to \u0027false\u0027) should be displayed.",
"$ref": "#/definitions/code"
},
"_disabledDisplay": {
"description": "Extensions for disabledDisplay",
"$ref": "Element.schema.json#/definitions/Element"
},
"required": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_required": {
"description": "Extensions for required",
"$ref": "Element.schema.json#/definitions/Element"
},
"repeats": {
"description": "An indication, if true, that a QuestionnaireResponse for this item may include multiple answers associated with a single instance of this item (for question-type items) or multiple repetitions of the item (for group-type items).",
"$ref": "#/definitions/boolean"
},
"_repeats": {
"description": "Extensions for repeats",
"$ref": "Element.schema.json#/definitions/Element"
},
"readOnly": {
"description": "An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.",
"$ref": "#/definitions/boolean"
},
"_readOnly": {
"description": "Extensions for readOnly",
"$ref": "Element.schema.json#/definitions/Element"
},
"maxLength": {
"description": "The maximum number of characters that are permitted in the answer to be considered a \"valid\" QuestionnaireResponse.",
"$ref": "#/definitions/integer"
},
"_maxLength": {
"description": "Extensions for maxLength",
"$ref": "Element.schema.json#/definitions/Element"
},
"answerConstraint": {
"description": "For items that have a defined set of allowed answers (via answerOption or answerValueset), indicates whether values *other* than those specified can be selected.",
"$ref": "#/definitions/code"
},
"_answerConstraint": {
"description": "Extensions for answerConstraint",
"$ref": "Element.schema.json#/definitions/Element"
},
"answerValueSet": {
"description": "A reference to a value set containing a list of values representing permitted answers for a question.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"answerOption": {
"description": "One of the permitted answers for the question.",
"items": {
"$ref": "#/definitions/Questionnaire_AnswerOption"
},
"type": "array"
},
"initial": {
"description": "One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.",
"items": {
"$ref": "#/definitions/Questionnaire_Initial"
},
"type": "array"
},
"item": {
"description": "Text, questions and other groups to be nested beneath a question or group.",
"items": {
"$ref": "#/definitions/Questionnaire_Item"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"Questionnaire_EnableWhen": {
"description": "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"question": {
"description": "The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.",
"$ref": "#/definitions/string"
},
"_question": {
"description": "Extensions for question",
"$ref": "Element.schema.json#/definitions/Element"
},
"operator": {
"description": "Specifies the criteria by which the question is enabled.",
"$ref": "#/definitions/code"
},
"_operator": {
"description": "Extensions for operator",
"$ref": "Element.schema.json#/definitions/Element"
},
"answerBoolean": {
"description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension.",
"pattern": "^true|false$",
"type": "boolean"
},
"_answerBoolean": {
"description": "Extensions for answerBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"answerDecimal": {
"description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension.",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$",
"type": "number"
},
"_answerDecimal": {
"description": "Extensions for answerDecimal",
"$ref": "Element.schema.json#/definitions/Element"
},
"answerInteger": {
"description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension.",
"pattern": "^-?([0]|([1-9][0-9]*))$",
"type": "number"
},
"_answerInteger": {
"description": "Extensions for answerInteger",
"$ref": "Element.schema.json#/definitions/Element"
},
"answerDate": {
"description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_answerDate": {
"description": "Extensions for answerDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"answerDateTime": {
"description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?$",
"type": "string"
},
"_answerDateTime": {
"description": "Extensions for answerDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"answerTime": {
"description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?$",
"type": "string"
},
"_answerTime": {
"description": "Extensions for answerTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"answerString": {
"description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_answerString": {
"description": "Extensions for answerString",
"$ref": "Element.schema.json#/definitions/Element"
},
"answerCoding": {
"description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"answerQuantity": {
"description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"answerReference": {
"description": "A value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
},
"Questionnaire_AnswerOption": {
"description": "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"valueInteger": {
"description": "A potential answer that\u0027s allowed as the answer to this question.",
"pattern": "^-?([0]|([1-9][0-9]*))$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDate": {
"description": "A potential answer that\u0027s allowed as the answer to this question.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_valueDate": {
"description": "Extensions for valueDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueTime": {
"description": "A potential answer that\u0027s allowed as the answer to this question.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?$",
"type": "string"
},
"_valueTime": {
"description": "Extensions for valueTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueString": {
"description": "A potential answer that\u0027s allowed as the answer to this question.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueCoding": {
"description": "A potential answer that\u0027s allowed as the answer to this question.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"valueReference": {
"description": "A potential answer that\u0027s allowed as the answer to this question.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"initialSelected": {
"description": "Indicates whether the answer value is selected when the list of possible answers is initially shown.",
"$ref": "#/definitions/boolean"
},
"_initialSelected": {
"description": "Extensions for initialSelected",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"Questionnaire_Initial": {
"description": "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"valueBoolean": {
"description": "The actual value to for an initial answer.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDecimal": {
"description": "The actual value to for an initial answer.",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$",
"type": "number"
},
"_valueDecimal": {
"description": "Extensions for valueDecimal",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueInteger": {
"description": "The actual value to for an initial answer.",
"pattern": "^-?([0]|([1-9][0-9]*))$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDate": {
"description": "The actual value to for an initial answer.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_valueDate": {
"description": "Extensions for valueDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDateTime": {
"description": "The actual value to for an initial answer.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?$",
"type": "string"
},
"_valueDateTime": {
"description": "Extensions for valueDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueTime": {
"description": "The actual value to for an initial answer.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?$",
"type": "string"
},
"_valueTime": {
"description": "Extensions for valueTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueString": {
"description": "The actual value to for an initial answer.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUri": {
"description": "The actual value to for an initial answer.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueUri": {
"description": "Extensions for valueUri",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueAttachment": {
"description": "The actual value to for an initial answer.",
"$ref": "Attachment.schema.json#/definitions/Attachment"
},
"valueCoding": {
"description": "The actual value to for an initial answer.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"valueQuantity": {
"description": "The actual value to for an initial answer.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"valueReference": {
"description": "The actual value to for an initial answer.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"type": "object",
"additionalProperties": false
}
}
}
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Wed, Sep 7, 2022 11:11+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R5 Draft |
|
Propose a change