# Questionnaire

Canonical page: https://docs.ovok.com/api/fhir/r4/questionnaire

A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/Questionnaire/[id]` |
| Vread | `GET` | `/fhir/R4/Questionnaire/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Questionnaire/[id]` |
| Patch | `PATCH` | `/fhir/R4/Questionnaire/[id]` |
| Delete | `DELETE` | `/fhir/R4/Questionnaire/[id]` |
| Create | `POST` | `/fhir/R4/Questionnaire` |
| Search | `GET` | `/fhir/R4/Questionnaire` |
| History | `GET` | `/fhir/R4/Questionnaire/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-url"></span>`url` | [uri](/fhir-elements/primitive/uri) | `0..1` | Canonical identifier for this questionnaire, represented as a URI (globally unique) |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Additional identifier for the questionnaire |
| <span id="element-version"></span>`version` | [string](/fhir-elements/primitive/string) | `0..1` | Business version of the questionnaire |
| <span id="element-name"></span>`name` | [string](/fhir-elements/primitive/string) | `0..1` | Name for this questionnaire (computer friendly) |
| <span id="element-title"></span>`title` | [string](/fhir-elements/primitive/string) | `0..1` | Name for this questionnaire (human friendly) |
| <span id="element-derived-from"></span>`derivedFrom` | [canonical](/fhir-elements/primitive/canonical) | `0..*` | Instantiates protocol or definition |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | draft \| active \| retired \| unknown |
| <span id="element-experimental"></span>`experimental` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | For testing purposes, not real usage |
| <span id="element-subject-type"></span>`subjectType` | [code](/fhir-elements/primitive/code) | `0..*` | Resource that can be subject of QuestionnaireResponse |
| <span id="element-date"></span>`date` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Date last changed |
| <span id="element-publisher"></span>`publisher` | [string](/fhir-elements/primitive/string) | `0..1` | Name of the publisher (organization or individual) |
| <span id="element-contact"></span>`contact` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Contact details for the publisher |
| <span id="element-description"></span>`description` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Natural language description of the questionnaire |
| <span id="element-use-context"></span>`useContext` | [UsageContext](/fhir-elements/complex/usage-context) | `0..*` | The context that the content is intended to support |
| <span id="element-jurisdiction"></span>`jurisdiction` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Intended jurisdiction for questionnaire (if applicable) |
| <span id="element-purpose"></span>`purpose` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Why this questionnaire is defined |
| <span id="element-copyright"></span>`copyright` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Use and/or publishing restrictions |
| <span id="element-approval-date"></span>`approvalDate` | [date](/fhir-elements/primitive/date) | `0..1` | When the questionnaire was approved by publisher |
| <span id="element-last-review-date"></span>`lastReviewDate` | [date](/fhir-elements/primitive/date) | `0..1` | When the questionnaire was last reviewed |
| <span id="element-effective-period"></span>`effectivePeriod` | [Period](/fhir-elements/complex/period) | `0..1` | When the questionnaire is expected to be used |
| <span id="element-code"></span>`code` | [Coding](/fhir-elements/complex/coding) | `0..*` | Concept that represents the overall questionnaire |
| <span id="element-item"></span>`item` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Questions and sections within the Questionnaire |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `code` | token | A code that corresponds to one of its items in the questionnaire |
| `context` | token | A use context assigned to the questionnaire |
| `context-quantity` | quantity | A quantity- or range-valued use context assigned to the questionnaire |
| `context-type` | token | A type of use context assigned to the questionnaire |
| `context-type-quantity` | composite | A use context type and quantity- or range-based value assigned to the questionnaire |
| `context-type-value` | composite | A use context type and value assigned to the questionnaire |
| `date` | date | The questionnaire publication date |
| `definition` | uri | ElementDefinition - details for the item |
| `description` | string | The description of the questionnaire |
| `effective` | date | The time during which the questionnaire is intended to be in use |
| `identifier` | token | External identifier for the questionnaire |
| `jurisdiction` | token | Intended jurisdiction for the questionnaire |
| `name` | string | Computationally friendly name of the questionnaire |
| `publisher` | string | Name of the publisher of the questionnaire |
| `status` | token | The current status of the questionnaire |
| `subject-type` | token | Resource that can be subject of QuestionnaireResponse |
| `title` | string | The human-friendly name of the questionnaire |
| `url` | uri | The uri that identifies the questionnaire |
| `version` | token | The business version of the questionnaire |

## Reference [#reference]

Official FHIR R4 spec: [Questionnaire](https://hl7.org/fhir/R4/questionnaire.html).  
Maturity: Trial Use 3 (FMM 3).
