HSAAP Special Authority FHIR Implementation Guide - Local Development build (v0.1.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: SA QuestionnaireResponse

The clinical criteria and answers for a Special Authority Application. Referenced from Claim.supportingInfo.

Form identity. questionnaire carries both parts of the form identity: {canonical}|{formVersion}. The API splits on the pipe to obtain saFormNumber (the final path segment of the canonical) and saFormVersion. FHIR-native clients SHALL version-pin the canonical. It MAY be unpinned only for submissions from the SOAP to FHIR Broker, which cannot supply a form version (see Form and Criterion Identity).

Answers. Only valueBoolean and valueString answers are supported. Each answered item's linkId is the criterionIdentifier. Unanswered items are not processed. Nested items are flattened by the API, since the criterionIdentifier is unique across the whole form.

Roles. The Applicant is author (D5). The optional Referrer is the referring-practitioner extension.

Status. HSAAP Application status is never mapped to QuestionnaireResponse.status. It is always completed.

Usages:

• Use this Profile: SA Submission Bundle
• Refer to this Profile: SA Claim
• Examples for this Profile: QuestionnaireResponse/sa-example-qr

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
QuestionnaireResponse	C	0..*	QuestionnaireResponse	A structured set of questions and their answers Constraints: sa-qr-1, sa-qr-2, sa-qr-3, sa-qr-4
QuestionnaireResponse.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
QuestionnaireResponse.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
QuestionnaireResponse.Slices for extension.extension:requestForWaiver	S This element must be supported.	0..1	boolean	Request For Waiver URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/request-for-waiver
QuestionnaireResponse.Slices for extension.extension:referringPractitioner	S This element must be supported.	0..1	Reference(SA Practitioner)	Referring Practitioner URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/referring-practitioner
QuestionnaireResponse.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
QuestionnaireResponse.identifier	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	Submitter's own reference (clientReference), used for support and duplicate investigation
QuestionnaireResponse.questionnaire	S This element must be supported. Σ This element is included in summaries.	1..1	canonical(SA Questionnaire)	Form canonical, version pinned: .../Questionnaire/{formNumber}|{formVersion}
QuestionnaireResponse.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. Required Pattern: completed (extensions allowed)
QuestionnaireResponse.subject	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(SA Patient)	The subject of the questions
QuestionnaireResponse.authored	S This element must be supported. Σ This element is included in summaries.	1..1	dateTime	When the practitioner completed the form (suppliedApplicationDate)
QuestionnaireResponse.author	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(SA Practitioner)	The Applicant
QuestionnaireResponse.item	S This element must be supported. C	0..*	BackboneElement	Groups and questions Constraints: qrs-1
QuestionnaireResponse.item.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
QuestionnaireResponse.item.linkId	S This element must be supported.	1..1	string	criterionIdentifier (five character, zero padded) where answered
QuestionnaireResponse.item.text	S This element must be supported.	0..1	string	criterionName - stored, never used to identify an answer
QuestionnaireResponse.item.answer	S This element must be supported.	0..*	BackboneElement	At most one answer per item (sa-qr-3)
QuestionnaireResponse.item.answer.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
QuestionnaireResponse.item.answer.value[x]	S This element must be supported.	0..1		Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.
QuestionnaireResponse.item.answer.value[x].valueBoolean			boolean
QuestionnaireResponse.item.answer.value[x].valueString			string
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
QuestionnaireResponse.​status	Base	required	QuestionnaireResponseStatus	📍4.0.1	FHIR Std.
QuestionnaireResponse.​item.answer.value[x]	Base	example	Questionnaire Answer Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
sa-qr-1	error	QuestionnaireResponse	QuestionnaireResponse.questionnaire SHALL be a canonical with a non-empty form URL, optionally followed by exactly one '|' and a non-empty form version, and SHALL NOT contain a fragment marker.	questionnaire.matches('^[^|#]+([|][^|#]+)?$')
sa-qr-2	warning	QuestionnaireResponse	QuestionnaireResponse.questionnaire SHALL be version-pinned (url|version) by FHIR-native clients. It MAY be unpinned only for submissions from the SOAP to FHIR Broker; this rule is enforced by the API against the authenticated client, so the profile only warns.	questionnaire.contains('|')
sa-qr-3	error	QuestionnaireResponse	Every answer SHALL be valueBoolean or valueString (Assumption 1), and an item SHALL carry at most one answer.	(item | item.repeat(item | answer.item)).all(answer.count() <= 1 and answer.all(value is boolean or value is string))
sa-qr-4	error	QuestionnaireResponse	The linkId of every answered item SHALL be a five character, zero padded criterionIdentifier (D18).	(item | item.repeat(item | answer.item)).where(answer.exists()).all(linkId.matches('^[0-9]{5}$'))

This structure is derived from QuestionnaireResponse

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
QuestionnaireResponse	C	0..*	QuestionnaireResponse	A structured set of questions and their answers Constraints: sa-qr-1, sa-qr-2, sa-qr-3, sa-qr-4
QuestionnaireResponse.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
QuestionnaireResponse.Slices for extension.extension:requestForWaiver	S This element must be supported.	0..1	boolean	Request For Waiver URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/request-for-waiver
QuestionnaireResponse.Slices for extension.extension:referringPractitioner	S This element must be supported.	0..1	Reference(SA Practitioner)	Referring Practitioner URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/referring-practitioner
QuestionnaireResponse.identifier	S This element must be supported.	0..1	Identifier	Submitter's own reference (clientReference), used for support and duplicate investigation
QuestionnaireResponse.questionnaire	S This element must be supported.	1..1	canonical(SA Questionnaire)	Form canonical, version pinned: .../Questionnaire/{formNumber}|{formVersion}
QuestionnaireResponse.status	S This element must be supported.	1..1	code	in-progress | completed | amended | entered-in-error | stopped Required Pattern: completed (extensions allowed)
QuestionnaireResponse.subject	S This element must be supported.	1..1	Reference(SA Patient)	The subject of the questions
QuestionnaireResponse.authored	S This element must be supported.	1..1	dateTime	When the practitioner completed the form (suppliedApplicationDate)
QuestionnaireResponse.author	S This element must be supported.	1..1	Reference(SA Practitioner)	The Applicant
QuestionnaireResponse.source		0..0		The person who answered the questions
QuestionnaireResponse.item	S This element must be supported.	0..*	BackboneElement	Groups and questions
QuestionnaireResponse.item.linkId	S This element must be supported.	1..1	string	criterionIdentifier (five character, zero padded) where answered
QuestionnaireResponse.item.text	S This element must be supported.	0..1	string	criterionName - stored, never used to identify an answer
QuestionnaireResponse.item.answer	S This element must be supported.	0..*	BackboneElement	At most one answer per item (sa-qr-3)
QuestionnaireResponse.item.answer.value[x]	S This element must be supported.	0..1		Single-valued answer to the question
QuestionnaireResponse.item.answer.value[x].valueBoolean			boolean
QuestionnaireResponse.item.answer.value[x].valueString			string
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
sa-qr-1	error	QuestionnaireResponse	QuestionnaireResponse.questionnaire SHALL be a canonical with a non-empty form URL, optionally followed by exactly one '|' and a non-empty form version, and SHALL NOT contain a fragment marker.	questionnaire.matches('^[^|#]+([|][^|#]+)?$')
sa-qr-2	warning	QuestionnaireResponse	QuestionnaireResponse.questionnaire SHALL be version-pinned (url|version) by FHIR-native clients. It MAY be unpinned only for submissions from the SOAP to FHIR Broker; this rule is enforced by the API against the authenticated client, so the profile only warns.	questionnaire.contains('|')
sa-qr-3	error	QuestionnaireResponse	Every answer SHALL be valueBoolean or valueString (Assumption 1), and an item SHALL carry at most one answer.	(item | item.repeat(item | answer.item)).all(answer.count() <= 1 and answer.all(value is boolean or value is string))
sa-qr-4	error	QuestionnaireResponse	The linkId of every answered item SHALL be a five character, zero padded criterionIdentifier (D18).	(item | item.repeat(item | answer.item)).where(answer.exists()).all(linkId.matches('^[0-9]{5}$'))

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
QuestionnaireResponse	C	0..*	QuestionnaireResponse	A structured set of questions and their answers Constraints: sa-qr-1, sa-qr-2, sa-qr-3, sa-qr-4
QuestionnaireResponse.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
QuestionnaireResponse.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
QuestionnaireResponse.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
QuestionnaireResponse.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
QuestionnaireResponse.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
QuestionnaireResponse.contained		0..*	Resource	Contained, inline Resources
QuestionnaireResponse.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
QuestionnaireResponse.Slices for extension.extension:requestForWaiver	S This element must be supported.	0..1	boolean	Request For Waiver URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/request-for-waiver
QuestionnaireResponse.Slices for extension.extension:referringPractitioner	S This element must be supported.	0..1	Reference(SA Practitioner)	Referring Practitioner URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/referring-practitioner
QuestionnaireResponse.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
QuestionnaireResponse.identifier	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	Submitter's own reference (clientReference), used for support and duplicate investigation
QuestionnaireResponse.basedOn	Σ This element is included in summaries.	0..*	Reference(CarePlan | ServiceRequest)	Request fulfilled by this QuestionnaireResponse
QuestionnaireResponse.partOf	Σ This element is included in summaries.	0..*	Reference(Observation | Procedure)	Part of this action
QuestionnaireResponse.questionnaire	S This element must be supported. Σ This element is included in summaries.	1..1	canonical(SA Questionnaire)	Form canonical, version pinned: .../Questionnaire/{formNumber}|{formVersion}
QuestionnaireResponse.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. Required Pattern: completed (extensions allowed)
QuestionnaireResponse.subject	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(SA Patient)	The subject of the questions
QuestionnaireResponse.encounter	Σ This element is included in summaries.	0..1	Reference(Encounter)	Encounter created as part of
QuestionnaireResponse.authored	S This element must be supported. Σ This element is included in summaries.	1..1	dateTime	When the practitioner completed the form (suppliedApplicationDate)
QuestionnaireResponse.author	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(SA Practitioner)	The Applicant
QuestionnaireResponse.item	S This element must be supported. C	0..*	BackboneElement	Groups and questions Constraints: qrs-1
QuestionnaireResponse.item.id		0..1	string	Unique id for inter-element referencing
QuestionnaireResponse.item.extension		0..*	Extension	Additional content defined by implementations
QuestionnaireResponse.item.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
QuestionnaireResponse.item.linkId	S This element must be supported.	1..1	string	criterionIdentifier (five character, zero padded) where answered
QuestionnaireResponse.item.definition		0..1	uri	ElementDefinition - details for the item
QuestionnaireResponse.item.text	S This element must be supported.	0..1	string	criterionName - stored, never used to identify an answer
QuestionnaireResponse.item.answer	S This element must be supported.	0..*	BackboneElement	At most one answer per item (sa-qr-3)
QuestionnaireResponse.item.answer.id		0..1	string	Unique id for inter-element referencing
QuestionnaireResponse.item.answer.extension		0..*	Extension	Additional content defined by implementations
QuestionnaireResponse.item.answer.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
QuestionnaireResponse.item.answer.value[x]	S This element must be supported.	0..1		Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.
QuestionnaireResponse.item.answer.value[x].valueBoolean			boolean
QuestionnaireResponse.item.answer.value[x].valueString			string
QuestionnaireResponse.item.answer.item		0..*	See item (QuestionnaireResponse)	Nested groups and questions
QuestionnaireResponse.item.item		0..*	See item (QuestionnaireResponse)	Nested questionnaire response items
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
QuestionnaireResponse.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
QuestionnaireResponse.​status	Base	required	QuestionnaireResponseStatus	📍4.0.1	FHIR Std.
QuestionnaireResponse.​item.answer.value[x]	Base	example	Questionnaire Answer Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
sa-qr-1	error	QuestionnaireResponse	QuestionnaireResponse.questionnaire SHALL be a canonical with a non-empty form URL, optionally followed by exactly one '|' and a non-empty form version, and SHALL NOT contain a fragment marker.	questionnaire.matches('^[^|#]+([|][^|#]+)?$')
sa-qr-2	warning	QuestionnaireResponse	QuestionnaireResponse.questionnaire SHALL be version-pinned (url|version) by FHIR-native clients. It MAY be unpinned only for submissions from the SOAP to FHIR Broker; this rule is enforced by the API against the authenticated client, so the profile only warns.	questionnaire.contains('|')
sa-qr-3	error	QuestionnaireResponse	Every answer SHALL be valueBoolean or valueString (Assumption 1), and an item SHALL carry at most one answer.	(item | item.repeat(item | answer.item)).all(answer.count() <= 1 and answer.all(value is boolean or value is string))
sa-qr-4	error	QuestionnaireResponse	The linkId of every answered item SHALL be a five character, zero padded criterionIdentifier (D18).	(item | item.repeat(item | answer.item)).where(answer.exists()).all(linkId.matches('^[0-9]{5}$'))

This structure is derived from QuestionnaireResponse

Summary

Mandatory: 4 elements
Must-Support: 13 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• SA Questionnaire (https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-questionnaire)
• SA Patient (https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-patient)
• SA Practitioner (https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-practitioner)

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/request-for-waiver
• https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/referring-practitioner

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
QuestionnaireResponse	C	0..*	QuestionnaireResponse	A structured set of questions and their answers Constraints: sa-qr-1, sa-qr-2, sa-qr-3, sa-qr-4
QuestionnaireResponse.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
QuestionnaireResponse.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
QuestionnaireResponse.Slices for extension.extension:requestForWaiver	S This element must be supported.	0..1	boolean	Request For Waiver URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/request-for-waiver
QuestionnaireResponse.Slices for extension.extension:referringPractitioner	S This element must be supported.	0..1	Reference(SA Practitioner)	Referring Practitioner URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/referring-practitioner
QuestionnaireResponse.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
QuestionnaireResponse.identifier	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	Submitter's own reference (clientReference), used for support and duplicate investigation
QuestionnaireResponse.questionnaire	S This element must be supported. Σ This element is included in summaries.	1..1	canonical(SA Questionnaire)	Form canonical, version pinned: .../Questionnaire/{formNumber}|{formVersion}
QuestionnaireResponse.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. Required Pattern: completed (extensions allowed)
QuestionnaireResponse.subject	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(SA Patient)	The subject of the questions
QuestionnaireResponse.authored	S This element must be supported. Σ This element is included in summaries.	1..1	dateTime	When the practitioner completed the form (suppliedApplicationDate)
QuestionnaireResponse.author	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(SA Practitioner)	The Applicant
QuestionnaireResponse.item	S This element must be supported. C	0..*	BackboneElement	Groups and questions Constraints: qrs-1
QuestionnaireResponse.item.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
QuestionnaireResponse.item.linkId	S This element must be supported.	1..1	string	criterionIdentifier (five character, zero padded) where answered
QuestionnaireResponse.item.text	S This element must be supported.	0..1	string	criterionName - stored, never used to identify an answer
QuestionnaireResponse.item.answer	S This element must be supported.	0..*	BackboneElement	At most one answer per item (sa-qr-3)
QuestionnaireResponse.item.answer.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
QuestionnaireResponse.item.answer.value[x]	S This element must be supported.	0..1		Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.
QuestionnaireResponse.item.answer.value[x].valueBoolean			boolean
QuestionnaireResponse.item.answer.value[x].valueString			string
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
QuestionnaireResponse.​status	Base	required	QuestionnaireResponseStatus	📍4.0.1	FHIR Std.
QuestionnaireResponse.​item.answer.value[x]	Base	example	Questionnaire Answer Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
sa-qr-1	error	QuestionnaireResponse	QuestionnaireResponse.questionnaire SHALL be a canonical with a non-empty form URL, optionally followed by exactly one '|' and a non-empty form version, and SHALL NOT contain a fragment marker.	questionnaire.matches('^[^|#]+([|][^|#]+)?$')
sa-qr-2	warning	QuestionnaireResponse	QuestionnaireResponse.questionnaire SHALL be version-pinned (url|version) by FHIR-native clients. It MAY be unpinned only for submissions from the SOAP to FHIR Broker; this rule is enforced by the API against the authenticated client, so the profile only warns.	questionnaire.contains('|')
sa-qr-3	error	QuestionnaireResponse	Every answer SHALL be valueBoolean or valueString (Assumption 1), and an item SHALL carry at most one answer.	(item | item.repeat(item | answer.item)).all(answer.count() <= 1 and answer.all(value is boolean or value is string))
sa-qr-4	error	QuestionnaireResponse	The linkId of every answered item SHALL be a five character, zero padded criterionIdentifier (D18).	(item | item.repeat(item | answer.item)).where(answer.exists()).all(linkId.matches('^[0-9]{5}$'))

Differential View

This structure is derived from QuestionnaireResponse

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
QuestionnaireResponse	C	0..*	QuestionnaireResponse	A structured set of questions and their answers Constraints: sa-qr-1, sa-qr-2, sa-qr-3, sa-qr-4
QuestionnaireResponse.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
QuestionnaireResponse.Slices for extension.extension:requestForWaiver	S This element must be supported.	0..1	boolean	Request For Waiver URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/request-for-waiver
QuestionnaireResponse.Slices for extension.extension:referringPractitioner	S This element must be supported.	0..1	Reference(SA Practitioner)	Referring Practitioner URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/referring-practitioner
QuestionnaireResponse.identifier	S This element must be supported.	0..1	Identifier	Submitter's own reference (clientReference), used for support and duplicate investigation
QuestionnaireResponse.questionnaire	S This element must be supported.	1..1	canonical(SA Questionnaire)	Form canonical, version pinned: .../Questionnaire/{formNumber}|{formVersion}
QuestionnaireResponse.status	S This element must be supported.	1..1	code	in-progress | completed | amended | entered-in-error | stopped Required Pattern: completed (extensions allowed)
QuestionnaireResponse.subject	S This element must be supported.	1..1	Reference(SA Patient)	The subject of the questions
QuestionnaireResponse.authored	S This element must be supported.	1..1	dateTime	When the practitioner completed the form (suppliedApplicationDate)
QuestionnaireResponse.author	S This element must be supported.	1..1	Reference(SA Practitioner)	The Applicant
QuestionnaireResponse.source		0..0		The person who answered the questions
QuestionnaireResponse.item	S This element must be supported.	0..*	BackboneElement	Groups and questions
QuestionnaireResponse.item.linkId	S This element must be supported.	1..1	string	criterionIdentifier (five character, zero padded) where answered
QuestionnaireResponse.item.text	S This element must be supported.	0..1	string	criterionName - stored, never used to identify an answer
QuestionnaireResponse.item.answer	S This element must be supported.	0..*	BackboneElement	At most one answer per item (sa-qr-3)
QuestionnaireResponse.item.answer.value[x]	S This element must be supported.	0..1		Single-valued answer to the question
QuestionnaireResponse.item.answer.value[x].valueBoolean			boolean
QuestionnaireResponse.item.answer.value[x].valueString			string
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
sa-qr-1	error	QuestionnaireResponse	QuestionnaireResponse.questionnaire SHALL be a canonical with a non-empty form URL, optionally followed by exactly one '|' and a non-empty form version, and SHALL NOT contain a fragment marker.	questionnaire.matches('^[^|#]+([|][^|#]+)?$')
sa-qr-2	warning	QuestionnaireResponse	QuestionnaireResponse.questionnaire SHALL be version-pinned (url|version) by FHIR-native clients. It MAY be unpinned only for submissions from the SOAP to FHIR Broker; this rule is enforced by the API against the authenticated client, so the profile only warns.	questionnaire.contains('|')
sa-qr-3	error	QuestionnaireResponse	Every answer SHALL be valueBoolean or valueString (Assumption 1), and an item SHALL carry at most one answer.	(item | item.repeat(item | answer.item)).all(answer.count() <= 1 and answer.all(value is boolean or value is string))
sa-qr-4	error	QuestionnaireResponse	The linkId of every answered item SHALL be a five character, zero padded criterionIdentifier (D18).	(item | item.repeat(item | answer.item)).where(answer.exists()).all(linkId.matches('^[0-9]{5}$'))

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
QuestionnaireResponse	C	0..*	QuestionnaireResponse	A structured set of questions and their answers Constraints: sa-qr-1, sa-qr-2, sa-qr-3, sa-qr-4
QuestionnaireResponse.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
QuestionnaireResponse.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
QuestionnaireResponse.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
QuestionnaireResponse.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
QuestionnaireResponse.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
QuestionnaireResponse.contained		0..*	Resource	Contained, inline Resources
QuestionnaireResponse.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
QuestionnaireResponse.Slices for extension.extension:requestForWaiver	S This element must be supported.	0..1	boolean	Request For Waiver URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/request-for-waiver
QuestionnaireResponse.Slices for extension.extension:referringPractitioner	S This element must be supported.	0..1	Reference(SA Practitioner)	Referring Practitioner URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/referring-practitioner
QuestionnaireResponse.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
QuestionnaireResponse.identifier	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	Submitter's own reference (clientReference), used for support and duplicate investigation
QuestionnaireResponse.basedOn	Σ This element is included in summaries.	0..*	Reference(CarePlan | ServiceRequest)	Request fulfilled by this QuestionnaireResponse
QuestionnaireResponse.partOf	Σ This element is included in summaries.	0..*	Reference(Observation | Procedure)	Part of this action
QuestionnaireResponse.questionnaire	S This element must be supported. Σ This element is included in summaries.	1..1	canonical(SA Questionnaire)	Form canonical, version pinned: .../Questionnaire/{formNumber}|{formVersion}
QuestionnaireResponse.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	in-progress | completed | amended | entered-in-error | stopped Binding: QuestionnaireResponseStatus (required): Lifecycle status of the questionnaire response. Required Pattern: completed (extensions allowed)
QuestionnaireResponse.subject	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(SA Patient)	The subject of the questions
QuestionnaireResponse.encounter	Σ This element is included in summaries.	0..1	Reference(Encounter)	Encounter created as part of
QuestionnaireResponse.authored	S This element must be supported. Σ This element is included in summaries.	1..1	dateTime	When the practitioner completed the form (suppliedApplicationDate)
QuestionnaireResponse.author	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(SA Practitioner)	The Applicant
QuestionnaireResponse.item	S This element must be supported. C	0..*	BackboneElement	Groups and questions Constraints: qrs-1
QuestionnaireResponse.item.id		0..1	string	Unique id for inter-element referencing
QuestionnaireResponse.item.extension		0..*	Extension	Additional content defined by implementations
QuestionnaireResponse.item.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
QuestionnaireResponse.item.linkId	S This element must be supported.	1..1	string	criterionIdentifier (five character, zero padded) where answered
QuestionnaireResponse.item.definition		0..1	uri	ElementDefinition - details for the item
QuestionnaireResponse.item.text	S This element must be supported.	0..1	string	criterionName - stored, never used to identify an answer
QuestionnaireResponse.item.answer	S This element must be supported.	0..*	BackboneElement	At most one answer per item (sa-qr-3)
QuestionnaireResponse.item.answer.id		0..1	string	Unique id for inter-element referencing
QuestionnaireResponse.item.answer.extension		0..*	Extension	Additional content defined by implementations
QuestionnaireResponse.item.answer.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
QuestionnaireResponse.item.answer.value[x]	S This element must be supported.	0..1		Single-valued answer to the question Binding: QuestionnaireAnswerCodes (example): Code indicating the response provided for a question.
QuestionnaireResponse.item.answer.value[x].valueBoolean			boolean
QuestionnaireResponse.item.answer.value[x].valueString			string
QuestionnaireResponse.item.answer.item		0..*	See item (QuestionnaireResponse)	Nested groups and questions
QuestionnaireResponse.item.item		0..*	See item (QuestionnaireResponse)	Nested questionnaire response items
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
QuestionnaireResponse.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
QuestionnaireResponse.​status	Base	required	QuestionnaireResponseStatus	📍4.0.1	FHIR Std.
QuestionnaireResponse.​item.answer.value[x]	Base	example	Questionnaire Answer Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
sa-qr-1	error	QuestionnaireResponse	QuestionnaireResponse.questionnaire SHALL be a canonical with a non-empty form URL, optionally followed by exactly one '|' and a non-empty form version, and SHALL NOT contain a fragment marker.	questionnaire.matches('^[^|#]+([|][^|#]+)?$')
sa-qr-2	warning	QuestionnaireResponse	QuestionnaireResponse.questionnaire SHALL be version-pinned (url|version) by FHIR-native clients. It MAY be unpinned only for submissions from the SOAP to FHIR Broker; this rule is enforced by the API against the authenticated client, so the profile only warns.	questionnaire.contains('|')
sa-qr-3	error	QuestionnaireResponse	Every answer SHALL be valueBoolean or valueString (Assumption 1), and an item SHALL carry at most one answer.	(item | item.repeat(item | answer.item)).all(answer.count() <= 1 and answer.all(value is boolean or value is string))
sa-qr-4	error	QuestionnaireResponse	The linkId of every answered item SHALL be a five character, zero padded criterionIdentifier (D18).	(item | item.repeat(item | answer.item)).where(answer.exists()).all(linkId.matches('^[0-9]{5}$'))

This structure is derived from QuestionnaireResponse

Summary

Mandatory: 4 elements
Must-Support: 13 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• SA Questionnaire (https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-questionnaire)
• SA Patient (https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-patient)
• SA Practitioner (https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-practitioner)

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/request-for-waiver
• https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/referring-practitioner

Other representations of profile: CSV, Excel, Schematron