Foundation
This
page
is
part
of
the
FHIR
Specification
(v1.0.2:
DSTU
(v3.0.2:
STU
2).
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
R3
R2
| FHIR Infrastructure Work Group | Maturity Level : N/A | Ballot Status : Informative | Compartments : Not linked to any defined compartments |
StructureDefinition for questionnaire
{
"resourceType": "StructureDefinition",
"id": "Questionnaire",
"meta": {
"lastUpdated": "2015-10-24T07:41:03.495+11:00"
"lastUpdated": "2019-10-24T11:53:00+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
"valueInteger": 3
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/Questionnaire",
"name": "Questionnaire",
"status": "draft",
"publisher": "Health Level Seven International (Patient Care)",
"date": "2019-10-24T11:53:00+11:00",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"telecom": [
{
"system": "other",
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}
]
}
],
"date": "2015-10-24T07:41:03+11:00",
"description": "Base StructureDefinition for Questionnaire Resource",
"requirements": "To support structured, hierarchical registration of data gathered using digital forms and other questionnaires.",
"fhirVersion": "1.0.2",
"purpose": "To support structured, hierarchical registration of data gathered using digital forms and other questionnaires. Questionnaires provide greater control over presentation and allow capture of data in a domain-independent way (i.e. capturing information that would otherwise require multiple distinct types of resources).",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
}
],
"kind": "resource",
"abstract": false,
"base": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"type": "Questionnaire",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString": "MetadataResource"
}
]
},
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "Questionnaire",
"path": "Questionnaire",
"short": "A structured set of questions",
"definition": "A structured set of questions intended to guide the collection of answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.",
"definition": "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.",
"alias": [
"Form",
"CRF",
"Survey"
],
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "que-3",
"key": "dom-2",
"severity": "error",
"human": "If root group must be \"required\"",
"xpath": "f:group/f:required/@value=true()"
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
},
{
"key": "que-2",
"severity": "error",
"human": "The link ids for groups and questions must be unique within the questionnaire",
"expression": "descendants().linkId.isDistinct()",
"xpath": "count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "Observation[moodCode=DEF]"
},
{
"identity": "w5",
"map": "infrastructure.information"
}
]
},
{
"id": "Questionnaire.id",
"path": "Questionnaire.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "Questionnaire.meta",
"path": "Questionnaire.meta",
"short": "Metadata about the resource",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "Questionnaire.implicitRules",
"path": "Questionnaire.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"comments": "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 as much as possible.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "Questionnaire.language",
"path": "Questionnaire.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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).",
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"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
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "Questionnaire.text",
"path": "Questionnaire.text",
"short": "Text summary of the resource, for human interpretation",
"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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "Questionnaire.contained",
"path": "Questionnaire.contained",
"short": "Contained, inline Resources",
"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.",
"comments": "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.",
"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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Questionnaire.extension",
"path": "Questionnaire.extension",
"short": "Additional Content defined by implementations",
"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.",
"comments": "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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Questionnaire.modifierExtension",
"path": "Questionnaire.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"comments": "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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Questionnaire.url",
"path": "Questionnaire.url",
"short": "Logical URI to reference this questionnaire (globally unique)",
"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](resource.html#versions).",
"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.",
"requirements": "… This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier[scope=BUSN;reliability=ISS]"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Questionnaire.identifier",
"path": "Questionnaire.identifier",
"short": "External identifiers for this questionnaire",
"definition": "This records identifiers associated with this question set that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"short": "Additional identifier for the questionnaire",
"definition": "A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"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.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id[use=BUS]"
"map": ".identifier"
},
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Questionnaire.version",
"path": "Questionnaire.version",
"short": "Logical identifier for this version of Questionnaire",
"definition": "The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated.",
"requirements": "In some cases, separate resource instances might be created for each version (if an older version can be maintained once a new version exists).",
"alias": [
"N/A - MIF rather than RIM level"
],
"short": "Business version of the questionnaire",
"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.",
"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].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id[use=VER]"
"map": "N/A (to add?)"
},
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "Questionnaire.name",
"path": "Questionnaire.name",
"short": "Name for this questionnaire (computer friendly)",
"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.",
"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.",
"requirements": "Support human navigation and code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Questionnaire.title",
"path": "Questionnaire.title",
"short": "Name for this questionnaire (human friendly)",
"definition": "A short, descriptive, user-friendly title for the questionnaire.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".title"
}
]
},
{
"id": "Questionnaire.status",
"path": "Questionnaire.status",
"short": "draft | published | retired",
"definition": "The lifecycle status of the questionnaire as a whole.",
"short": "draft | active | retired | unknown",
"definition": "The status of this questionnaire. Enables tracking the life-cycle of the content.",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "Lifecycle status of the questionnaire.",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-status"
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)"
"map": ".status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Questionnaire.experimental",
"path": "Questionnaire.experimental",
"short": "For testing purposes, not real usage",
"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.",
"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.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Questionnaire.date",
"path": "Questionnaire.date",
"short": "Date this version was authored",
"definition": "The date that this questionnaire was last changed.",
"short": "Date this was last changed",
"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.",
"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.",
"alias": [
"Date created",
"Date published",
"Date issued",
"Date updated"
"Revision Date"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "Questionnaire.publisher",
"path": "Questionnaire.publisher",
"short": "Organization/individual who designed the questionnaire",
"definition": "Organization or person responsible for developing and maintaining the questionnaire.",
"requirements": "Conveys responsibility for the questions and their organization and also helps evaluate the questionnaire's \"authority\".",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the individual or organization that published the questionnaire.",
"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.",
"requirements": "Helps establish the \"authority/credibility\" of the questionnaire. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"path": "Questionnaire.telecom",
"short": "Contact information of the publisher",
"id": "Questionnaire.description",
"path": "Questionnaire.description",
"short": "Natural language description of the questionnaire",
"definition": "A free text natural language description of the questionnaire from a consumer's perspective.",
"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).",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"id": "Questionnaire.purpose",
"path": "Questionnaire.purpose",
"short": "Why this questionnaire is defined",
"definition": "Explaination of why this questionnaire is needed and why it has been designed as it has.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "rim",
"map": ".reasonCode.text"
},
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "Questionnaire.approvalDate",
"path": "Questionnaire.approvalDate",
"short": "When the questionnaire was approved by publisher",
"definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment": "The 'date' element may be more recent than the approval date because of minor changes / editorial corrections.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Questionnaire.lastReviewDate",
"path": "Questionnaire.lastReviewDate",
"short": "When the questionnaire was last reviewed",
"definition": "The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.",
"comment": "If specified, this is usually after the approval date.",
"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,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Questionnaire.effectivePeriod",
"path": "Questionnaire.effectivePeriod",
"short": "When the questionnaire is expected to be used",
"definition": "The period during which the questionnaire content was or is planned to be in active use.",
"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.",
"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,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Questionnaire.useContext",
"path": "Questionnaire.useContext",
"short": "Context the content is intended to support",
"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.",
"comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "Questionnaire.jurisdiction",
"path": "Questionnaire.jurisdiction",
"short": "Intended jurisdiction for questionnaire (if applicable)",
"definition": "A legal or geographic region in which the questionnaire is intended to be used.",
"comment": "It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "Questionnaire.contact",
"path": "Questionnaire.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
"code": "ContactDetail"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role.telecom"
"map": ".participation[typeCode=CALLBCK].role"
}
]
},
{
"id": "Questionnaire.copyright",
"path": "Questionnaire.copyright",
"short": "Use and/or publishing restrictions",
"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.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Questionnaire.code",
"path": "Questionnaire.code",
"short": "Concept that represents the overall questionnaire",
"definition": "An identifier for this question or group of questions in a particular terminology such as LOINC.",
"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": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuestionnaireConcept"
}
],
"strength": "example",
"description": "Codes for questionnaires, groups and individual questions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-questions"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "Questionnaire.subjectType",
"path": "Questionnaire.subjectType",
"short": "Resource that can be subject of QuestionnaireResponse",
"definition": "Identifies the types of subjects that can be the subject of the questionnaire.",
"comments": "If none are specified, then the subject is unlimited.",
"definition": "The types of subjects that can be the subject of responses created for the questionnaire.",
"comment": "If none are specified, then the subject is unlimited.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResourceType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "One of the resource types defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-types"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Group"
}
],
"path": "Questionnaire.group",
"name": "group",
"short": "Grouped questions",
"definition": "A collection of related questions (or further groupings of questions).",
"comments": "The Questionnaire itself has one \"root\" group with the actual contents of the Questionnaire. Information on this root group applies to the questionnaire as a whole.",
"requirements": "Need to be able to logically group answers to grouped questions.",
"alias": [
"Section"
],
"min": 1,
"max": "1",
"id": "Questionnaire.item",
"path": "Questionnaire.item",
"short": "Questions and sections within the Questionnaire",
"definition": "A particular question, question grouping or display text that is part of the questionnaire.",
"comment": "The content of the questionnaire is constructed from an ordered, hierarchical collection of items.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"que-3"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "que-9",
"severity": "error",
"human": "Read-only can't be specified for \"display\" items",
"expression": "type!='display' or readOnly.empty()",
"xpath": "not(f:type/@value='display' and f:readOnly)"
},
{
"key": "que-8",
"severity": "error",
"human": "Default values can't be specified for groups or display items",
"expression": "(type!='group' and type!='display') or initial.empty()",
"xpath": "not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')])"
},
{
"key": "que-6",
"severity": "error",
"human": "Required and repeat aren't permitted for display items",
"expression": "type!='display' or (required.empty() and repeats.empty())",
"xpath": "not(f:type/@value='display' and (f:required or f:repeats))"
},
{
"key": "que-5",
"severity": "error",
"human": "Only 'choice' items can have options",
"expression": "(type ='choice' or type = 'open-choice') or (options.empty() and option.empty())",
"xpath": "f:type/@value=('choice','open-choice') or not(f:option or f:options)"
},
{
"key": "que-4",
"severity": "error",
"human": "A question cannot have both option and options",
"expression": "option.empty() or options.empty()",
"xpath": "not(f:options and f:option)"
},
{
"key": "que-3",
"severity": "error",
"human": "Display items cannot have a \"code\" asserted",
"expression": "type!='display' or code.empty()",
"xpath": "not(f:type/@value='display' and f:code)"
},
{
"key": "que-10",
"severity": "error",
"human": "Maximum length can only be declared for simple question types",
"expression": "(type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty()",
"xpath": "f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url') or not(f:maxLength)"
},
{
"key": "que-1",
"severity": "error",
"human": "Groups may either contain questions or groups but not both",
"xpath": "not(exists(f:group) and exists(f:question))"
"human": "Group items must have nested items, display items cannot have nested items",
"expression": "(type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())",
"xpath": "not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item))"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]"
}
]
},
{
"path": "Questionnaire.group.id",
"id": "Questionnaire.item.id",
"path": "Questionnaire.item.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Questionnaire.group.extension",
"id": "Questionnaire.item.extension",
"path": "Questionnaire.item.extension",
"short": "Additional Content defined by implementations",
"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.",
"comments": "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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Questionnaire.group.modifierExtension",
"id": "Questionnaire.item.modifierExtension",
"path": "Questionnaire.item.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"comments": "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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Questionnaire.group.linkId",
"short": "To link questionnaire with questionnaire response",
"definition": "An identifier that is unique within the Questionnaire allowing linkage to the equivalent group in a QuestionnaireResponse resource.",
"comments": "May be omitted if there is no expectation to link answers back to a questionnaire. 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.",
"requirements": "[[[QuestionnaireResponse]]] does not require omitted groups to be included and may have some groups that repeat, so linkage based on position alone is not sufficient.",
"min": 0,
"id": "Questionnaire.item.linkId",
"path": "Questionnaire.item.linkId",
"short": "Unique id for item in questionnaire",
"definition": "An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.",
"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.",
"requirements": "[QuestionnaireResponse](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,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Questionnaire.group.title",
"short": "Name to be displayed for group",
"definition": "The human-readable name for this section of the questionnaire.",
"comments": "The title of the \"root\" group is the title for the questionnaire.",
"requirements": "When including text for the questionnaire with the answers, sections may have a section header.",
"id": "Questionnaire.item.definition",
"path": "Questionnaire.item.definition",
"short": "ElementDefinition - details for the item",
"definition": "A reference to an [ElementDefinition](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.",
"comment": "the URI refers to an ElementDefinition in either a [StructureDefinition](structuredefinition.html#) or a [DataElement](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](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](loinc.html#dataelements) implicitly define DataElement resources.",
"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,
"max": "1",
"type": [
{
"code": "string"
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".title"
"map": ".outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]"
}
]
},
{
"path": "Questionnaire.group.concept",
"short": "Concept that represents this section in a questionnaire",
"definition": "Identifies a how this group of questions is known in a particular terminology such as LOINC.",
"comments": "The code(s) for the \"root\" group apply to the questionnaire as a whole.",
"requirements": "Allows linking of groups of questions (and complete Questionnaire resources) to formal terminologies.",
"id": "Questionnaire.item.code",
"path": "Questionnaire.item.code",
"short": "Corresponding concept for this item in a terminology",
"definition": "A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).",
"comment": "The value may come from the ElementDefinition referred to by .definition.",
"requirements": "Allows linking of groups of questions to formal terminologies.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"condition": [
"que-3"
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuestionnaireConcept"
}
],
"strength": "example",
"description": "Codes for groupings of questionnaire questions.",
"description": "Codes for questionnaires, groups and individual questions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-questions"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Questionnaire.group.text",
"short": "Additional text for the group",
"definition": "Additional text for the group, used for display purposes.",
"comments": "Common extensions are defined for more specialized types of display text.",
"requirements": "When including text for the questionnaire, each section may contain additional explanations are background text.",
"id": "Questionnaire.item.prefix",
"path": "Questionnaire.item.prefix",
"short": "E.g. \"1(a)\", \"2.5.3\"",
"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.",
"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.",
"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.",
"alias": [
"label"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
"map": "Not supported"
}
]
},
{
"path": "Questionnaire.group.required",
"short": "Whether the group must be included in data results",
"definition": "If true, indicates that the group must be present and have required questions within it answered. If false, the group may be skipped when answering the questionnaire.",
"id": "Questionnaire.item.text",
"path": "Questionnaire.item.text",
"short": "Primary text for the item",
"definition": "The name of a section, the text of a question or text content for a display item.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
"code": "string"
}
],
"defaultValueBoolean": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
"map": ".text"
}
]
},
{
"path": "Questionnaire.group.repeats",
"short": "Whether the group may repeat",
"definition": "Whether the group may occur multiple times in the instance, containing multiple sets of answers.",
"requirements": "Groups may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.",
"min": 0,
"id": "Questionnaire.item.type",
"path": "Questionnaire.item.type",
"short": "group | display | boolean | decimal | integer | date | dateTime +",
"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.).",
"comment": "Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.",
"requirements": "Defines the format in which the user is to be prompted for the answer.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
"code": "code"
}
],
"defaultValueBoolean": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuestionnaireItemType"
}
],
"strength": "required",
"description": "Distinguishes groups from questions and display text and indicates data type for questions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/item-type"
}
]
},
{
"path": "Questionnaire.group.group",
"short": "Nested questionnaire group",
"definition": "A sub-group within a group. The ordering of groups within this group is relevant.",
"requirements": "Reports can consist of complex nested groups.",
"min": 0,
"max": "*",
"nameReference": "group",
"condition": [
"que-1"
],
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Question"
}
],
"path": "Questionnaire.group.question",
"short": "Questions in this group",
"definition": "Set of questions within this group. The order of questions within the group is relevant.",
"requirements": "Must register answers to questions.",
"alias": [
"Responses",
"Contents"
],
"id": "Questionnaire.item.enableWhen",
"path": "Questionnaire.item.enableWhen",
"short": "Only allow data when",
"definition": "A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.",
"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.",
"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,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"que-1"
],
"constraint": [
{
"key": "que-4",
"key": "ele-1",
"severity": "error",
"human": "A question must use either option or options, not both",
"xpath": "not(f:options and f:option)"
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "que-7",
"severity": "error",
"human": "enableWhen must contain either a 'answer' or a 'hasAnswer' element",
"expression": "hasAnswer.exists() xor answer.exists()",
"xpath": "count(f:*[starts-with(local-name(.), 'answer')]|self::f:hasAnswer) = 1"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN or DEF]"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.id",
"id": "Questionnaire.item.enableWhen.id",
"path": "Questionnaire.item.enableWhen.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Questionnaire.group.question.extension",
"id": "Questionnaire.item.enableWhen.extension",
"path": "Questionnaire.item.enableWhen.extension",
"short": "Additional Content defined by implementations",
"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.",
"comments": "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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Questionnaire.group.question.modifierExtension",
"id": "Questionnaire.item.enableWhen.modifierExtension",
"path": "Questionnaire.item.enableWhen.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"comments": "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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Questionnaire.group.question.linkId",
"short": "To link questionnaire with questionnaire response",
"definition": "An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a [[[QuestionnaireResponse]]] resource.",
"comments": "May be omitted if there is no expectation to link answers back to a questionnaire. 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.",
"requirements": "[[[QuestionnaireResponse]]] does not require omitted groups to be included and may have some groups that repeat, so linkage based on position alone is not sufficient.",
"min": 0,
"id": "Questionnaire.item.enableWhen.question",
"path": "Questionnaire.item.enableWhen.question",
"short": "Question that determines whether item is enabled",
"definition": "The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.concept",
"short": "Concept that represents this question on a questionnaire",
"definition": "Identifies a how this question is known in a particular terminology such as LOINC.",
"requirements": "Allows linking of questions (and their answers) to formal terminologies.",
"id": "Questionnaire.item.enableWhen.hasAnswer",
"path": "Questionnaire.item.enableWhen.hasAnswer",
"short": "Enable when answered or not",
"definition": "An indication that this item should be enabled only if the specified question is answered (hasAnswer=true) or not answered (hasAnswer=false).",
"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.).",
"min": 0,
"max": "*",
"max": "1",
"type": [
{
"code": "boolean"
}
],
"condition": [
"que-7"
],
"mapping": [
{
"identity": "rim",
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"id": "Questionnaire.item.enableWhen.answer[x]",
"path": "Questionnaire.item.enableWhen.answer[x]",
"short": "Value question must have",
"definition": "An answer that the referenced question must match in order for the item to be enabled.",
"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.",
"min": 0,
"max": "1",
"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"
}
],
"condition": [
"que-7"
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuestionnaireQuestionOption2"
}
],
"strength": "example",
"description": "Codes corresponding to individual questions.",
"description": "Allowed values to answer questions.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-questions"
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.text",
"short": "Text of the question as it is shown to the user",
"definition": "The actual question as shown to the user to prompt them for an answer.",
"comments": "Common extensions are defined for more specialized types of display text.",
"requirements": "When including text for the questionnaire, each question may contain its actual question display text.",
"alias": [
"Question"
],
"id": "Questionnaire.item.required",
"path": "Questionnaire.item.required",
"short": "Whether the item must be included in data results",
"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.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
"code": "boolean"
}
],
"defaultValueBoolean": false,
"condition": [
"que-6"
],
"mapping": [
{
"identity": "rim",
"map": ".code.display"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.type",
"short": "boolean | decimal | integer | date | dateTime +",
"definition": "The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expected.",
"comments": "Additional constraints on the type of answer can be conveyed by extensions.",
"requirements": "Defines the format in which the user is to be prompted for the answer.",
"id": "Questionnaire.item.repeats",
"path": "Questionnaire.item.repeats",
"short": "Whether the item may repeat",
"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.",
"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.",
"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,
"max": "1",
"type": [
{
"code": "code"
"code": "boolean"
}
],
"binding": {
"strength": "required",
"description": "The expected format of an answer.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/answer-format"
}
},
"defaultValueBoolean": false,
"condition": [
"que-6"
],
"mapping": [
{
"identity": "rim",
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.required",
"short": "Whether the question must be answered in data results",
"definition": "If true, indicates that the question must be answered and have required groups within it also present. If false, the question and any contained groups may be skipped when answering the questionnaire.",
"id": "Questionnaire.item.readOnly",
"path": "Questionnaire.item.readOnly",
"short": "Don't allow human editing",
"definition": "An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.",
"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.",
"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,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"condition": [
"que-9"
],
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.repeats",
"short": "Whether the question can have multiple answers",
"definition": "If true, the question may have more than one answer.",
"comments": "Whether the question itself will be displayed for each answer is a rendering choice typically based on whether there are nested groups.",
"requirements": "Used for \"check all that apply\" types of questions or \"list your top 3\", etc.",
"id": "Questionnaire.item.maxLength",
"path": "Questionnaire.item.maxLength",
"short": "No more than this many characters",
"definition": "The maximum number of characters that are permitted in the answer to be considered a \"valid\" QuestionnaireResponse.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
"code": "integer"
}
],
"defaultValueBoolean": false,
"condition": [
"que-10"
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.options",
"id": "Questionnaire.item.options",
"path": "Questionnaire.item.options",
"short": "Valueset containing permitted answers",
"definition": "Reference to a value set containing a list of codes representing permitted answers for the question.",
"comments": "LOINC defines many useful value sets for questionnaire response. See [LOINC Answer Lists](loinc.html#alist).",
"definition": "A reference to a value set containing a list of codes representing permitted answers for a \"choice\" or \"open-choice\" question.",
"comment": "LOINC defines many useful value sets for questionnaire responses. See [LOINC Answer Lists](loinc.html#alist). The value may come from the ElementDefinition referred to by .definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/ValueSet"
]
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
}
],
"condition": [
"que-4"
"que-4",
"que-5"
],
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer to capture value set"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.option",
"id": "Questionnaire.item.option",
"path": "Questionnaire.item.option",
"short": "Permitted answer",
"definition": "For a \"choice\" question, identifies one of the permitted answers for the question.",
"definition": "One of the permitted answers for a \"choice\" or \"open-choice\" question.",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"que-4",
"que-5"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"id": "Questionnaire.item.option.id",
"path": "Questionnaire.item.option.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Questionnaire.item.option.extension",
"path": "Questionnaire.item.option.extension",
"short": "Additional Content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Questionnaire.item.option.modifierExtension",
"path": "Questionnaire.item.option.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Questionnaire.item.option.value[x]",
"path": "Questionnaire.item.option.value[x]",
"short": "Answer value",
"definition": "A potential answer that's allowed as the answer to this question.",
"comment": "The data type of the value must agree with the item.type.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
},
{
"code": "date"
},
{
"code": "time"
},
{
"code": "string"
},
{
"code": "Coding"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuestionnaireQuestionOption"
}
],
"strength": "example",
"description": "Allowed values to answer questions.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"id": "Questionnaire.item.initial[x]",
"path": "Questionnaire.item.initial[x]",
"short": "Default value when item is first rendered",
"definition": "The value that should be defaulted when initially rendering the questionnaire for user input.",
"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.",
"requirements": "In some workflows, having defaults saves time.",
"min": 0,
"max": "1",
"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"
}
],
"condition": [
"que-4"
"que-8"
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuestionnaireQuestionOption2"
}
],
"strength": "example",
"description": "Allowed values to answer questions.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers"
}
},
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer to capture value set"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.group",
"short": "Nested questionnaire group",
"definition": "Nested group, containing nested question for this question. The order of groups within the question is relevant.",
"requirements": "It is useful to have \"sub-questions\", questions which normally appear when certain answers are given and which collect additional details.",
"id": "Questionnaire.item.item",
"path": "Questionnaire.item.item",
"short": "Nested questionnaire items",
"definition": "Text, questions and other groups to be nested beneath a question or group.",
"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.",
"requirements": "Reports can consist of complex nested groups.",
"min": 0,
"max": "*",
"nameReference": "group",
"contentReference": "#Questionnaire.item",
"condition": [
"que-1"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Questionnaire",
"path": "Questionnaire",
"short": "A structured set of questions",
"definition": "A structured set of questions intended to guide the collection of answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.",
"definition": "A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.",
"alias": [
"Form",
"CRF",
"Survey"
],
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "que-3",
"severity": "error",
"human": "If root group must be \"required\"",
"xpath": "f:group/f:required/@value=true()"
},
{
"key": "que-2",
"severity": "error",
"human": "The link ids for groups and questions must be unique within the questionnaire",
"expression": "descendants().linkId.isDistinct()",
"xpath": "count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Observation[moodCode=DEF]"
},
{
"identity": "w5",
"map": "infrastructure.information"
}
]
},
{
"id": "Questionnaire.url",
"path": "Questionnaire.url",
"short": "Logical URI to reference this questionnaire (globally unique)",
"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](resource.html#versions).",
"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.",
"requirements": "… This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier[scope=BUSN;reliability=ISS]"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Questionnaire.identifier",
"path": "Questionnaire.identifier",
"short": "External identifiers for this questionnaire",
"definition": "This records identifiers associated with this question set that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"short": "Additional identifier for the questionnaire",
"definition": "A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"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.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id[use=BUS]"
"map": ".identifier"
},
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Questionnaire.version",
"path": "Questionnaire.version",
"short": "Logical identifier for this version of Questionnaire",
"definition": "The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated.",
"requirements": "In some cases, separate resource instances might be created for each version (if an older version can be maintained once a new version exists).",
"alias": [
"N/A - MIF rather than RIM level"
],
"short": "Business version of the questionnaire",
"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.",
"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].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id[use=VER]"
"map": "N/A (to add?)"
},
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "Questionnaire.name",
"path": "Questionnaire.name",
"short": "Name for this questionnaire (computer friendly)",
"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.",
"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.",
"requirements": "Support human navigation and code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Questionnaire.title",
"path": "Questionnaire.title",
"short": "Name for this questionnaire (human friendly)",
"definition": "A short, descriptive, user-friendly title for the questionnaire.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".title"
}
]
},
{
"id": "Questionnaire.status",
"path": "Questionnaire.status",
"short": "draft | published | retired",
"definition": "The lifecycle status of the questionnaire as a whole.",
"short": "draft | active | retired | unknown",
"definition": "The status of this questionnaire. Enables tracking the life-cycle of the content.",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "Lifecycle status of the questionnaire.",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-status"
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)"
"map": ".status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Questionnaire.experimental",
"path": "Questionnaire.experimental",
"short": "For testing purposes, not real usage",
"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.",
"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.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Questionnaire.date",
"path": "Questionnaire.date",
"short": "Date this version was authored",
"definition": "The date that this questionnaire was last changed.",
"short": "Date this was last changed",
"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.",
"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.",
"alias": [
"Date created",
"Date published",
"Date issued",
"Date updated"
"Revision Date"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "Questionnaire.publisher",
"path": "Questionnaire.publisher",
"short": "Organization/individual who designed the questionnaire",
"definition": "Organization or person responsible for developing and maintaining the questionnaire.",
"requirements": "Conveys responsibility for the questions and their organization and also helps evaluate the questionnaire's \"authority\".",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the individual or organization that published the questionnaire.",
"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.",
"requirements": "Helps establish the \"authority/credibility\" of the questionnaire. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"path": "Questionnaire.telecom",
"short": "Contact information of the publisher",
"id": "Questionnaire.description",
"path": "Questionnaire.description",
"short": "Natural language description of the questionnaire",
"definition": "A free text natural language description of the questionnaire from a consumer's perspective.",
"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).",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"id": "Questionnaire.purpose",
"path": "Questionnaire.purpose",
"short": "Why this questionnaire is defined",
"definition": "Explaination of why this questionnaire is needed and why it has been designed as it has.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "rim",
"map": ".reasonCode.text"
},
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "Questionnaire.approvalDate",
"path": "Questionnaire.approvalDate",
"short": "When the questionnaire was approved by publisher",
"definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment": "The 'date' element may be more recent than the approval date because of minor changes / editorial corrections.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"].act[classCode=CACT;moodCode=EVN;code=\"approval\"].effectiveTime"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Questionnaire.lastReviewDate",
"path": "Questionnaire.lastReviewDate",
"short": "When the questionnaire was last reviewed",
"definition": "The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.",
"comment": "If specified, this is usually after the approval date.",
"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,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"; subsetCode=\"RECENT\"].act[classCode=CACT;moodCode=EVN;code=\"review\"].effectiveTime"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Questionnaire.effectivePeriod",
"path": "Questionnaire.effectivePeriod",
"short": "When the questionnaire is expected to be used",
"definition": "The period during which the questionnaire content was or is planned to be in active use.",
"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.",
"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,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Questionnaire.useContext",
"path": "Questionnaire.useContext",
"short": "Context the content is intended to support",
"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.",
"comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "Questionnaire.jurisdiction",
"path": "Questionnaire.jurisdiction",
"short": "Intended jurisdiction for questionnaire (if applicable)",
"definition": "A legal or geographic region in which the questionnaire is intended to be used.",
"comment": "It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
}
]
},
{
"id": "Questionnaire.contact",
"path": "Questionnaire.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
"code": "ContactDetail"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role.telecom"
"map": ".participation[typeCode=CALLBCK].role"
}
]
},
{
"id": "Questionnaire.copyright",
"path": "Questionnaire.copyright",
"short": "Use and/or publishing restrictions",
"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.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (to add?)"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "Questionnaire.code",
"path": "Questionnaire.code",
"short": "Concept that represents the overall questionnaire",
"definition": "An identifier for this question or group of questions in a particular terminology such as LOINC.",
"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": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuestionnaireConcept"
}
],
"strength": "example",
"description": "Codes for questionnaires, groups and individual questions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-questions"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "Questionnaire.subjectType",
"path": "Questionnaire.subjectType",
"short": "Resource that can be subject of QuestionnaireResponse",
"definition": "Identifies the types of subjects that can be the subject of the questionnaire.",
"comments": "If none are specified, then the subject is unlimited.",
"definition": "The types of subjects that can be the subject of responses created for the questionnaire.",
"comment": "If none are specified, then the subject is unlimited.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResourceType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "One of the resource types defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-types"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Group"
}
],
"path": "Questionnaire.group",
"name": "group",
"short": "Grouped questions",
"definition": "A collection of related questions (or further groupings of questions).",
"comments": "The Questionnaire itself has one \"root\" group with the actual contents of the Questionnaire. Information on this root group applies to the questionnaire as a whole.",
"requirements": "Need to be able to logically group answers to grouped questions.",
"alias": [
"Section"
],
"min": 1,
"max": "1",
"id": "Questionnaire.item",
"path": "Questionnaire.item",
"short": "Questions and sections within the Questionnaire",
"definition": "A particular question, question grouping or display text that is part of the questionnaire.",
"comment": "The content of the questionnaire is constructed from an ordered, hierarchical collection of items.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"que-3"
],
"constraint": [
{
"key": "que-9",
"severity": "error",
"human": "Read-only can't be specified for \"display\" items",
"expression": "type!='display' or readOnly.empty()",
"xpath": "not(f:type/@value='display' and f:readOnly)"
},
{
"key": "que-8",
"severity": "error",
"human": "Default values can't be specified for groups or display items",
"expression": "(type!='group' and type!='display') or initial.empty()",
"xpath": "not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')])"
},
{
"key": "que-6",
"severity": "error",
"human": "Required and repeat aren't permitted for display items",
"expression": "type!='display' or (required.empty() and repeats.empty())",
"xpath": "not(f:type/@value='display' and (f:required or f:repeats))"
},
{
"key": "que-5",
"severity": "error",
"human": "Only 'choice' items can have options",
"expression": "(type ='choice' or type = 'open-choice') or (options.empty() and option.empty())",
"xpath": "f:type/@value=('choice','open-choice') or not(f:option or f:options)"
},
{
"key": "que-4",
"severity": "error",
"human": "A question cannot have both option and options",
"expression": "option.empty() or options.empty()",
"xpath": "not(f:options and f:option)"
},
{
"key": "que-3",
"severity": "error",
"human": "Display items cannot have a \"code\" asserted",
"expression": "type!='display' or code.empty()",
"xpath": "not(f:type/@value='display' and f:code)"
},
{
"key": "que-10",
"severity": "error",
"human": "Maximum length can only be declared for simple question types",
"expression": "(type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty()",
"xpath": "f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url') or not(f:maxLength)"
},
{
"key": "que-1",
"severity": "error",
"human": "Groups may either contain questions or groups but not both",
"xpath": "not(exists(f:group) and exists(f:question))"
"human": "Group items must have nested items, display items cannot have nested items",
"expression": "(type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())",
"xpath": "not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item))"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]"
}
]
},
{
"path": "Questionnaire.group.linkId",
"short": "To link questionnaire with questionnaire response",
"definition": "An identifier that is unique within the Questionnaire allowing linkage to the equivalent group in a QuestionnaireResponse resource.",
"comments": "May be omitted if there is no expectation to link answers back to a questionnaire. 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.",
"requirements": "[[[QuestionnaireResponse]]] does not require omitted groups to be included and may have some groups that repeat, so linkage based on position alone is not sufficient.",
"min": 0,
"id": "Questionnaire.item.linkId",
"path": "Questionnaire.item.linkId",
"short": "Unique id for item in questionnaire",
"definition": "An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.",
"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.",
"requirements": "[QuestionnaireResponse](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,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Questionnaire.group.title",
"short": "Name to be displayed for group",
"definition": "The human-readable name for this section of the questionnaire.",
"comments": "The title of the \"root\" group is the title for the questionnaire.",
"requirements": "When including text for the questionnaire with the answers, sections may have a section header.",
"id": "Questionnaire.item.definition",
"path": "Questionnaire.item.definition",
"short": "ElementDefinition - details for the item",
"definition": "A reference to an [ElementDefinition](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.",
"comment": "the URI refers to an ElementDefinition in either a [StructureDefinition](structuredefinition.html#) or a [DataElement](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](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](loinc.html#dataelements) implicitly define DataElement resources.",
"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,
"max": "1",
"type": [
{
"code": "string"
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".title"
"map": ".outboundRelationship[typeCode=INST].target[classCode=OBS, moodCode=DEF]"
}
]
},
{
"path": "Questionnaire.group.concept",
"short": "Concept that represents this section in a questionnaire",
"definition": "Identifies a how this group of questions is known in a particular terminology such as LOINC.",
"comments": "The code(s) for the \"root\" group apply to the questionnaire as a whole.",
"requirements": "Allows linking of groups of questions (and complete Questionnaire resources) to formal terminologies.",
"id": "Questionnaire.item.code",
"path": "Questionnaire.item.code",
"short": "Corresponding concept for this item in a terminology",
"definition": "A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).",
"comment": "The value may come from the ElementDefinition referred to by .definition.",
"requirements": "Allows linking of groups of questions to formal terminologies.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"condition": [
"que-3"
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuestionnaireConcept"
}
],
"strength": "example",
"description": "Codes for groupings of questionnaire questions.",
"description": "Codes for questionnaires, groups and individual questions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-questions"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Questionnaire.group.text",
"short": "Additional text for the group",
"definition": "Additional text for the group, used for display purposes.",
"comments": "Common extensions are defined for more specialized types of display text.",
"requirements": "When including text for the questionnaire, each section may contain additional explanations are background text.",
"id": "Questionnaire.item.prefix",
"path": "Questionnaire.item.prefix",
"short": "E.g. \"1(a)\", \"2.5.3\"",
"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.",
"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.",
"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.",
"alias": [
"label"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
"map": "Not supported"
}
]
},
{
"path": "Questionnaire.group.required",
"short": "Whether the group must be included in data results",
"definition": "If true, indicates that the group must be present and have required questions within it answered. If false, the group may be skipped when answering the questionnaire.",
"id": "Questionnaire.item.text",
"path": "Questionnaire.item.text",
"short": "Primary text for the item",
"definition": "The name of a section, the text of a question or text content for a display item.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
"code": "string"
}
],
"defaultValueBoolean": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
"map": ".text"
}
]
},
{
"path": "Questionnaire.group.repeats",
"short": "Whether the group may repeat",
"definition": "Whether the group may occur multiple times in the instance, containing multiple sets of answers.",
"requirements": "Groups may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.",
"min": 0,
"id": "Questionnaire.item.type",
"path": "Questionnaire.item.type",
"short": "group | display | boolean | decimal | integer | date | dateTime +",
"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.).",
"comment": "Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition.",
"requirements": "Defines the format in which the user is to be prompted for the answer.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
"code": "code"
}
],
"defaultValueBoolean": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuestionnaireItemType"
}
],
"strength": "required",
"description": "Distinguishes groups from questions and display text and indicates data type for questions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/item-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.group",
"short": "Nested questionnaire group",
"definition": "A sub-group within a group. The ordering of groups within this group is relevant.",
"requirements": "Reports can consist of complex nested groups.",
"id": "Questionnaire.item.enableWhen",
"path": "Questionnaire.item.enableWhen",
"short": "Only allow data when",
"definition": "A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.",
"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.",
"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,
"max": "*",
"nameReference": "group",
"condition": [
"que-1"
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "que-7",
"severity": "error",
"human": "enableWhen must contain either a 'answer' or a 'hasAnswer' element",
"expression": "hasAnswer.exists() xor answer.exists()",
"xpath": "count(f:*[starts-with(local-name(.), 'answer')]|self::f:hasAnswer) = 1"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Question"
}
],
"path": "Questionnaire.group.question",
"short": "Questions in this group",
"definition": "Set of questions within this group. The order of questions within the group is relevant.",
"requirements": "Must register answers to questions.",
"alias": [
"Responses",
"Contents"
],
"min": 0,
"max": "*",
"id": "Questionnaire.item.enableWhen.question",
"path": "Questionnaire.item.enableWhen.question",
"short": "Question that determines whether item is enabled",
"definition": "The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"que-1"
],
"constraint": [
{
"key": "que-4",
"severity": "error",
"human": "A question must use either option or options, not both",
"xpath": "not(f:options and f:option)"
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN or DEF]"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.linkId",
"short": "To link questionnaire with questionnaire response",
"definition": "An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a [[[QuestionnaireResponse]]] resource.",
"comments": "May be omitted if there is no expectation to link answers back to a questionnaire. 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.",
"requirements": "[[[QuestionnaireResponse]]] does not require omitted groups to be included and may have some groups that repeat, so linkage based on position alone is not sufficient.",
"id": "Questionnaire.item.enableWhen.hasAnswer",
"path": "Questionnaire.item.enableWhen.hasAnswer",
"short": "Enable when answered or not",
"definition": "An indication that this item should be enabled only if the specified question is answered (hasAnswer=true) or not answered (hasAnswer=false).",
"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.).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
"code": "boolean"
}
],
"condition": [
"que-7"
],
"mapping": [
{
"identity": "rim",
"map": ".id"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.concept",
"short": "Concept that represents this question on a questionnaire",
"definition": "Identifies a how this question is known in a particular terminology such as LOINC.",
"requirements": "Allows linking of questions (and their answers) to formal terminologies.",
"id": "Questionnaire.item.enableWhen.answer[x]",
"path": "Questionnaire.item.enableWhen.answer[x]",
"short": "Value question must have",
"definition": "An answer that the referenced question must match in order for the item to be enabled.",
"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.",
"min": 0,
"max": "*",
"max": "1",
"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"
}
],
"condition": [
"que-7"
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuestionnaireQuestionOption2"
}
],
"strength": "example",
"description": "Codes corresponding to individual questions.",
"description": "Allowed values to answer questions.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-questions"
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.text",
"short": "Text of the question as it is shown to the user",
"definition": "The actual question as shown to the user to prompt them for an answer.",
"comments": "Common extensions are defined for more specialized types of display text.",
"requirements": "When including text for the questionnaire, each question may contain its actual question display text.",
"alias": [
"Question"
],
"id": "Questionnaire.item.required",
"path": "Questionnaire.item.required",
"short": "Whether the item must be included in data results",
"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.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
"code": "boolean"
}
],
"defaultValueBoolean": false,
"condition": [
"que-6"
],
"mapping": [
{
"identity": "rim",
"map": ".code.display"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.type",
"short": "boolean | decimal | integer | date | dateTime +",
"definition": "The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expected.",
"comments": "Additional constraints on the type of answer can be conveyed by extensions.",
"requirements": "Defines the format in which the user is to be prompted for the answer.",
"id": "Questionnaire.item.repeats",
"path": "Questionnaire.item.repeats",
"short": "Whether the item may repeat",
"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.",
"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.",
"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,
"max": "1",
"type": [
{
"code": "code"
"code": "boolean"
}
],
"binding": {
"strength": "required",
"description": "The expected format of an answer.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/answer-format"
}
},
"defaultValueBoolean": false,
"condition": [
"que-6"
],
"mapping": [
{
"identity": "rim",
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.required",
"short": "Whether the question must be answered in data results",
"definition": "If true, indicates that the question must be answered and have required groups within it also present. If false, the question and any contained groups may be skipped when answering the questionnaire.",
"id": "Questionnaire.item.readOnly",
"path": "Questionnaire.item.readOnly",
"short": "Don't allow human editing",
"definition": "An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.",
"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.",
"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,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"condition": [
"que-9"
],
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.repeats",
"short": "Whether the question can have multiple answers",
"definition": "If true, the question may have more than one answer.",
"comments": "Whether the question itself will be displayed for each answer is a rendering choice typically based on whether there are nested groups.",
"requirements": "Used for \"check all that apply\" types of questions or \"list your top 3\", etc.",
"id": "Questionnaire.item.maxLength",
"path": "Questionnaire.item.maxLength",
"short": "No more than this many characters",
"definition": "The maximum number of characters that are permitted in the answer to be considered a \"valid\" QuestionnaireResponse.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
"code": "integer"
}
],
"defaultValueBoolean": false,
"condition": [
"que-10"
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.options",
"id": "Questionnaire.item.options",
"path": "Questionnaire.item.options",
"short": "Valueset containing permitted answers",
"definition": "Reference to a value set containing a list of codes representing permitted answers for the question.",
"comments": "LOINC defines many useful value sets for questionnaire response. See [LOINC Answer Lists](loinc.html#alist).",
"definition": "A reference to a value set containing a list of codes representing permitted answers for a \"choice\" or \"open-choice\" question.",
"comment": "LOINC defines many useful value sets for questionnaire responses. See [LOINC Answer Lists](loinc.html#alist). The value may come from the ElementDefinition referred to by .definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/ValueSet"
]
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
}
],
"condition": [
"que-4"
"que-4",
"que-5"
],
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer to capture value set"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.option",
"id": "Questionnaire.item.option",
"path": "Questionnaire.item.option",
"short": "Permitted answer",
"definition": "For a \"choice\" question, identifies one of the permitted answers for the question.",
"definition": "One of the permitted answers for a \"choice\" or \"open-choice\" question.",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"que-4",
"que-5"
],
"mapping": [
{
"identity": "rim",
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"id": "Questionnaire.item.option.value[x]",
"path": "Questionnaire.item.option.value[x]",
"short": "Answer value",
"definition": "A potential answer that's allowed as the answer to this question.",
"comment": "The data type of the value must agree with the item.type.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
},
{
"code": "date"
},
{
"code": "time"
},
{
"code": "string"
},
{
"code": "Coding"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuestionnaireQuestionOption"
}
],
"strength": "example",
"description": "Allowed values to answer questions.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"id": "Questionnaire.item.initial[x]",
"path": "Questionnaire.item.initial[x]",
"short": "Default value when item is first rendered",
"definition": "The value that should be defaulted when initially rendering the questionnaire for user input.",
"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.",
"requirements": "In some workflows, having defaults saves time.",
"min": 0,
"max": "1",
"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"
}
],
"condition": [
"que-4"
"que-8"
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuestionnaireQuestionOption2"
}
],
"strength": "example",
"description": "Allowed values to answer questions.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers"
}
},
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer to capture value set"
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.group",
"short": "Nested questionnaire group",
"definition": "Nested group, containing nested question for this question. The order of groups within the question is relevant.",
"requirements": "It is useful to have \"sub-questions\", questions which normally appear when certain answers are given and which collect additional details.",
"id": "Questionnaire.item.item",
"path": "Questionnaire.item.item",
"short": "Nested questionnaire items",
"definition": "Text, questions and other groups to be nested beneath a question or group.",
"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.",
"requirements": "Reports can consist of complex nested groups.",
"min": 0,
"max": "*",
"nameReference": "group",
"contentReference": "#Questionnaire.item",
"condition": [
"que-1"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
©
®©
HL7.org
2011+.
FHIR
DSTU2
(v1.0.2-7202)
Release
3
(STU;
v3.0.2-11200)
generated
on
Sat,
Thurs,
Oct
24,
2015
07:44+1100.
2019
11:53+1100.
QA
Page
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
|
Compare
to
DSTU1
DSTU2
|
|
Propose
a
change