Special Authority FHIR Implementation Guide
0.1.2 - draft
Special Authority FHIR Implementation Guide
0.1.2 - draft
Special Authority FHIR Implementation Guide - Local Development build (v0.1.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-questionnaire | Version: 0.1.2 | |||
| Draft as of 2026-10-21 | Computable Name: SAQuestionnaire | |||
The Health NZ interpretation of a Pharmac Special Authority form at a point in time.
Phase 1: the Questionnaire canonical is an identifier, not a resolvable address. No Questionnaire resource is
published at the canonical URL in Phase 1; form definitions continue to be distributed in their
existing XML format. This profile documents the constraints the canonical and linkId values must satisfy.
url is https://fhir-ig.digital.health.nz/special-authority/Questionnaire/{formNumber} and SHALL NOT contain | or #.version is the form version (a truncated hash of the form definition) and SHALL be identical, character
for character, to the form version in QuestionnaireResponse.questionnaire. No case folding, trimming or normalisation.linkId of each criterion is the criterionIdentifier: five characters, zero padded, numeric.required, so a partial QuestionnaireResponse is valid against the profile.Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Questionnaire |
C | 0..* | Questionnaire | A structured set of questions Constraints: que-0, que-2, sa-q-1, sa-q-2, sa-q-3, sa-q-4, sa-q-5 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| url |
1..1 | uri | Canonical of the form: .../Questionnaire/{formNumber} | |
| version |
1..1 | string | Form version - identical to the version in QuestionnaireResponse.questionnaire | |
| name |
C | 0..1 | string | Name for this questionnaire (computer friendly) |
| title |
0..1 | string | Name for this questionnaire (human friendly) | |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |
  item |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13 |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| linkId |
1..1 | string | criterionIdentifier (five character, zero padded) for boolean/string items | |
| text |
0..1 | string | Primary text for the item | |
| type |
1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | |
 enableWhen |
C | 0..* | BackboneElement | Only allow data when Constraints: que-7 |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| question |
1..1 | string | Question that determines whether item is enabled | |
| operator |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
 answer[x] |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| answerBoolean |
boolean | |||
| answerDecimal |
decimal | |||
| answerInteger |
integer | |||
| answerDate |
date | |||
| answerDateTime |
dateTime | |||
| answerTime |
time | |||
| answerString |
string | |||
| answerCoding |
Coding | |||
| answerQuantity |
Quantity | |||
  answerReference |
Reference(Resource) | |||
| required |
C | 0..1 | boolean | SHALL NOT be true for criteria items |
| answerValueSet |
C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers |
| answerOption |
C | 0..* | BackboneElement | Permitted answer |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| value[x] |
1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueCoding |
Coding | |||
| valueReference |
Reference(Resource) | |||
| initial |
C | 0..* | BackboneElement | Initial value(s) when item is first rendered |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| value[x] |
1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
| valueBoolean |
boolean | |||
| valueDecimal |
decimal | |||
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueUri |
uri | |||
| valueAttachment |
Attachment | |||
| valueCoding |
Coding | |||
| valueQuantity |
Quantity | |||
| valueReference |
Reference(Resource) | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Questionnaire.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.type | Base | required | QuestionnaireItemType | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableWhen.operator | Base | required | QuestionnaireItemOperator | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableWhen.answer[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.answerOption.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.initial.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| sa-q-1 | error | Questionnaire | Questionnaire.url SHALL NOT contain a pipe ('|') or a fragment marker ('#'). |
url.contains('|').not() and url.contains('#').not()
|
| sa-q-2 | warning | Questionnaire | Questionnaire.url SHOULD sit under the Special Authority Questionnaire canonical base. |
url.startsWith('https://fhir-ig.digital.health.nz/special-authority/Questionnaire/')
|
| sa-q-3 | error | Questionnaire | Only group, display, boolean and string items are permitted. |
repeat(item).all(type = 'group' or type = 'display' or type = 'boolean' or type = 'string')
|
| sa-q-4 | error | Questionnaire | The linkId of every boolean or string item SHALL be a criterionIdentifier: a five character, zero padded numeric string. |
repeat(item).where(type = 'boolean' or type = 'string').all(linkId.matches('^[0-9]{5}$'))
|
| sa-q-5 | error | Questionnaire | Criteria items SHALL NOT be marked required, so that a partial QuestionnaireResponse is valid against the profile. |
repeat(item).where(type = 'boolean' or type = 'string').all(required.exists().not() or required = false)
|
This structure is derived from Questionnaire
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Questionnaire |
C | 0..* | Questionnaire | A structured set of questions Constraints: sa-q-1, sa-q-2, sa-q-3, sa-q-4, sa-q-5 |
 url |
1..1 | uri | Canonical of the form: .../Questionnaire/{formNumber} | |
| version |
1..1 | string | Form version - identical to the version in QuestionnaireResponse.questionnaire | |
| name |
0..1 | string | Name for this questionnaire (computer friendly) | |
| title |
0..1 | string | Name for this questionnaire (human friendly) | |
| status |
1..1 | code | draft | active | retired | unknown | |
| item |
0..* | BackboneElement | Questions and sections within the Questionnaire | |
| linkId |
1..1 | string | criterionIdentifier (five character, zero padded) for boolean/string items | |
| text |
0..1 | string | Primary text for the item | |
| type |
1..1 | code | group | display | boolean | decimal | integer | date | dateTime + | |
| required |
0..1 | boolean | SHALL NOT be true for criteria items | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| sa-q-1 | error | Questionnaire | Questionnaire.url SHALL NOT contain a pipe ('|') or a fragment marker ('#'). |
url.contains('|').not() and url.contains('#').not()
|
| sa-q-2 | warning | Questionnaire | Questionnaire.url SHOULD sit under the Special Authority Questionnaire canonical base. |
url.startsWith('https://fhir-ig.digital.health.nz/special-authority/Questionnaire/')
|
| sa-q-3 | error | Questionnaire | Only group, display, boolean and string items are permitted. |
repeat(item).all(type = 'group' or type = 'display' or type = 'boolean' or type = 'string')
|
| sa-q-4 | error | Questionnaire | The linkId of every boolean or string item SHALL be a criterionIdentifier: a five character, zero padded numeric string. |
repeat(item).where(type = 'boolean' or type = 'string').all(linkId.matches('^[0-9]{5}$'))
|
| sa-q-5 | error | Questionnaire | Criteria items SHALL NOT be marked required, so that a partial QuestionnaireResponse is valid against the profile. |
repeat(item).where(type = 'boolean' or type = 'string').all(required.exists().not() or required = false)
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | Questionnaire | A structured set of questions Constraints: que-0, que-2, sa-q-1, sa-q-2, sa-q-3, sa-q-4, sa-q-5 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| url |
1..1 | uri | Canonical of the form: .../Questionnaire/{formNumber} | |||||
| identifier |
0..* | Identifier | Additional identifier for the questionnaire | |||||
| version |
1..1 | string | Form version - identical to the version in QuestionnaireResponse.questionnaire | |||||
| name |
C | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title |
0..1 | string | Name for this questionnaire (human friendly) | |||||
| derivedFrom |
0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |||||
| experimental |
0..1 | boolean | For testing purposes, not real usage | |||||
| subjectType |
0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | |||||
| date |
0..1 | dateTime | Date last changed | |||||
| publisher |
0..1 | string | Name of the publisher (organization or individual) | |||||
| contact |
0..* | ContactDetail | Contact details for the publisher | |||||
| description |
0..1 | markdown | Natural language description of the questionnaire | |||||
| useContext |
0..* | UsageContext | The context that the content is intended to support | |||||
| jurisdiction |
0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | |||||
| purpose |
0..1 | markdown | Why this questionnaire is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the questionnaire was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the questionnaire was last reviewed | |||||
| effectivePeriod |
0..1 | Period | When the questionnaire is expected to be used | |||||
| code |
0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | |||||
| item |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| linkId |
1..1 | string | criterionIdentifier (five character, zero padded) for boolean/string items | |||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |||||
| code |
C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| prefix |
0..1 | string | E.g. "1(a)", "2.5.3" | |||||
| text |
0..1 | string | Primary text for the item | |||||
| type |
1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | |||||
| enableWhen |
C | 0..* | BackboneElement | Only allow data when Constraints: que-7 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| question |
1..1 | string | Question that determines whether item is enabled | |||||
| operator |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |||||
| answer[x] |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| answerBoolean |
boolean | |||||||
| answerDecimal |
decimal | |||||||
| answerInteger |
integer | |||||||
| answerDate |
date | |||||||
| answerDateTime |
dateTime | |||||||
| answerTime |
time | |||||||
| answerString |
string | |||||||
| answerCoding |
Coding | |||||||
| answerQuantity |
Quantity | |||||||
| answerReference |
Reference(Resource) | |||||||
| enableBehavior |
C | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
| required |
C | 0..1 | boolean | SHALL NOT be true for criteria items | ||||
| repeats |
C | 0..1 | boolean | Whether the item may repeat | ||||
| readOnly |
C | 0..1 | boolean | Don't allow human editing | ||||
| maxLength |
C | 0..1 | integer | No more than this many characters | ||||
| answerValueSet |
C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers | ||||
| answerOption |
C | 0..* | BackboneElement | Permitted answer | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| value[x] |
1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueCoding |
Coding | |||||||
| valueReference |
Reference(Resource) | |||||||
| initialSelected |
0..1 | boolean | Whether option is selected by default | |||||
| initial |
C | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| value[x] |
1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||||||
| valueBoolean |
boolean | |||||||
| valueDecimal |
decimal | |||||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueUri |
uri | |||||||
| valueAttachment |
Attachment | |||||||
| valueCoding |
Coding | |||||||
| valueQuantity |
Quantity | |||||||
| valueReference |
Reference(Resource) | |||||||
| item |
C | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Questionnaire.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Questionnaire.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Questionnaire.subjectType | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
| Questionnaire.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| Questionnaire.code | Base | example | Questionnaire Question Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.code | Base | example | Questionnaire Question Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.type | Base | required | QuestionnaireItemType | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableWhen.operator | Base | required | QuestionnaireItemOperator | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableWhen.answer[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableBehavior | Base | required | EnableWhenBehavior | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.answerOption.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.initial.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| sa-q-1 | error | Questionnaire | Questionnaire.url SHALL NOT contain a pipe ('|') or a fragment marker ('#'). |
url.contains('|').not() and url.contains('#').not()
|
| sa-q-2 | warning | Questionnaire | Questionnaire.url SHOULD sit under the Special Authority Questionnaire canonical base. |
url.startsWith('https://fhir-ig.digital.health.nz/special-authority/Questionnaire/')
|
| sa-q-3 | error | Questionnaire | Only group, display, boolean and string items are permitted. |
repeat(item).all(type = 'group' or type = 'display' or type = 'boolean' or type = 'string')
|
| sa-q-4 | error | Questionnaire | The linkId of every boolean or string item SHALL be a criterionIdentifier: a five character, zero padded numeric string. |
repeat(item).where(type = 'boolean' or type = 'string').all(linkId.matches('^[0-9]{5}$'))
|
| sa-q-5 | error | Questionnaire | Criteria items SHALL NOT be marked required, so that a partial QuestionnaireResponse is valid against the profile. |
repeat(item).where(type = 'boolean' or type = 'string').all(required.exists().not() or required = false)
|
This structure is derived from Questionnaire
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Questionnaire |
C | 0..* | Questionnaire | A structured set of questions Constraints: que-0, que-2, sa-q-1, sa-q-2, sa-q-3, sa-q-4, sa-q-5 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| url |
1..1 | uri | Canonical of the form: .../Questionnaire/{formNumber} | |
| version |
1..1 | string | Form version - identical to the version in QuestionnaireResponse.questionnaire | |
| name |
C | 0..1 | string | Name for this questionnaire (computer friendly) |
| title |
0..1 | string | Name for this questionnaire (human friendly) | |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |
| item |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| linkId |
1..1 | string | criterionIdentifier (five character, zero padded) for boolean/string items | |
| text |
0..1 | string | Primary text for the item | |
| type |
1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | |
| enableWhen |
C | 0..* | BackboneElement | Only allow data when Constraints: que-7 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| question |
1..1 | string | Question that determines whether item is enabled | |
| operator |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |
| answer[x] |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |
| answerBoolean |
boolean | |||
| answerDecimal |
decimal | |||
| answerInteger |
integer | |||
| answerDate |
date | |||
| answerDateTime |
dateTime | |||
| answerTime |
time | |||
| answerString |
string | |||
| answerCoding |
Coding | |||
| answerQuantity |
Quantity | |||
| answerReference |
Reference(Resource) | |||
| required |
C | 0..1 | boolean | SHALL NOT be true for criteria items |
| answerValueSet |
C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers |
| answerOption |
C | 0..* | BackboneElement | Permitted answer |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| value[x] |
1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueCoding |
Coding | |||
| valueReference |
Reference(Resource) | |||
| initial |
C | 0..* | BackboneElement | Initial value(s) when item is first rendered |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| value[x] |
1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||
| valueBoolean |
boolean | |||
| valueDecimal |
decimal | |||
| valueInteger |
integer | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueTime |
time | |||
| valueString |
string | |||
| valueUri |
uri | |||
| valueAttachment |
Attachment | |||
| valueCoding |
Coding | |||
| valueQuantity |
Quantity | |||
| valueReference |
Reference(Resource) | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Questionnaire.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.type | Base | required | QuestionnaireItemType | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableWhen.operator | Base | required | QuestionnaireItemOperator | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableWhen.answer[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.answerOption.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.initial.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| sa-q-1 | error | Questionnaire | Questionnaire.url SHALL NOT contain a pipe ('|') or a fragment marker ('#'). |
url.contains('|').not() and url.contains('#').not()
|
| sa-q-2 | warning | Questionnaire | Questionnaire.url SHOULD sit under the Special Authority Questionnaire canonical base. |
url.startsWith('https://fhir-ig.digital.health.nz/special-authority/Questionnaire/')
|
| sa-q-3 | error | Questionnaire | Only group, display, boolean and string items are permitted. |
repeat(item).all(type = 'group' or type = 'display' or type = 'boolean' or type = 'string')
|
| sa-q-4 | error | Questionnaire | The linkId of every boolean or string item SHALL be a criterionIdentifier: a five character, zero padded numeric string. |
repeat(item).where(type = 'boolean' or type = 'string').all(linkId.matches('^[0-9]{5}$'))
|
| sa-q-5 | error | Questionnaire | Criteria items SHALL NOT be marked required, so that a partial QuestionnaireResponse is valid against the profile. |
repeat(item).where(type = 'boolean' or type = 'string').all(required.exists().not() or required = false)
|
Differential View
This structure is derived from Questionnaire
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Questionnaire |
C | 0..* | Questionnaire | A structured set of questions Constraints: sa-q-1, sa-q-2, sa-q-3, sa-q-4, sa-q-5 |
| url |
1..1 | uri | Canonical of the form: .../Questionnaire/{formNumber} | |
| version |
1..1 | string | Form version - identical to the version in QuestionnaireResponse.questionnaire | |
| name |
0..1 | string | Name for this questionnaire (computer friendly) | |
| title |
0..1 | string | Name for this questionnaire (human friendly) | |
| status |
1..1 | code | draft | active | retired | unknown | |
| item |
0..* | BackboneElement | Questions and sections within the Questionnaire | |
| linkId |
1..1 | string | criterionIdentifier (five character, zero padded) for boolean/string items | |
| text |
0..1 | string | Primary text for the item | |
| type |
1..1 | code | group | display | boolean | decimal | integer | date | dateTime + | |
| required |
0..1 | boolean | SHALL NOT be true for criteria items | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| sa-q-1 | error | Questionnaire | Questionnaire.url SHALL NOT contain a pipe ('|') or a fragment marker ('#'). |
url.contains('|').not() and url.contains('#').not()
|
| sa-q-2 | warning | Questionnaire | Questionnaire.url SHOULD sit under the Special Authority Questionnaire canonical base. |
url.startsWith('https://fhir-ig.digital.health.nz/special-authority/Questionnaire/')
|
| sa-q-3 | error | Questionnaire | Only group, display, boolean and string items are permitted. |
repeat(item).all(type = 'group' or type = 'display' or type = 'boolean' or type = 'string')
|
| sa-q-4 | error | Questionnaire | The linkId of every boolean or string item SHALL be a criterionIdentifier: a five character, zero padded numeric string. |
repeat(item).where(type = 'boolean' or type = 'string').all(linkId.matches('^[0-9]{5}$'))
|
| sa-q-5 | error | Questionnaire | Criteria items SHALL NOT be marked required, so that a partial QuestionnaireResponse is valid against the profile. |
repeat(item).where(type = 'boolean' or type = 'string').all(required.exists().not() or required = false)
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Questionnaire |
C | 0..* | Questionnaire | A structured set of questions Constraints: que-0, que-2, sa-q-1, sa-q-2, sa-q-3, sa-q-4, sa-q-5 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| url |
1..1 | uri | Canonical of the form: .../Questionnaire/{formNumber} | |||||
| identifier |
0..* | Identifier | Additional identifier for the questionnaire | |||||
| version |
1..1 | string | Form version - identical to the version in QuestionnaireResponse.questionnaire | |||||
| name |
C | 0..1 | string | Name for this questionnaire (computer friendly) | ||||
| title |
0..1 | string | Name for this questionnaire (human friendly) | |||||
| derivedFrom |
0..* | canonical(Questionnaire) | Instantiates protocol or definition | |||||
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |||||
| experimental |
0..1 | boolean | For testing purposes, not real usage | |||||
| subjectType |
0..* | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | |||||
| date |
0..1 | dateTime | Date last changed | |||||
| publisher |
0..1 | string | Name of the publisher (organization or individual) | |||||
| contact |
0..* | ContactDetail | Contact details for the publisher | |||||
| description |
0..1 | markdown | Natural language description of the questionnaire | |||||
| useContext |
0..* | UsageContext | The context that the content is intended to support | |||||
| jurisdiction |
0..* | CodeableConcept | Intended jurisdiction for questionnaire (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | |||||
| purpose |
0..1 | markdown | Why this questionnaire is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the questionnaire was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the questionnaire was last reviewed | |||||
| effectivePeriod |
0..1 | Period | When the questionnaire is expected to be used | |||||
| code |
0..* | Coding | Concept that represents the overall questionnaire Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | |||||
| item |
C | 0..* | BackboneElement | Questions and sections within the Questionnaire Constraints: que-1, que-3, que-4, que-5, que-6, que-8, que-9, que-10, que-11, que-12, que-13 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| linkId |
1..1 | string | criterionIdentifier (five character, zero padded) for boolean/string items | |||||
| definition |
0..1 | uri | ElementDefinition - details for the item | |||||
| code |
C | 0..* | Coding | Corresponding concept for this item in a terminology Binding: QuestionnaireQuestionCodes (example): Codes for questionnaires, groups and individual questions. | ||||
| prefix |
0..1 | string | E.g. "1(a)", "2.5.3" | |||||
| text |
0..1 | string | Primary text for the item | |||||
| type |
1..1 | code | group | display | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions. | |||||
| enableWhen |
C | 0..* | BackboneElement | Only allow data when Constraints: que-7 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| question |
1..1 | string | Question that determines whether item is enabled | |||||
| operator |
1..1 | code | exists | = | != | > | < | >= | <= Binding: QuestionnaireItemOperator (required): The criteria by which a question is enabled. | |||||
| answer[x] |
C | 1..1 | Value for question comparison based on operator Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | |||||
| answerBoolean |
boolean | |||||||
| answerDecimal |
decimal | |||||||
| answerInteger |
integer | |||||||
| answerDate |
date | |||||||
| answerDateTime |
dateTime | |||||||
| answerTime |
time | |||||||
| answerString |
string | |||||||
| answerCoding |
Coding | |||||||
| answerQuantity |
Quantity | |||||||
| answerReference |
Reference(Resource) | |||||||
| enableBehavior |
C | 0..1 | code | all | any Binding: EnableWhenBehavior (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true. | ||||
| required |
C | 0..1 | boolean | SHALL NOT be true for criteria items | ||||
| repeats |
C | 0..1 | boolean | Whether the item may repeat | ||||
| readOnly |
C | 0..1 | boolean | Don't allow human editing | ||||
| maxLength |
C | 0..1 | integer | No more than this many characters | ||||
| answerValueSet |
C | 0..1 | canonical(ValueSet) | Valueset containing permitted answers | ||||
| answerOption |
C | 0..* | BackboneElement | Permitted answer | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| value[x] |
1..1 | Answer value Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueCoding |
Coding | |||||||
| valueReference |
Reference(Resource) | |||||||
| initialSelected |
0..1 | boolean | Whether option is selected by default | |||||
| initial |
C | 0..* | BackboneElement | Initial value(s) when item is first rendered | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| value[x] |
1..1 | Actual value for initializing the question Binding: QuestionnaireAnswerCodes (example): Allowed values to answer questions. | ||||||
| valueBoolean |
boolean | |||||||
| valueDecimal |
decimal | |||||||
| valueInteger |
integer | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueTime |
time | |||||||
| valueString |
string | |||||||
| valueUri |
uri | |||||||
| valueAttachment |
Attachment | |||||||
| valueCoding |
Coding | |||||||
| valueQuantity |
Quantity | |||||||
| valueReference |
Reference(Resource) | |||||||
| item |
C | 0..* | See item (Questionnaire) | Nested questionnaire items | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Questionnaire.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Questionnaire.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Questionnaire.subjectType | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
| Questionnaire.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| Questionnaire.code | Base | example | Questionnaire Question Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.code | Base | example | Questionnaire Question Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.type | Base | required | QuestionnaireItemType | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableWhen.operator | Base | required | QuestionnaireItemOperator | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableWhen.answer[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.enableBehavior | Base | required | EnableWhenBehavior | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.answerOption.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Questionnaire.item.initial.value[x] | Base | example | Questionnaire Answer Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| sa-q-1 | error | Questionnaire | Questionnaire.url SHALL NOT contain a pipe ('|') or a fragment marker ('#'). |
url.contains('|').not() and url.contains('#').not()
|
| sa-q-2 | warning | Questionnaire | Questionnaire.url SHOULD sit under the Special Authority Questionnaire canonical base. |
url.startsWith('https://fhir-ig.digital.health.nz/special-authority/Questionnaire/')
|
| sa-q-3 | error | Questionnaire | Only group, display, boolean and string items are permitted. |
repeat(item).all(type = 'group' or type = 'display' or type = 'boolean' or type = 'string')
|
| sa-q-4 | error | Questionnaire | The linkId of every boolean or string item SHALL be a criterionIdentifier: a five character, zero padded numeric string. |
repeat(item).where(type = 'boolean' or type = 'string').all(linkId.matches('^[0-9]{5}$'))
|
| sa-q-5 | error | Questionnaire | Criteria items SHALL NOT be marked required, so that a partial QuestionnaireResponse is valid against the profile. |
repeat(item).where(type = 'boolean' or type = 'string').all(required.exists().not() or required = false)
|
This structure is derived from Questionnaire
Other representations of profile: CSV, Excel, Schematron