SADIE Developer and Tester Guide

QuestionnaireResponse

The QuestionnaireResponse resource stores the following types of information:

FlexForm QuestionnaireResponse

FlexForm QuestionnaireResponse

Requirements

To be done

Profile - FlexForm QuestionnaireResponse

QuestionnaireResponse	I		QuestionnaireResponse	Element id QuestionnaireResponse Short description SDC Questionnaire Response Alternate names Form, QuestionnaireAnswers, Form Data Definition Sets expectations for supported capabilities for questionnaire responses for SDC-conformant systems. Comments *`FOR SADIE USE: This is based on the SDC Questionnaire Response`* The QuestionnaireResponse contains enough information about the questions asked and their organization that it can be interpreted somewhat independently from the Questionnaire it is based on. I.e. You don't need access to the Questionnaire in order to extract basic information from a QuestionnaireResponse. Data type QuestionnaireResponse Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim: Entity. Role, or Act workflow: Event rim: Observation[moodCode=EVN]
id	Σ	0..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.id Short description 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. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id QuestionnaireResponse.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id QuestionnaireResponse.implicitRules Short description 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id QuestionnaireResponse.language Short description 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text		0..1	Narrative	There are no (further) constraints on this element Element id QuestionnaireResponse.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments 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 information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id QuestionnaireResponse.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id QuestionnaireResponse.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
signature	I	0..*	Extension(Signature)	There are no (further) constraints on this element Element id QuestionnaireResponse.extension:signature Short description A signature attesting to the content Alternate names extensions, user content Definition Represents a wet or electronic signature for either the form overall or for the question or item it's associated with. 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. Data type Extension(Signature) Extension URL http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id QuestionnaireResponse.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
identifier	S Σ	0..0	Identifier	There are no (further) constraints on this element Element id QuestionnaireResponse.identifier Short description Unique id for this set of answers Definition A business identifier assigned to a particular completed (or partially completed) questionnaire. Requirements Used for tracking, registration and other business purposes. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier workflow: Event.identifier w5: FiveWs.identifier rim: .id
basedOn	Σ I	1..1	Reference(Request)	Element id QuestionnaireResponse.basedOn Short description Request fulfilled by this QuestionnaireResponse Alternate names order Definition *`FOR SADIE USE: This is a this is a reference to the Request`* The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. Requirements Supports traceability of responsibility for the action and allows linkage of an action to the recommendations acted upon. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Request) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow: Event.basedOn rim: .outboundRelationship[typeCode=FLFS].target
id		0..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.basedOn.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id QuestionnaireResponse.basedOn.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
reference	Σ I	0..1	string	Element id QuestionnaireResponse.basedOn.reference Short description Literal reference, Relative, internal or absolute URL Definition *`FOR SADIE USE: This is a this is a reference to the Request`* A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
type	Σ	0..0	uriBinding	There are no (further) constraints on this element Element id QuestionnaireResponse.basedOn.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
identifier	Σ	0..0	Identifier	There are no (further) constraints on this element Element id QuestionnaireResponse.basedOn.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier rim: .identifier
display	Σ	0..0	string	There are no (further) constraints on this element Element id QuestionnaireResponse.basedOn.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
partOf	Σ I	0..0	Reference(Observation \| Procedure)	There are no (further) constraints on this element Element id QuestionnaireResponse.partOf Short description Part of this action Definition A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of. Comments Composition of questionnaire responses will be handled by the parent questionnaire having answers that reference the child questionnaire. For relationships to referrals, and other types of requests, use basedOn. Data type Reference(Observation \| Procedure) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow: Event.partOf rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]
questionnaire	S Σ	1..1	canonical(SDC Questionnaire)	There are no (further) constraints on this element Element id QuestionnaireResponse.questionnaire Short description Form being answered Alternate names Form Definition The Questionnaire that defines and organizes the questions for which answers are being provided. Requirements Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form. Comments For SDC, this SHALL be the version-specific URL of the form as hosted on the Form Manager. Data type canonical(SDC Questionnaire) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Event.instantiates rim: ./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]
status	S Σ	1..1	codeBinding	Element id QuestionnaireResponse.status Short description in-progress \| completed \| amended \| entered-in-error \| stopped Definition *`FOR SADIE USE: There are only 2 statuses used, in-progress, completed`* The position of the questionnaire response within its overall lifecycle. Requirements The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished. Comments This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Data type code Binding Lifecycle status of the questionnaire response. QuestionnaireResponseStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Event.status w5: FiveWs.status rim: .statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish "in-progress" from "published)
subject	S Σ I	1..1	Reference(Applicant)	Element id QuestionnaireResponse.subject Short description The subject of the questions Alternate names Patient, Focus Definition *`FOR SADIE USE: This is the applicant (Patient)`* The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. Requirements Allows linking the answers to the individual the answers describe. May also affect access control. Comments If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types. Data type Reference(Applicant) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow: Event.subject w5: FiveWs.subject[x] rim: .participation[typeCode=SBJ].role w5: FiveWs.subject
encounter	Σ I	0..0	Reference(Encounter)	There are no (further) constraints on this element Element id QuestionnaireResponse.encounter Short description Encounter created as part of Definition The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated. Requirements Provides context for the information that was captured. May also affect access control. Comments This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter. Data type Reference(Encounter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow: Event.encounter w5: FiveWs.context rim: .inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]
authored	S Σ	1..1	dateTime	There are no (further) constraints on this element Element id QuestionnaireResponse.authored Short description Date the answers were gathered Alternate names Date Created, Date published, Date Issued, Date updated Definition Identifies when this version of the answer set was created. Changes whenever the answers are updated. Requirements Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers. Comments May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured. This element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Event.occurrence[x] w5: FiveWs.recorded rim: .participation[typeCode=AUT].time
author	S Σ I	1..1	Reference(FlexFormsRole)	Element id QuestionnaireResponse.author Short description Person who received and recorded the answers Alternate names Laboratory, Service, Practitioner, Department, Company, Performer Definition *`FOR SADIE USE: This is the Requestor Role that owns the related Request. This is used by the security interceptor.`* Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system. Requirements Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers. Comments Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated. Data type Reference(FlexFormsRole) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow: Event.performer w5: FiveWs.author rim: .participation[typeCode=AUT].role
source	Σ I	0..0	Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson)	There are no (further) constraints on this element Element id QuestionnaireResponse.source Short description The person who answered the questions Definition The person who answered the questions about the subject. Requirements When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions. Comments If not specified, no inference can be made about who provided the data. Data type Reference(Patient \| Practitioner \| PractitionerRole \| RelatedPerson) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) w5: FiveWs.source rim: .participation[typeCode=INF].role
item	S I	0..*	BackboneElement	There are no (further) constraints on this element Element id QuestionnaireResponse.item Short description Groups and questions Definition A group or question item from the original questionnaire for which answers are provided. Comments Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer). Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` qrs-1: Nested item can't be beneath both item and answer `(answer.exists() and item.exists()).not()` Mappings rim: n/a rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]
id		0..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.item.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id QuestionnaireResponse.item.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
ItemSignature	I	0..*	Extension(Signature)	There are no (further) constraints on this element Element id QuestionnaireResponse.item.extension:ItemSignature Short description A signature attesting to the content Alternate names extensions, user content Definition Represents a wet or electronic signature for either the form overall or for the question or item it's associated with. 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. Data type Extension(Signature) Extension URL http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id QuestionnaireResponse.item.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
linkId	S	1..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.item.linkId Short description Pointer to specific item from Questionnaire Definition The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource. Requirements Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].id
definition		0..1	uri	There are no (further) constraints on this element Element id QuestionnaireResponse.item.definition Short description ElementDefinition - details for the item Definition A reference to an ElementDefinition that provides the details for the item. Requirements A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition. Comments The ElementDefinition must be in a StructureDefinition, and must have a fragment identifier that identifies the specific data element by its id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. There is no need for this element if the item pointed to by the linkId has a definition listed. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN].code
text	S	0..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.item.text Short description Name for group or question text Definition Text that is displayed above the contents of the group or as the text of the question being answered. Requirements Allows the questionnaire response to be read without access to the questionnaire. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .text
answer	S	0..*	BackboneElement	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer Short description The response(s) to the question Definition The respondent's answer(s) to the question. Comments The value is nested because we cannot have a repeating structure that has variable type. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .value[type=LIST_ANY]
id		0..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
value[x]	S	0..1		There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.value[x] Short description Single-valued answer to the question Definition The answer (or one of the answers) provided by the respondent to the question. Requirements Ability to retain a single-valued answer to a question. Comments More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire. Sliced: Unordered, Open, by $this(Type) Binding Code indicating the response provided for a question. QuestionnaireAnswerCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .item
valueBoolean			boolean	There are no (further) constraints on this element Data type boolean
valueDate			date	There are no (further) constraints on this element Data type date
valueDateTime			dateTime	There are no (further) constraints on this element Data type dateTime
valueTime			time	There are no (further) constraints on this element Data type time
valueDecimal			decimal	There are no (further) constraints on this element Data type decimal
valueInteger			integer	There are no (further) constraints on this element Data type integer
valueString			string	There are no (further) constraints on this element Data type string
valueUri			uri	There are no (further) constraints on this element Data type uri
valueQuantity			Quantity	There are no (further) constraints on this element Data type Quantity
valueAttachment			Attachment	There are no (further) constraints on this element Data type Attachment
valueReference			Reference(Resource)	There are no (further) constraints on this element Data type Reference(Resource)
valueCoding	S	0..1	Coding	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.value[x]:valueCoding Short description Single-valued answer to the question Definition The answer (or one of the answers) provided by the respondent to the question. Requirements Ability to retain a single-valued answer to a question. Comments More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire. Data type Coding Binding Code indicating the response provided for a question. QuestionnaireAnswerCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .item
id		0..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.value[x]:valueCoding.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.value[x]:valueCoding.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
ordinalValue	I	0..1	Extension(decimal)	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.value[x]:valueCoding.extension:ordinalValue Short description Assigned Ordinal Value Alternate names extensions, user content Definition A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores. Comments Scores are commonly encountered in various clinical assessment scales. Assigning a value to a concept should generally be done in a formal code system that defines the value, or in an applicable value set for the concept, but some concepts do not have a formal definition (or are not even represented as a concept formally, especially in Questionnaires, so this extension is allowed to appear ouside those preferred contexts. Scores may even be assigned arbitrarily during use (hence, on Coding). The value may be constrained to an integer in some contexts of use. Todo: Scoring algorithms may also be defined directly, but how this is done is not yet defined. Data type Extension(decimal) Extension URL http://hl7.org/fhir/StructureDefinition/ordinalValue Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
system	Σ	0..1	uri	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.value[x]:valueCoding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.value[x]:valueCoding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	Σ	0..1	code	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.value[x]:valueCoding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	0..1	string	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.value[x]:valueCoding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.value[x]:valueCoding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
item	S	0..*	see (item)	There are no (further) constraints on this element Element id QuestionnaireResponse.item.answer.item Short description Nested groups and questions Definition Nested groups and/or questions found within this particular answer. Requirements It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details. Mappings rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]
item	S	0..*	see (item)	There are no (further) constraints on this element Element id QuestionnaireResponse.item.item Short description Nested questionnaire response items Definition Questions or sub-groups nested beneath a question or group. Requirements Reports can consist of complex nested groups. Mappings rim: .outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]

Example - that passed validation

{
    "resourceType": "QuestionnaireResponse",
    "id": "48cf9188-5192-44c5-b1ea-11111111",
    "meta": {
        "versionId": "9",
        "lastUpdated": "2021-10-06T15:22:11.628+00:00",
        "source": "#j4VrSUa7UuMoch2W",
        "profile":  [
            "http://health.gov.on.ca/sadie/fhir/StructureDefinition/FlexFormResponse"
        ]
    },
    "text": {
        "status": "empty",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "basedOn":  [
        {
            "reference": "ServiceRequest/8638fbcd-3ae6-4c84-85bf-08cfeaecbc6c"
        }
    ],
    "questionnaire": "http://health.gov.on.ca/sadie/fhir/FlexForm/ODSPFormSelection/Version1",
    "status": "in-progress",
    "subject": {
        "reference": "Patient/7d0e2f8a-a46b-498a-a808-de81020b1d9d"
    },
    "authored": "2021-09-27T17:36:56Z",
    "author": {
        "reference": "PractitionerRole/b1d8e2f5-6e93-47d1-bd9d-22222222"
    }
}

SADIE Developer and Tester Guide

QuestionnaireResponse

FlexForm QuestionnaireResponse

`FOR SADIE USE: This is based on the SDC Questionnaire Response`

`FOR SADIE USE: This is a this is a reference to the Request`

`FOR SADIE USE: This is a this is a reference to the Request`

`FOR SADIE USE: There are only 2 statuses used, in-progress, completed`

`FOR SADIE USE: This is the applicant (Patient)`

`FOR SADIE USE: This is the Requestor Role that owns the related Request. This is used by the security interceptor.`