{ "description": "This profile represents a Healthcare Associated Infection Singe-Person Report form as a FHIR Questionnaire.", "_filename": "StructureDefinition-hai-single-person-report-questionnaire.json", "package_name": "hl7.fhir.us.hai", "date": "2019-03-27T07:21:32+11:00", "derivation": "constraint", "meta": { "versionId": "1", "lastUpdated": "2019-03-06T08:59:54.000+11:00" }, "publisher": "Lantana Consulting Group", "fhirVersion": "3.0.1", "name": "hai-single-person-report-questionnaire", "mapping": [ { "uri": "http://hl7.org/v3", "name": "RIM Mapping", "identity": "rim" }, { "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping", "identity": "w5" }, { "uri": "http://hl7.org/fhir/object-implementation", "name": "Object Implementation Information", "identity": "objimpl" }, { "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping", "identity": "v2" } ], "abstract": false, "type": "Questionnaire", "experimental": null, "resourceType": "StructureDefinition", "title": "Healthcare Associated Infection Single-Person Report Questionnaire", "package_version": "1.1.0", "snapshot": { "element": [ { "constraint": [ { "key": "dom-2", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource", "severity": "error", "expression": "contained.contained.empty()" }, { "key": "dom-1", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource", "severity": "error", "expression": "contained.text.empty()" }, { "key": "dom-4", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource", "severity": "error", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" }, { "key": "dom-3", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource", "severity": "error", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()" }, { "key": "que-2", "human": "The link ids for groups and questions must be unique within the questionnaire", "xpath": "count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value))", "source": "Questionnaire", "severity": "error", "expression": "descendants().linkId.isDistinct()" } ], "path": "Questionnaire", "min": 0, "definition": "This profile represents a Healthcare Associated Infection Singe-Person Report form as a FHIR Questionnaire.", "short": "Healthcare Associated Infection Single-Person Report Questionnaire", "mapping": [ { "map": "Entity. Role, or Act", "identity": "rim" }, { "map": "Observation[moodCode=DEF]", "identity": "rim" }, { "map": "infrastructure.information", "identity": "w5" } ], "mustSupport": true, "alias": [ "Form", "CRF", "Survey" ], "max": "*", "id": "Questionnaire", "base": { "max": "*", "min": 0, "path": "Questionnaire" } }, { "path": "Questionnaire.id", "min": 0, "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "short": "Logical id of this artifact", "type": [ { "code": "id" } ], "max": "1", "id": "Questionnaire.id", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "base": { "max": "1", "min": 0, "path": "Resource.id" }, "isSummary": true }, { "path": "Questionnaire.meta", "min": 1, "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ], "mustSupport": true, "max": "1", "id": "Questionnaire.meta", "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "isSummary": true }, { "path": "Questionnaire.meta.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Questionnaire.meta.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "Questionnaire.meta.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Questionnaire.meta.extension", "comment": "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.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Questionnaire.meta.versionId", "min": 0, "definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.", "short": "Version specific identifier", "type": [ { "code": "id" } ], "max": "1", "id": "Questionnaire.meta.versionId", "comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.", "base": { "max": "1", "min": 0, "path": "Meta.versionId" }, "isSummary": true }, { "path": "Questionnaire.meta.lastUpdated", "min": 0, "definition": "When the resource last changed - e.g. when the version changed.", "short": "When the resource version last changed", "type": [ { "code": "instant" } ], "max": "1", "id": "Questionnaire.meta.lastUpdated", "comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.", "base": { "max": "1", "min": 0, "path": "Meta.lastUpdated" }, "isSummary": true }, { "path": "Questionnaire.meta.profile", "min": 1, "definition": "A reference to this profile (to which the instance claims to conform).", "short": "A reference to this profile (to which the instance claims to conform).", "type": [ { "code": "uri" } ], "mustSupport": true, "max": "1", "id": "Questionnaire.meta.profile", "comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.", "base": { "max": "*", "min": 0, "path": "Meta.profile" }, "patternUri": "http://hl7.org/fhir/us/hai/StructureDefinition/hai-single-person-report-questionnaire", "isSummary": true }, { "path": "Questionnaire.meta.security", "min": 0, "definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.", "short": "Security Labels applied to this resource", "type": [ { "code": "Coding" } ], "binding": { "strength": "extensible", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "SecurityLabels" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "Security Labels from the Healthcare Privacy and Security Classification System.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/security-labels" } }, "max": "*", "id": "Questionnaire.meta.security", "comment": "The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.", "base": { "max": "*", "min": 0, "path": "Meta.security" }, "isSummary": true }, { "path": "Questionnaire.meta.tag", "min": 0, "definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.", "short": "Tags applied to this resource", "type": [ { "code": "Coding" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Tags" } ], "description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/common-tags" } }, "max": "*", "id": "Questionnaire.meta.tag", "comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.", "base": { "max": "*", "min": 0, "path": "Meta.tag" }, "isSummary": true }, { "path": "Questionnaire.implicitRules", "min": 0, "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.", "isModifier": true, "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ], "max": "1", "id": "Questionnaire.implicitRules", "comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "isSummary": true }, { "path": "Questionnaire.language", "min": 1, "definition": "The base language in which the resource is written.", "short": "Language of the resource content", "type": [ { "code": "code" } ], "mustSupport": true, "patternCode": "en-US", "binding": { "strength": "extensible", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } }, "max": "1", "id": "Questionnaire.language", "comment": "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).", "base": { "max": "1", "min": 0, "path": "Resource.language" } }, { "path": "Questionnaire.text", "min": 0, "definition": "A human-readable narrative that contains a summary of the resource, and may 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.", "short": "Text summary of the resource, for human interpretation", "mapping": [ { "map": "Act.text?", "identity": "rim" } ], "type": [ { "code": "Narrative" } ], "mustSupport": true, "alias": [ "narrative", "html", "xhtml", "display" ], "max": "1", "id": "Questionnaire.text", "condition": [ "dom-1" ], "comment": "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). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.", "base": { "max": "1", "min": 0, "path": "DomainResource.text" } }, { "path": "Questionnaire.contained", "min": 0, "definition": "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.", "short": "Contained, inline Resources", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Resource" } ], "alias": [ "inline resources", "anonymous resources", "contained resources" ], "max": "*", "id": "Questionnaire.contained", "comment": "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.", "base": { "max": "*", "min": 0, "path": "DomainResource.contained" } }, { "path": "Questionnaire.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Questionnaire.extension", "comment": "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.", "base": { "max": "*", "min": 0, "path": "DomainResource.extension" } }, { "path": "Questionnaire.modifierExtension", "min": 0, "definition": "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. Usually modifier elements provide negation or qualification. In order 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.", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Questionnaire.modifierExtension", "comment": "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.", "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" } }, { "path": "Questionnaire.url", "requirements": "… This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.", "min": 0, "definition": "An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this questionnaire is (or will be) published. The URL SHOULD include the major version of the questionnaire. For more information see [Technical and Business Versions](http://hl7.org/fhir/STU3/resource.html#versions).", "short": "Logical URI to reference this questionnaire (globally unique)", "mapping": [ { "map": ".identifier[scope=BUSN;reliability=ISS]", "identity": "rim" }, { "map": "id", "identity": "w5" } ], "type": [ { "code": "uri" } ], "max": "1", "id": "Questionnaire.url", "comment": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version.", "base": { "max": "1", "min": 0, "path": "Questionnaire.url" }, "isSummary": true }, { "path": "Questionnaire.identifier", "requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.", "min": 1, "definition": "Globally unique identifier for the instance.", "short": "Globally unique identifier for the instance", "mapping": [ { "map": ".identifier", "identity": "rim" }, { "map": "no-gen-base", "identity": "objimpl" }, { "map": "id", "identity": "w5" } ], "type": [ { "code": "Identifier" } ], "mustSupport": true, "max": "1", "id": "Questionnaire.identifier", "comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this questionnaire outside of FHIR, where it is not possible to use the logical URI.", "base": { "max": "*", "min": 0, "path": "Questionnaire.identifier" }, "isSummary": true }, { "path": "Questionnaire.version", "min": 0, "definition": "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.", "short": "Business version of the questionnaire", "mapping": [ { "map": "N/A (to add?)", "identity": "rim" }, { "map": "id.version", "identity": "w5" } ], "type": [ { "code": "string" } ], "max": "1", "id": "Questionnaire.version", "comment": "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 refrence to a particular business version of the questionnaire with the format [url]|[version].", "base": { "max": "1", "min": 0, "path": "Questionnaire.version" }, "isSummary": true }, { "path": "Questionnaire.name", "requirements": "Support human navigation and code generation.", "min": 0, "definition": "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.", "short": "Name for this questionnaire (computer friendly)", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "Questionnaire.name", "comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.", "base": { "max": "1", "min": 0, "path": "Questionnaire.name" }, "isSummary": true }, { "path": "Questionnaire.title", "min": 1, "definition": "A short, descriptive, user-friendly title for the questionnaire.", "short": "Name for this questionnaire (human friendly)", "mapping": [ { "map": ".title", "identity": "rim" } ], "type": [ { "code": "string" } ], "mustSupport": true, "max": "1", "id": "Questionnaire.title", "comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.", "base": { "max": "1", "min": 0, "path": "Questionnaire.title" }, "isSummary": true }, { "path": "Questionnaire.status", "min": 1, "definition": "The status of this questionnaire. Enables tracking the life-cycle of the content.", "isModifier": true, "short": "draft | active | retired | unknown", "mapping": [ { "map": ".status", "identity": "rim" }, { "map": "status", "identity": "w5" } ], "type": [ { "code": "code" } ], "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PublicationStatus" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "The lifecycle status of a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "max": "1", "id": "Questionnaire.status", "comment": "Allows filtering of questionnaires that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired questionnaire without due consideration.", "base": { "max": "1", "min": 1, "path": "Questionnaire.status" }, "isSummary": true }, { "path": "Questionnaire.experimental", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.", "min": 0, "definition": "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.", "isModifier": true, "short": "For testing purposes, not real usage", "mapping": [ { "map": "N/A", "identity": "rim" }, { "map": "class", "identity": "w5" } ], "type": [ { "code": "boolean" } ], "max": "1", "id": "Questionnaire.experimental", "comment": "Allows filtering of questionnaire that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental questionnaire in production.", "base": { "max": "1", "min": 0, "path": "Questionnaire.experimental" }, "isSummary": true }, { "path": "Questionnaire.date", "min": 1, "definition": "The date (and optionally time) when the questionnaire was published. The date must change if and 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.", "short": "Date this was last changed", "mapping": [ { "map": ".participation[typeCode=AUT].time", "identity": "rim" }, { "map": "when.recorded", "identity": "w5" } ], "type": [ { "code": "dateTime" } ], "mustSupport": true, "alias": [ "Revision Date" ], "max": "1", "id": "Questionnaire.date", "comment": "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.", "base": { "max": "1", "min": 0, "path": "Questionnaire.date" }, "isSummary": true }, { "path": "Questionnaire.publisher", "requirements": "Helps establish the \"authority/credibility\" of the questionnaire. May also allow for contact.", "min": 1, "definition": "The name of the individual or organization that published the questionnaire.", "short": "Name of the publisher (organization or individual)", "mapping": [ { "map": ".participation[typeCode=AUT].role", "identity": "rim" }, { "map": "who.witness", "identity": "w5" } ], "type": [ { "code": "string" } ], "mustSupport": true, "max": "1", "id": "Questionnaire.publisher", "comment": "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.", "base": { "max": "1", "min": 0, "path": "Questionnaire.publisher" }, "isSummary": true }, { "path": "Questionnaire.description", "min": 1, "definition": "A free text natural language description of the questionnaire from a consumer's perspective.", "short": "Natural language description of the questionnaire", "mapping": [ { "map": ".text", "identity": "rim" } ], "type": [ { "code": "markdown" } ], "mustSupport": true, "max": "1", "id": "Questionnaire.description", "comment": "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 profile is presumed to be the predominant language in the place the profile was created).", "base": { "max": "1", "min": 0, "path": "Questionnaire.description" } }, { "path": "Questionnaire.purpose", "min": 0, "definition": "Explaination of why this questionnaire is needed and why it has been designed as it has.", "short": "Why this questionnaire is defined", "mapping": [ { "map": ".reasonCode.text", "identity": "rim" }, { "map": "no-gen-base", "identity": "objimpl" }, { "map": "why", "identity": "w5" } ], "type": [ { "code": "markdown" } ], "max": "1", "id": "Questionnaire.purpose", "comment": "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.", "base": { "max": "1", "min": 0, "path": "Questionnaire.purpose" } }, { "path": "Questionnaire.approvalDate", "min": 0, "definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.", "short": "When the questionnaire was approved by publisher", "mapping": [ { "map": ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime", "identity": "rim" }, { "map": "no-gen-base", "identity": "objimpl" } ], "type": [ { "code": "date" } ], "max": "1", "id": "Questionnaire.approvalDate", "comment": "The 'date' element may be more recent than the approval date because of minor changes / editorial corrections.", "base": { "max": "1", "min": 0, "path": "Questionnaire.approvalDate" } }, { "path": "Questionnaire.lastReviewDate", "requirements": "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.", "min": 0, "definition": "The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.", "short": "When the questionnaire was last reviewed", "mapping": [ { "map": ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime", "identity": "rim" }, { "map": "no-gen-base", "identity": "objimpl" } ], "type": [ { "code": "date" } ], "max": "1", "id": "Questionnaire.lastReviewDate", "comment": "If specified, this is usually after the approval date.", "base": { "max": "1", "min": 0, "path": "Questionnaire.lastReviewDate" } }, { "path": "Questionnaire.effectivePeriod", "requirements": "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the questionnaire are or are expected to be used instead.", "min": 0, "definition": "The period during which the questionnaire content was or is planned to be in active use.", "short": "When the questionnaire is expected to be used", "mapping": [ { "map": "N/A (to add?)", "identity": "rim" }, { "map": "no-gen-base", "identity": "objimpl" } ], "type": [ { "code": "Period" } ], "max": "1", "id": "Questionnaire.effectivePeriod", "comment": "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.", "base": { "max": "1", "min": 0, "path": "Questionnaire.effectivePeriod" }, "isSummary": true }, { "path": "Questionnaire.useContext", "requirements": "Assist in searching for appropriate content.", "min": 0, "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate questionnaire instances.", "short": "Context the content is intended to support", "mapping": [ { "map": "N/A (to add?)", "identity": "rim" } ], "type": [ { "code": "UsageContext" } ], "max": "*", "id": "Questionnaire.useContext", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "base": { "max": "*", "min": 0, "path": "Questionnaire.useContext" }, "isSummary": true }, { "path": "Questionnaire.jurisdiction", "min": 1, "definition": "A legal or geographic region in which the questionnaire is intended to be used.", "short": "Intended jurisdiction for questionnaire (if applicable)", "mapping": [ { "map": "N/A (to add?)", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "mustSupport": true, "binding": { "strength": "extensible", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Jurisdiction" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "Countries and regions within which this artifact is targeted for use", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } }, "max": "1", "id": "Questionnaire.jurisdiction", "comment": "It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.", "patternCodeableConcept": { "coding": [ { "code": "US", "system": "urn:iso:std:iso:3166" } ] }, "base": { "max": "*", "min": 0, "path": "Questionnaire.jurisdiction" }, "isSummary": true }, { "path": "Questionnaire.contact", "min": 0, "definition": "Contact details to assist a user in finding and communicating with the publisher.", "short": "Contact details for the publisher", "mapping": [ { "map": ".participation[typeCode=CALLBCK].role", "identity": "rim" } ], "type": [ { "code": "ContactDetail" } ], "max": "*", "id": "Questionnaire.contact", "comment": "May be a web site, an email address, a telephone number, etc.", "base": { "max": "*", "min": 0, "path": "Questionnaire.contact" }, "isSummary": true }, { "path": "Questionnaire.copyright", "requirements": "Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content.", "min": 0, "definition": "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.", "short": "Use and/or publishing restrictions", "mapping": [ { "map": "N/A (to add?)", "identity": "rim" }, { "map": "no-gen-base", "identity": "objimpl" } ], "type": [ { "code": "markdown" } ], "alias": [ "License", "Restrictions" ], "max": "1", "id": "Questionnaire.copyright", "base": { "max": "1", "min": 0, "path": "Questionnaire.copyright" } }, { "path": "Questionnaire.code", "requirements": "Allows linking of the complete Questionnaire resources to formal terminologies. It's common for \"panels\" of questions to be identified by a code.", "min": 1, "definition": "LOINC code 51897-7 to indicate that this is a Healthcare Associated Infection Report", "short": "Code for Healthcare Associated Infection Report", "mapping": [ { "map": ".code", "identity": "rim" } ], "type": [ { "code": "Coding" } ], "mustSupport": true, "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireConcept" } ], "description": "Codes for questionnaires, groups and individual questions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-questions" } }, "max": "1", "id": "Questionnaire.code", "patternCoding": { "code": "51897-7", "system": "http://loinc.org" }, "base": { "max": "*", "min": 0, "path": "Questionnaire.code" }, "isSummary": true }, { "path": "Questionnaire.subjectType", "fixedCode": "Patient", "min": 1, "definition": "Patient Resource (US Core Patient) is the subject of the related QuestionnaireResponse", "short": "Patient Resource (US Core Patient) is the subject of the related QuestionnaireResponse", "mapping": [ { "map": ".outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode", "identity": "rim" } ], "type": [ { "code": "code" } ], "mustSupport": true, "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } }, "max": "1", "id": "Questionnaire.subjectType", "comment": "If none are specified, then the subject is unlimited.", "base": { "max": "*", "min": 0, "path": "Questionnaire.subjectType" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "que-9", "human": "Read-only can't be specified for \"display\" items", "xpath": "not(f:type/@value='display' and f:readOnly)", "source": "Questionnaire.item", "severity": "error", "expression": "type!='display' or readOnly.empty()" }, { "key": "que-8", "human": "Default values can't be specified for groups or display items", "xpath": "not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')])", "source": "Questionnaire.item", "severity": "error", "expression": "(type!='group' and type!='display') or initial.empty()" }, { "key": "que-6", "human": "Required and repeat aren't permitted for display items", "xpath": "not(f:type/@value='display' and (f:required or f:repeats))", "source": "Questionnaire.item", "severity": "error", "expression": "type!='display' or (required.empty() and repeats.empty())" }, { "key": "que-5", "human": "Only 'choice' items can have options", "xpath": "f:type/@value=('choice','open-choice') or not(f:option or f:options)", "source": "Questionnaire.item", "severity": "error", "expression": "(type ='choice' or type = 'open-choice') or (options.empty() and option.empty())" }, { "key": "que-4", "human": "A question cannot have both option and options", "xpath": "not(f:options and f:option)", "source": "Questionnaire.item", "severity": "error", "expression": "option.empty() or options.empty()" }, { "key": "que-3", "human": "Display items cannot have a \"code\" asserted", "xpath": "not(f:type/@value='display' and f:code)", "source": "Questionnaire.item", "severity": "error", "expression": "type!='display' or code.empty()" }, { "key": "que-10", "human": "Maximum length can only be declared for simple question types", "xpath": "f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url') or not(f:maxLength)", "source": "Questionnaire.item", "severity": "error", "expression": "(type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty()" }, { "key": "que-1", "human": "Group items must have nested items, display items cannot have nested items", "xpath": "not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item))", "source": "Questionnaire.item", "severity": "error", "expression": "(type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())" } ], "path": "Questionnaire.item", "min": 1, "definition": "A particular question, question grouping or display text that is part of the questionnaire.", "short": "Questions and sections within the Questionnaire", "mapping": [ { "map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]", "identity": "rim" } ], "type": [ { "code": "BackboneElement" } ], "mustSupport": true, "max": "*", "id": "Questionnaire.item", "condition": [ "que-3" ], "comment": "The content of the questionnaire is constructed from an ordered, hierarchical collection of items.", "base": { "max": "*", "min": 0, "path": "Questionnaire.item" } }, { "path": "Questionnaire.item.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Questionnaire.item.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "Questionnaire.item.extension", "min": 0, "definition": "An Extension", "short": "Extension", "slicing": { "rules": "open", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "max": "*", "id": "Questionnaire.item.extension", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Questionnaire.item.extension", "min": 0, "definition": "Where the type for a question is \"Reference\", indicates a profile that the resource instances pointed to in answers to this question must be valid against.", "short": "Allowed profile for reference", "type": [ { "code": "Extension", "profile": "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile" } ], "mustSupport": true, "sliceName": "extensionQuestionnaireAllowedProfile", "max": "1", "id": "Questionnaire.item.extension:extensionQuestionnaireAllowedProfile", "condition": [ "ele-1" ], "comment": "If multiple profiles are present, then the resource must be valid against at least one of them.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Questionnaire.item.modifierExtension", "min": 0, "definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "Questionnaire.item.modifierExtension", "comment": "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.", "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "isSummary": true }, { "path": "Questionnaire.item.linkId", "requirements": "[QuestionnaireResponse](http://hl7.org/fhir/STU3/questionnaireresponse.html#) does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.", "min": 1, "definition": "An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.", "short": "Unique id for item in questionnaire", "mapping": [ { "map": ".id", "identity": "rim" } ], "type": [ { "code": "string" } ], "mustSupport": true, "max": "1", "id": "Questionnaire.item.linkId", "comment": "This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.", "base": { "max": "1", "min": 1, "path": "Questionnaire.item.linkId" } }, { "path": "Questionnaire.item.definition", "requirements": "A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition.", "min": 0, "definition": "A reference to an [ElementDefinition](http://hl7.org/fhir/STU3/elementdefinition.html) that provides the details for the item. If a definition is provided, then the following element values can be inferred from the definition: \n\n* code (ElementDefinition.code)\n* type (ElementDefinition.type)\n* required (ElementDefinition.min)\n* repeats (ElementDefinition.max)\n* maxLength (ElementDefinition.maxLength)\n* options (ElementDefinition.binding)\n\nAny information provided in these elements on a Questionnaire Item overrides the information from the definition.", "short": "ElementDefinition - details for the item", "mapping": [ { "map": ".outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]", "identity": "rim" } ], "type": [ { "code": "uri" } ], "max": "1", "id": "Questionnaire.item.definition", "comment": "the URI refers to an ElementDefinition in either a [StructureDefinition](http://hl7.org/fhir/STU3/structuredefinition.html#) or a [DataElement](http://hl7.org/fhir/STU3/dataelement.html#), and always starts with the canonical URL for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id [Element.id](http://hl7.org/fhir/STU3/element-definitions.html#Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition. Note that [LOINC codes](http://hl7.org/fhir/STU3/loinc.html#dataelements) implicitly define DataElement resources.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.definition" } }, { "path": "Questionnaire.item.code", "requirements": "Allows linking of groups of questions to formal terminologies.", "min": 0, "definition": "A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).", "short": "Corresponding concept for this item in a terminology", "mapping": [ { "map": ".code", "identity": "rim" } ], "type": [ { "code": "Coding" } ], "mustSupport": true, "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireConcept" } ], "description": "Codes for questionnaires, groups and individual questions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-questions" } }, "max": "*", "id": "Questionnaire.item.code", "condition": [ "que-3" ], "comment": "The value may come from the ElementDefinition referred to by .definition.", "base": { "max": "*", "min": 0, "path": "Questionnaire.item.code" }, "isSummary": true }, { "path": "Questionnaire.item.prefix", "requirements": "Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used.", "min": 0, "definition": "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.", "short": "E.g. \"1(a)\", \"2.5.3\"", "mapping": [ { "map": "Not supported", "identity": "rim" } ], "type": [ { "code": "string" } ], "alias": [ "label" ], "max": "1", "id": "Questionnaire.item.prefix", "comment": "These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed.\n\nTypically these won't be used for \"display\" items, though such use is not prohibited.\n\nSystems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.prefix" } }, { "path": "Questionnaire.item.text", "min": 0, "definition": "The name of a section, the text of a question or text content for a display item.", "short": "Primary text for the item", "mapping": [ { "map": ".text", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "Questionnaire.item.text", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.text" }, "isSummary": true }, { "path": "Questionnaire.item.type", "requirements": "Defines the format in which the user is to be prompted for the answer.", "min": 1, "definition": "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, coded choice, etc.).", "short": "group | display | boolean | decimal | integer | date | dateTime +", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "code" } ], "mustSupport": true, "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireItemType" } ], "description": "Distinguishes groups from questions and display text and indicates data type for questions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/item-type" } }, "max": "1", "id": "Questionnaire.item.type", "comment": "Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.", "base": { "max": "1", "min": 1, "path": "Questionnaire.item.type" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "que-7", "human": "enableWhen must contain either a 'answer' or a 'hasAnswer' element", "xpath": "count(f:*[starts-with(local-name(.), 'answer')]|self::f:hasAnswer) = 1", "source": "Questionnaire.item.enableWhen", "severity": "error", "expression": "hasAnswer.exists() xor answer.exists()" } ], "path": "Questionnaire.item.enableWhen", "requirements": "Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions.", "min": 0, "definition": "A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.", "isModifier": true, "short": "Only allow data when", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "BackboneElement" } ], "mustSupport": true, "max": "*", "id": "Questionnaire.item.enableWhen", "comment": "If multiple repetitions of this extension are present, the item should be enabled when the condition for *any* of the repetitions is true. I.e. treat \"enableWhen\"s as being joined by an \"or\" clause.\n\nThis element is a modifier because if enableWhen is present for an item, \"required\" is ignored unless one of the enableWhen conditions is met.", "base": { "max": "*", "min": 0, "path": "Questionnaire.item.enableWhen" }, "isSummary": true }, { "path": "Questionnaire.item.enableWhen.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Questionnaire.item.enableWhen.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "Questionnaire.item.enableWhen.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Questionnaire.item.enableWhen.extension", "comment": "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.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Questionnaire.item.enableWhen.modifierExtension", "min": 0, "definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "Questionnaire.item.enableWhen.modifierExtension", "comment": "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.", "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "isSummary": true }, { "path": "Questionnaire.item.enableWhen.question", "min": 1, "definition": "The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.", "short": "Question that determines whether item is enabled", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "Questionnaire.item.enableWhen.question", "comment": "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.", "base": { "max": "1", "min": 1, "path": "Questionnaire.item.enableWhen.question" } }, { "path": "Questionnaire.item.enableWhen.hasAnswer", "min": 0, "definition": "An indication that this item should be enabled only if the specified question is answered (hasAnswer=true) or not answered (hasAnswer=false).", "short": "Enable when answered or not", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "boolean" } ], "max": "1", "id": "Questionnaire.item.enableWhen.hasAnswer", "condition": [ "que-7" ], "comment": "If answered=false and answer values are also provided, then they are treated as \"or\". I.e. \"Enable if the question is unanswered or the answer is one of the specified values\". If answered=true and answers are present, one of the specified answers must be met. (So there's little reason to specify answered=true if answers are present.).", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.enableWhen.hasAnswer" } }, { "path": "Questionnaire.item.enableWhen.answer[x]", "min": 0, "definition": "An answer that the referenced question must match in order for the item to be enabled.", "short": "Value question must have", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "boolean" }, { "code": "decimal" }, { "code": "integer" }, { "code": "date" }, { "code": "dateTime" }, { "code": "time" }, { "code": "string" }, { "code": "uri" }, { "code": "Attachment" }, { "code": "Coding" }, { "code": "Quantity" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireQuestionOption2" } ], "description": "Allowed values to answer questions.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers" } }, "max": "1", "id": "Questionnaire.item.enableWhen.answer[x]", "condition": [ "que-7" ], "comment": "Multiple answers are treated as \"or\". E.g. Enable if question 1 = A, C or E. \n\nComponents not specified in the answer do not need to match. For example, if enableWhen specifies code + system for a Coding, it is ok if the answer has a \"display\" element. I.e. treat the answer as a 'pattern'.\n\nThe dataType of this element must be the same as the data type of the question being referenced.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.enableWhen.answer[x]" } }, { "path": "Questionnaire.item.required", "min": 0, "definition": "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.", "short": "Whether the item must be included in data results", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "mustSupport": true, "max": "1", "id": "Questionnaire.item.required", "condition": [ "que-6" ], "comment": "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.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.required" } }, { "path": "Questionnaire.item.repeats", "requirements": "Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.", "min": 0, "definition": "An indication, if true, that the item may occur multiple times in the response, collecting multiple answers answers for questions or multiple sets of answers for groups.", "short": "Whether the item may repeat", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "mustSupport": true, "max": "1", "id": "Questionnaire.item.repeats", "condition": [ "que-6" ], "comment": "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 or to simply list each of the answers beneath the question. (Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.). The value may come from the ElementDefinition referred to by .definition.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.repeats" } }, { "path": "Questionnaire.item.readOnly", "requirements": "Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc.", "min": 0, "definition": "An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.", "short": "Don't allow human editing", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "boolean" } ], "max": "1", "id": "Questionnaire.item.readOnly", "condition": [ "que-9" ], "comment": "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.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.readOnly" } }, { "path": "Questionnaire.item.maxLength", "min": 0, "definition": "The maximum number of characters that are permitted in the answer to be considered a \"valid\" QuestionnaireResponse.", "short": "No more than this many characters", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "integer" } ], "max": "1", "id": "Questionnaire.item.maxLength", "condition": [ "que-10" ], "comment": "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.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.maxLength" } }, { "path": "Questionnaire.item.options", "min": 0, "definition": "A reference to a value set containing a list of codes representing permitted answers for a \"choice\" or \"open-choice\" question.", "short": "Valueset containing permitted answers", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ValueSet" } ], "mustSupport": true, "max": "1", "id": "Questionnaire.item.options", "condition": [ "que-4", "que-5" ], "comment": "LOINC defines many useful value sets for questionnaire responses. See [LOINC Answer Lists](http://hl7.org/fhir/STU3/loinc.html#alist). The value may come from the ElementDefinition referred to by .definition.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.options" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" } ], "path": "Questionnaire.item.option", "min": 0, "definition": "One of the permitted answers for a \"choice\" or \"open-choice\" question.", "short": "Permitted answer", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "BackboneElement" } ], "max": "*", "id": "Questionnaire.item.option", "condition": [ "que-4", "que-5" ], "comment": "This element can be used when the value set machinery of options is deemed too cumbersome or when there's a need to capture options that are not codes.", "base": { "max": "*", "min": 0, "path": "Questionnaire.item.option" } }, { "path": "Questionnaire.item.option.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Questionnaire.item.option.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "Questionnaire.item.option.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Questionnaire.item.option.extension", "comment": "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.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Questionnaire.item.option.modifierExtension", "min": 0, "definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "Questionnaire.item.option.modifierExtension", "comment": "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.", "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "isSummary": true }, { "path": "Questionnaire.item.option.value[x]", "min": 1, "definition": "A potential answer that's allowed as the answer to this question.", "short": "Answer value", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "integer" }, { "code": "date" }, { "code": "time" }, { "code": "string" }, { "code": "Coding" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireQuestionOption" } ], "description": "Allowed values to answer questions.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers" } }, "max": "1", "id": "Questionnaire.item.option.value[x]", "comment": "The data type of the value must agree with the item.type.", "base": { "max": "1", "min": 1, "path": "Questionnaire.item.option.value[x]" } }, { "path": "Questionnaire.item.initial[x]", "requirements": "In some workflows, having defaults saves time.", "min": 0, "definition": "The value that should be defaulted when initially rendering the questionnaire for user input.", "short": "Default value when item is first rendered", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "boolean" }, { "code": "decimal" }, { "code": "integer" }, { "code": "date" }, { "code": "dateTime" }, { "code": "time" }, { "code": "string" }, { "code": "uri" }, { "code": "Attachment" }, { "code": "Coding" }, { "code": "Quantity" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireQuestionOption2" } ], "description": "Allowed values to answer questions.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers" } }, "max": "1", "id": "Questionnaire.item.initial[x]", "condition": [ "que-8" ], "comment": "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 default values can influence results.\n\nThe data type of initial[x] must agree with the item.type.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.initial[x]" } }, { "path": "Questionnaire.item.item", "requirements": "Reports can consist of complex nested groups.", "min": 0, "definition": "Text, questions and other groups to be nested beneath a question or group.", "short": "Nested questionnaire items", "mapping": [ { "map": ".outboundRelationship[typeCode=COMP].target", "identity": "rim" } ], "type": [ { "code": "BackboneElement" } ], "mustSupport": true, "max": "*", "id": "Questionnaire.item.item", "condition": [ "que-1" ], "comment": "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.", "base": { "max": "*", "min": 0, "path": "Questionnaire.item.item" } }, { "path": "Questionnaire.item.item.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Questionnaire.item.item.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "Questionnaire.item.item.extension", "min": 0, "definition": "An Extension", "short": "Extension", "slicing": { "rules": "open", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "max": "*", "id": "Questionnaire.item.item.extension", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Questionnaire.item.item.extension", "min": 0, "definition": "Where the type for a question is \"Reference\", indicates a profile that the resource instances pointed to in answers to this question must be valid against.", "short": "Allowed profile for reference", "type": [ { "code": "Extension", "profile": "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile" } ], "mustSupport": true, "sliceName": "extensionQuestionnaireAllowedProfile", "max": "1", "id": "Questionnaire.item.item.extension:extensionQuestionnaireAllowedProfile", "condition": [ "ele-1" ], "comment": "If multiple profiles are present, then the resource must be valid against at least one of them.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Questionnaire.item.item.extension", "min": 0, "definition": "Provides a computable unit of measure associated with numeric questions to support subsequent computation on responses.", "short": "Unit for numeric answer", "mapping": [ { "map": "N/A (MIF-level)", "identity": "rim" } ], "type": [ { "code": "Extension", "profile": "http://hl7.org/fhir/StructureDefinition/questionnaire-unit" } ], "mustSupport": true, "sliceName": "extensionQuestionnaire-unit", "max": "1", "id": "Questionnaire.item.item.extension:extensionQuestionnaire-unit", "condition": [ "ele-1" ], "comment": "The human-readable unit is conveyed as a display element. This element is for computation purposes.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Questionnaire.item.item.modifierExtension", "min": 0, "definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "Questionnaire.item.item.modifierExtension", "comment": "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.", "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "isSummary": true }, { "path": "Questionnaire.item.item.linkId", "requirements": "[QuestionnaireResponse](http://hl7.org/fhir/STU3/questionnaireresponse.html#) does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.", "min": 1, "definition": "An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.", "short": "Unique id for item in questionnaire", "mapping": [ { "map": ".id", "identity": "rim" } ], "type": [ { "code": "string" } ], "mustSupport": true, "max": "1", "id": "Questionnaire.item.item.linkId", "comment": "This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.", "base": { "max": "1", "min": 1, "path": "Questionnaire.item.linkId" } }, { "path": "Questionnaire.item.item.definition", "requirements": "A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition.", "min": 0, "definition": "A reference to an [ElementDefinition](http://hl7.org/fhir/STU3/elementdefinition.html) that provides the details for the item. If a definition is provided, then the following element values can be inferred from the definition: \n\n* code (ElementDefinition.code)\n* type (ElementDefinition.type)\n* required (ElementDefinition.min)\n* repeats (ElementDefinition.max)\n* maxLength (ElementDefinition.maxLength)\n* options (ElementDefinition.binding)\n\nAny information provided in these elements on a Questionnaire Item overrides the information from the definition.", "short": "ElementDefinition - details for the item", "mapping": [ { "map": ".outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]", "identity": "rim" } ], "type": [ { "code": "uri" } ], "max": "1", "id": "Questionnaire.item.item.definition", "comment": "the URI refers to an ElementDefinition in either a [StructureDefinition](http://hl7.org/fhir/STU3/structuredefinition.html#) or a [DataElement](http://hl7.org/fhir/STU3/dataelement.html#), and always starts with the canonical URL for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id [Element.id](http://hl7.org/fhir/STU3/element-definitions.html#Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition. Note that [LOINC codes](http://hl7.org/fhir/STU3/loinc.html#dataelements) implicitly define DataElement resources.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.definition" } }, { "path": "Questionnaire.item.item.code", "requirements": "Allows linking of groups of questions to formal terminologies.", "min": 0, "definition": "A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).", "short": "Corresponding concept for this item in a terminology", "mapping": [ { "map": ".code", "identity": "rim" } ], "type": [ { "code": "Coding" } ], "mustSupport": true, "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireConcept" } ], "description": "Codes for questionnaires, groups and individual questions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-questions" } }, "max": "*", "id": "Questionnaire.item.item.code", "condition": [ "que-3" ], "comment": "The value may come from the ElementDefinition referred to by .definition.", "base": { "max": "*", "min": 0, "path": "Questionnaire.item.code" }, "isSummary": true }, { "path": "Questionnaire.item.item.prefix", "requirements": "Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used.", "min": 0, "definition": "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.", "short": "E.g. \"1(a)\", \"2.5.3\"", "mapping": [ { "map": "Not supported", "identity": "rim" } ], "type": [ { "code": "string" } ], "alias": [ "label" ], "max": "1", "id": "Questionnaire.item.item.prefix", "comment": "These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed.\n\nTypically these won't be used for \"display\" items, though such use is not prohibited.\n\nSystems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.prefix" } }, { "path": "Questionnaire.item.item.text", "min": 0, "definition": "The name of a section, the text of a question or text content for a display item.", "short": "Primary text for the item", "mapping": [ { "map": ".text", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "Questionnaire.item.item.text", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.text" }, "isSummary": true }, { "path": "Questionnaire.item.item.type", "requirements": "Defines the format in which the user is to be prompted for the answer.", "min": 1, "definition": "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, coded choice, etc.).", "short": "group | display | boolean | decimal | integer | date | dateTime +", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "code" } ], "mustSupport": true, "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireItemType" } ], "description": "Distinguishes groups from questions and display text and indicates data type for questions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/item-type" } }, "max": "1", "id": "Questionnaire.item.item.type", "comment": "Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.", "base": { "max": "1", "min": 1, "path": "Questionnaire.item.type" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" }, { "key": "que-7", "human": "enableWhen must contain either a 'answer' or a 'hasAnswer' element", "xpath": "count(f:*[starts-with(local-name(.), 'answer')]|self::f:hasAnswer) = 1", "source": "Questionnaire.item.enableWhen", "severity": "error", "expression": "hasAnswer.exists() xor answer.exists()" } ], "path": "Questionnaire.item.item.enableWhen", "requirements": "Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions.", "min": 0, "definition": "A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.", "isModifier": true, "short": "Only allow data when", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "BackboneElement" } ], "mustSupport": true, "max": "*", "id": "Questionnaire.item.item.enableWhen", "comment": "If multiple repetitions of this extension are present, the item should be enabled when the condition for *any* of the repetitions is true. I.e. treat \"enableWhen\"s as being joined by an \"or\" clause.\n\nThis element is a modifier because if enableWhen is present for an item, \"required\" is ignored unless one of the enableWhen conditions is met.", "base": { "max": "*", "min": 0, "path": "Questionnaire.item.enableWhen" }, "isSummary": true }, { "path": "Questionnaire.item.item.enableWhen.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Questionnaire.item.item.enableWhen.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "Questionnaire.item.item.enableWhen.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Questionnaire.item.item.enableWhen.extension", "comment": "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.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Questionnaire.item.item.enableWhen.modifierExtension", "min": 0, "definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "Questionnaire.item.item.enableWhen.modifierExtension", "comment": "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.", "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "isSummary": true }, { "path": "Questionnaire.item.item.enableWhen.question", "min": 1, "definition": "The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.", "short": "Question that determines whether item is enabled", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "Questionnaire.item.item.enableWhen.question", "comment": "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.", "base": { "max": "1", "min": 1, "path": "Questionnaire.item.enableWhen.question" } }, { "path": "Questionnaire.item.item.enableWhen.hasAnswer", "min": 0, "definition": "An indication that this item should be enabled only if the specified question is answered (hasAnswer=true) or not answered (hasAnswer=false).", "short": "Enable when answered or not", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "boolean" } ], "max": "1", "id": "Questionnaire.item.item.enableWhen.hasAnswer", "condition": [ "que-7" ], "comment": "If answered=false and answer values are also provided, then they are treated as \"or\". I.e. \"Enable if the question is unanswered or the answer is one of the specified values\". If answered=true and answers are present, one of the specified answers must be met. (So there's little reason to specify answered=true if answers are present.).", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.enableWhen.hasAnswer" } }, { "path": "Questionnaire.item.item.enableWhen.answer[x]", "min": 0, "definition": "An answer that the referenced question must match in order for the item to be enabled.", "short": "Value question must have", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "boolean" }, { "code": "decimal" }, { "code": "integer" }, { "code": "date" }, { "code": "dateTime" }, { "code": "time" }, { "code": "string" }, { "code": "uri" }, { "code": "Attachment" }, { "code": "Coding" }, { "code": "Quantity" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireQuestionOption2" } ], "description": "Allowed values to answer questions.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers" } }, "max": "1", "id": "Questionnaire.item.item.enableWhen.answer[x]", "condition": [ "que-7" ], "comment": "Multiple answers are treated as \"or\". E.g. Enable if question 1 = A, C or E. \n\nComponents not specified in the answer do not need to match. For example, if enableWhen specifies code + system for a Coding, it is ok if the answer has a \"display\" element. I.e. treat the answer as a 'pattern'.\n\nThe dataType of this element must be the same as the data type of the question being referenced.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.enableWhen.answer[x]" } }, { "path": "Questionnaire.item.item.required", "min": 0, "definition": "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.", "short": "Whether the item must be included in data results", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "mustSupport": true, "max": "1", "id": "Questionnaire.item.item.required", "condition": [ "que-6" ], "comment": "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.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.required" } }, { "path": "Questionnaire.item.item.repeats", "requirements": "Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.", "min": 0, "definition": "An indication, if true, that the item may occur multiple times in the response, collecting multiple answers answers for questions or multiple sets of answers for groups.", "short": "Whether the item may repeat", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "mustSupport": true, "max": "1", "id": "Questionnaire.item.item.repeats", "condition": [ "que-6" ], "comment": "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 or to simply list each of the answers beneath the question. (Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.). The value may come from the ElementDefinition referred to by .definition.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.repeats" } }, { "path": "Questionnaire.item.item.readOnly", "requirements": "Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc.", "min": 0, "definition": "An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.", "short": "Don't allow human editing", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "boolean" } ], "max": "1", "id": "Questionnaire.item.item.readOnly", "condition": [ "que-9" ], "comment": "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.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.readOnly" } }, { "path": "Questionnaire.item.item.maxLength", "min": 0, "definition": "The maximum number of characters that are permitted in the answer to be considered a \"valid\" QuestionnaireResponse.", "short": "No more than this many characters", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "integer" } ], "max": "1", "id": "Questionnaire.item.item.maxLength", "condition": [ "que-10" ], "comment": "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.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.maxLength" } }, { "path": "Questionnaire.item.item.options", "min": 0, "definition": "A reference to a value set containing a list of codes representing permitted answers for a \"choice\" or \"open-choice\" question.", "short": "Valueset containing permitted answers", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ValueSet" } ], "mustSupport": true, "max": "1", "id": "Questionnaire.item.item.options", "condition": [ "que-4", "que-5" ], "comment": "LOINC defines many useful value sets for questionnaire responses. See [LOINC Answer Lists](http://hl7.org/fhir/STU3/loinc.html#alist). The value may come from the ElementDefinition referred to by .definition.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.options" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" } ], "path": "Questionnaire.item.item.option", "min": 0, "definition": "One of the permitted answers for a \"choice\" or \"open-choice\" question.", "short": "Permitted answer", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "BackboneElement" } ], "max": "*", "id": "Questionnaire.item.item.option", "condition": [ "que-4", "que-5" ], "comment": "This element can be used when the value set machinery of options is deemed too cumbersome or when there's a need to capture options that are not codes.", "base": { "max": "*", "min": 0, "path": "Questionnaire.item.option" } }, { "path": "Questionnaire.item.item.option.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Questionnaire.item.item.option.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "Questionnaire.item.item.option.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Questionnaire.item.item.option.extension", "comment": "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.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Questionnaire.item.item.option.modifierExtension", "min": 0, "definition": "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 that contains it. Usually modifier elements provide negation or qualification. In order 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.", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "Questionnaire.item.item.option.modifierExtension", "comment": "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.", "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "isSummary": true }, { "path": "Questionnaire.item.item.option.value[x]", "min": 1, "definition": "A potential answer that's allowed as the answer to this question.", "short": "Answer value", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "integer" }, { "code": "date" }, { "code": "time" }, { "code": "string" }, { "code": "Coding" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireQuestionOption" } ], "description": "Allowed values to answer questions.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers" } }, "max": "1", "id": "Questionnaire.item.item.option.value[x]", "comment": "The data type of the value must agree with the item.type.", "base": { "max": "1", "min": 1, "path": "Questionnaire.item.option.value[x]" } }, { "path": "Questionnaire.item.item.initial[x]", "requirements": "In some workflows, having defaults saves time.", "min": 0, "definition": "The value that should be defaulted when initially rendering the questionnaire for user input.", "short": "Default value when item is first rendered", "mapping": [ { "map": "N/A - MIF rather than RIM level", "identity": "rim" } ], "type": [ { "code": "boolean" }, { "code": "decimal" }, { "code": "integer" }, { "code": "date" }, { "code": "dateTime" }, { "code": "time" }, { "code": "string" }, { "code": "uri" }, { "code": "Attachment" }, { "code": "Coding" }, { "code": "Quantity" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuestionnaireQuestionOption2" } ], "description": "Allowed values to answer questions.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers" } }, "max": "1", "id": "Questionnaire.item.item.initial[x]", "condition": [ "que-8" ], "comment": "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 default values can influence results.\n\nThe data type of initial[x] must agree with the item.type.", "base": { "max": "1", "min": 0, "path": "Questionnaire.item.initial[x]" } }, { "path": "Questionnaire.item.item.item", "requirements": "Reports can consist of complex nested groups.", "min": 0, "definition": "Text, questions and other groups to be nested beneath a question or group.", "short": "Nested questionnaire items", "mapping": [ { "map": ".outboundRelationship[typeCode=COMP].target", "identity": "rim" } ], "contentReference": "#Questionnaire.item", "mustSupport": false, "max": "*", "id": "Questionnaire.item.item.item", "condition": [ "que-1" ], "comment": "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.", "base": { "max": "*", "min": 0, "path": "Questionnaire.item.item" } } ] }, "status": "draft", "id": "6b6a6d14-13a6-4e42-a85f-b99bdc28f7b1", "kind": "resource", "url": "http://hl7.org/fhir/us/hai/StructureDefinition/hai-single-person-report-questionnaire", "version": "1.1.0", "differential": { "element": [ { "id": "Questionnaire", "path": "Questionnaire", "short": "Healthcare Associated Infection Single-Person Report Questionnaire", "definition": "This profile represents a Healthcare Associated Infection Singe-Person Report form as a FHIR Questionnaire.", "mustSupport": true }, { "id": "Questionnaire.meta", "min": 1, "path": "Questionnaire.meta", "mustSupport": true }, { "id": "Questionnaire.meta.profile", "max": "1", "min": 1, "path": "Questionnaire.meta.profile", "short": "A reference to this profile (to which the instance claims to conform).", "definition": "A reference to this profile (to which the instance claims to conform).", "patternUri": "http://hl7.org/fhir/us/hai/StructureDefinition/hai-single-person-report-questionnaire", "mustSupport": true }, { "id": "Questionnaire.language", "min": 1, "path": "Questionnaire.language", "mustSupport": true, "patternCode": "en-US" }, { "id": "Questionnaire.text", "path": "Questionnaire.text", "mustSupport": true }, { "id": "Questionnaire.identifier", "max": "1", "min": 1, "path": "Questionnaire.identifier", "short": "Globally unique identifier for the instance", "definition": "Globally unique identifier for the instance.", "mustSupport": true }, { "id": "Questionnaire.title", "min": 1, "path": "Questionnaire.title", "mustSupport": true }, { "id": "Questionnaire.date", "min": 1, "path": "Questionnaire.date", "mustSupport": true }, { "id": "Questionnaire.publisher", "min": 1, "path": "Questionnaire.publisher", "mustSupport": true }, { "id": "Questionnaire.description", "min": 1, "path": "Questionnaire.description", "mustSupport": true }, { "id": "Questionnaire.jurisdiction", "max": "1", "min": 1, "path": "Questionnaire.jurisdiction", "mustSupport": true, "patternCodeableConcept": { "coding": [ { "code": "US", "system": "urn:iso:std:iso:3166" } ] } }, { "id": "Questionnaire.code", "max": "1", "min": 1, "path": "Questionnaire.code", "short": "Code for Healthcare Associated Infection Report", "definition": "LOINC code 51897-7 to indicate that this is a Healthcare Associated Infection Report", "mustSupport": true, "patternCoding": { "code": "51897-7", "system": "http://loinc.org" } }, { "id": "Questionnaire.subjectType", "max": "1", "min": 1, "path": "Questionnaire.subjectType", "short": "Patient Resource (US Core Patient) is the subject of the related QuestionnaireResponse", "fixedCode": "Patient", "definition": "Patient Resource (US Core Patient) is the subject of the related QuestionnaireResponse", "mustSupport": true }, { "id": "Questionnaire.item", "min": 1, "path": "Questionnaire.item", "mustSupport": true }, { "id": "Questionnaire.item.extension", "path": "Questionnaire.item.extension", "slicing": { "rules": "open", "discriminator": [ { "path": "url", "type": "value" } ] } }, { "id": "Questionnaire.item.extension:extensionQuestionnaireAllowedProfile", "max": "1", "path": "Questionnaire.item.extension", "type": [ { "code": "Extension", "profile": "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile" } ], "sliceName": "extensionQuestionnaireAllowedProfile", "mustSupport": true }, { "id": "Questionnaire.item.linkId", "path": "Questionnaire.item.linkId", "mustSupport": true }, { "id": "Questionnaire.item.code", "path": "Questionnaire.item.code", "mustSupport": true }, { "id": "Questionnaire.item.type", "path": "Questionnaire.item.type", "mustSupport": true }, { "id": "Questionnaire.item.enableWhen", "path": "Questionnaire.item.enableWhen", "mustSupport": true }, { "id": "Questionnaire.item.required", "path": "Questionnaire.item.required", "mustSupport": true }, { "id": "Questionnaire.item.repeats", "path": "Questionnaire.item.repeats", "mustSupport": true }, { "id": "Questionnaire.item.options", "path": "Questionnaire.item.options", "mustSupport": true }, { "id": "Questionnaire.item.item", "path": "Questionnaire.item.item", "mustSupport": true }, { "id": "Questionnaire.item.item.extension", "path": "Questionnaire.item.item.extension", "slicing": { "rules": "open", "discriminator": [ { "path": "url", "type": "value" } ] } }, { "id": "Questionnaire.item.item.extension:extensionQuestionnaireAllowedProfile", "max": "1", "path": "Questionnaire.item.item.extension", "type": [ { "code": "Extension", "profile": "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile" } ], "sliceName": "extensionQuestionnaireAllowedProfile", "mustSupport": true }, { "id": "Questionnaire.item.item.extension:extensionQuestionnaire-unit", "max": "1", "path": "Questionnaire.item.item.extension", "type": [ { "code": "Extension", "profile": "http://hl7.org/fhir/StructureDefinition/questionnaire-unit" } ], "sliceName": "extensionQuestionnaire-unit", "mustSupport": true }, { "id": "Questionnaire.item.item.linkId", "path": "Questionnaire.item.item.linkId", "mustSupport": true }, { "id": "Questionnaire.item.item.code", "path": "Questionnaire.item.item.code", "mustSupport": true }, { "id": "Questionnaire.item.item.type", "path": "Questionnaire.item.item.type", "mustSupport": true }, { "id": "Questionnaire.item.item.enableWhen", "path": "Questionnaire.item.item.enableWhen", "mustSupport": true }, { "id": "Questionnaire.item.item.required", "path": "Questionnaire.item.item.required", "mustSupport": true }, { "id": "Questionnaire.item.item.repeats", "path": "Questionnaire.item.item.repeats", "mustSupport": true }, { "id": "Questionnaire.item.item.options", "path": "Questionnaire.item.item.options", "mustSupport": true }, { "id": "Questionnaire.item.item.item", "path": "Questionnaire.item.item.item", "mustSupport": false } ] }, "contact": [ { "name": "Sarah Gaunt", "telecom": [ { "use": "work", "value": "+6 141-029-2506", "system": "phone" }, { "use": "work", "value": "sarah.gaunt@lantanagroup.com", "system": "email" } ] } ], "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Questionnaire" }