Skip to main content

Questionnaire

Trial Use 3 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​

alphahttps://api.dev.ovok.com/fhir/R4/Questionnaire
InteractionMethodPath
ReadGET/fhir/R4/Questionnaire/[id]
VreadGET/fhir/R4/Questionnaire/[id]/_history/[vid]
UpdatePUT/fhir/R4/Questionnaire/[id]
PatchPATCH/fhir/R4/Questionnaire/[id]
DeleteDELETE/fhir/R4/Questionnaire/[id]
CreatePOST/fhir/R4/Questionnaire
SearchGET/fhir/R4/Questionnaire
HistoryGET/fhir/R4/Questionnaire/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
urluri0..1Canonical identifier for this questionnaire, represented as a URI (globally unique)
identifierIdentifier0..*Additional identifier for the questionnaire
versionstring0..1Business version of the questionnaire
namestring0..1Name for this questionnaire (computer friendly)
titlestring0..1Name for this questionnaire (human friendly)
derivedFromcanonical0..*Instantiates protocol or definition
statuscode1..1draft | active | retired | unknown modifier
experimentalboolean0..1For testing purposes, not real usage
subjectTypecode0..*Resource that can be subject of QuestionnaireResponse
datedateTime0..1Date last changed
publisherstring0..1Name of the publisher (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
approvalDatedate0..1When the questionnaire was approved by publisher
lastReviewDatedate0..1When the questionnaire was last reviewed
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
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
codestringhttp://hl7.org/fhir/SearchParameter/Questionnaire-code
contextstringhttp://hl7.org/fhir/SearchParameter/Questionnaire-context
context-quantitystringhttp://hl7.org/fhir/SearchParameter/Questionnaire-context-quantity
context-typestringhttp://hl7.org/fhir/SearchParameter/Questionnaire-context-type
context-type-quantitystringhttp://hl7.org/fhir/SearchParameter/Questionnaire-context-type-quantity
context-type-valuestringhttp://hl7.org/fhir/SearchParameter/Questionnaire-context-type-value
datestringhttp://hl7.org/fhir/SearchParameter/Questionnaire-date
definitionstringhttp://hl7.org/fhir/SearchParameter/Questionnaire-definition
descriptionstringhttp://hl7.org/fhir/SearchParameter/Questionnaire-description
effectivestringhttp://hl7.org/fhir/SearchParameter/Questionnaire-effective
identifierstringhttp://hl7.org/fhir/SearchParameter/Questionnaire-identifier
jurisdictionstringhttp://hl7.org/fhir/SearchParameter/Questionnaire-jurisdiction
namestringhttp://hl7.org/fhir/SearchParameter/Questionnaire-name
publisherstringhttp://hl7.org/fhir/SearchParameter/Questionnaire-publisher
statusstringhttp://hl7.org/fhir/SearchParameter/Questionnaire-status
subject-typestringhttp://hl7.org/fhir/SearchParameter/Questionnaire-subject-type
titlestringhttp://hl7.org/fhir/SearchParameter/Questionnaire-title
urlstringhttp://hl7.org/fhir/SearchParameter/Questionnaire-url
versionstringhttp://hl7.org/fhir/SearchParameter/Questionnaire-version

Reference​

  • Official FHIR R4 spec: Questionnaire
  • Maturity: Trial Use 3 (FMM 3).