Skip to main content

Questionnaire

Normative Clinical — Diagnostics

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.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/Questionnaire
InteractionMethodPath
ReadGET/fhir/R5/Questionnaire/[id]
VreadGET/fhir/R5/Questionnaire/[id]/_history/[vid]
UpdatePUT/fhir/R5/Questionnaire/[id]
PatchPATCH/fhir/R5/Questionnaire/[id]
DeleteDELETE/fhir/R5/Questionnaire/[id]
CreatePOST/fhir/R5/Questionnaire
SearchGET/fhir/R5/Questionnaire?...
HistoryGET/fhir/R5/Questionnaire/[id]/_history
Type-historyGET/fhir/R5/Questionnaire/_history

Top-level elements

ElementType(s)CardinalityDescription
urluri0..1Canonical identifier for this questionnaire, represented as an absolute URI (globally unique)
identifierIdentifier0..*Business identifier for questionnaire
versionstring0..1Business version of the questionnaire
versionAlgorithm[x]string / Coding0..1How to compare versions
namestring0..1Name for this questionnaire (computer friendly)
titlestring0..1Name for this questionnaire (human friendly)
derivedFromcanonical0..*Based on Questionnaire
statuscode1..1draft
experimentalboolean0..1For testing purposes, not real usage
subjectTypecode0..*Resource that can be subject of QuestionnaireResponse
datedateTime0..1Date last changed
publisherstring0..1Name of the publisher/steward (organization or individual)
contactContactDetail0..*Contact details for the publisher
descriptionmarkdown0..1Natural language description of the questionnaire
useContextUsageContext0..*The context that the content is intended to support
jurisdictionCodeableConcept0..*Intended jurisdiction for questionnaire (if applicable)
purposemarkdown0..1Why this questionnaire is defined
copyrightmarkdown0..1Use and/or publishing restrictions
copyrightLabelstring0..1Copyright holder and year(s)
approvalDatedate0..1When the questionnaire was approved by publisher
lastReviewDatedate0..1When the questionnaire was last reviewed by the publisher
effectivePeriodPeriod0..1When the questionnaire is expected to be used
codeCoding0..*Concept that represents the overall questionnaire
itemBackboneElement0..*Questions and sections within the Questionnaire

Resource-specific search parameters

ParameterTypeDescription
combo-codetokenA code that corresponds to one of its items in the questionnaire
contexttokenA use context assigned to the activity definition
context-quantityquantityA quantity- or range-valued use context assigned to the activity definition
context-typetokenA type of use context assigned to the activity definition
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the activity definition
context-type-valuecompositeA use context type and value assigned to the activity definition
datedateThe activity definition publication date
definitionuriElementDefinition - details for the item
descriptionstringThe description of the activity definition
effectivedateThe time during which the activity definition is intended to be in use
identifiertokenExternal identifier for the activity definition
item-codetokenA code that corresponds to one of the items in the questionnaire
jurisdictiontokenIntended jurisdiction for the activity definition
namestringComputationally friendly name of the activity definition
publisherstringName of the publisher of the activity definition
questionnaire-codetokenA code that matches one of the Questionnaire.code codings
statustokenThe current status of the activity definition
subject-typetokenResource that can be subject of QuestionnaireResponse
titlestringThe human-friendly name of the activity definition
urluriThe uri that identifies the activity definition
versiontokenThe business version of the activity definition

Reference

  • Official FHIR R5 spec: Questionnaire
  • Maturity: Normative (FMM 5).