Da Vinci - Documentation Templates and Rules
2.2.0-snapshot - STU 2.2 - Peer Review
Da Vinci - Documentation Templates and Rules
2.2.0-snapshot - STU 2.2 - Peer Review
Da Vinci - Documentation Templates and Rules, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.2.0-snapshot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-dtr/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="questionnaire-package"/>
<language value="en"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition questionnaire-package</b></p><a name="questionnaire-package"> </a><a name="hcquestionnaire-package"> </a><p>URL: [base]/Questionnaire/$questionnaire-package</p><p>Input parameters Profile:<a href="StructureDefinition-dtr-qpackage-input-parameters.html">DTR Questionnaire Package Input Parameters</a></p><p>Output parameters Profile:<a href="StructureDefinition-dtr-qpackage-output-parameters.html">DTR Questionnaire Package Output Parameters</a></p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>coverage</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/coverage.html">Coverage</a></td><td/><td><div><p>Coverage resource instances to establish the member and the coverage for which documentation is to be collected.</p>
</div></td></tr><tr><td>IN</td><td>order</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/appointment.html">Appointment</a> | <a href="http://hl7.org/fhir/R4/encounter.html">Encounter</a> | <a href="http://hl7.org/fhir/R4/communicationrequest.html">CommunicationRequest</a> | <a href="http://hl7.org/fhir/R4/devicerequest.html">DeviceRequest</a> | <a href="http://hl7.org/fhir/R4/medicationrequest.html">MedicationRequest</a> | <a href="http://hl7.org/fhir/R4/nutritionorder.html">NutritionOrder</a> | <a href="http://hl7.org/fhir/R4/servicerequest.html">ServiceRequest</a> | <a href="http://hl7.org/fhir/R4/supplyrequest.html">SupplyRequest</a> | <a href="http://hl7.org/fhir/R4/visionprescription.html">VisionPrescription</a></td><td/><td><div><p>Order resource instances. e.g., DeviceRequest, ServiceRequest, MedicationRequest,... Encounter, Appointment, etc. to establish context for the information to be collected.</p>
</div></td></tr><tr><td>IN</td><td>questionnaire</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a> (<a href="StructureDefinition-dtr-std-questionnaire.html" title="http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-std-questionnaire">DTR Standard Questionnaire</a>)</td><td/><td><div><p>Canonical url for Questionnaire(s) (possibly version-specific) to return.</p>
</div></td></tr><tr><td>IN</td><td>context</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Context ID from CRD or CDex. May be used to determine what Questionnaires to return and/or to support pre-population.</p>
</div></td></tr><tr><td>IN</td><td>changedsince</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#instant">instant</a></td><td/><td><div><p>If present, only Questionnaire bundles whose Questionnaire or associated artifacts have changed since the specified timestamp. If there are no changed artifacts the operation will simply return a 200 Ok indicating that nothing has changed since the specified timestamp.</p>
</div></td></tr><tr><td>OUT</td><td>packagebundle</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>A Bundle with a single <code>Questionnaire</code>, a single <code>QuestionnaireResponse</code>, and 0..* Libraries containing needed CQL and/or ValueSets containing needed codes.</p>
</div></td></tr><tr><td>OUT</td><td>outcome</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/operationoutcome.html">OperationOutcome</a></td><td/><td><div><p>Warning or information messages related to the successful execution of the operation</p>
</div></td></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="cds"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="2">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"/>
</extension>
</valueInteger>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="trial-use">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"/>
</extension>
</valueCode>
</extension>
<url
value="http://hl7.org/fhir/us/davinci-dtr/OperationDefinition/questionnaire-package"/>
<version value="2.2.0-snapshot"/>
<name value="QuestionnairePackage"/>
<title value="Get Questionnaire Packge for given order(s)"/>
<status value="active"/>
<kind value="operation"/>
<date value="2026-02-12T19:03:37+00:00"/>
<publisher value="HL7 International / Clinical Decision Support"/>
<contact>
<name value="HL7 International / Clinical Decision Support"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/dss"/>
</telecom>
</contact>
<description
value="This operation returns one or more 'collection' Bundles each consisting of a single Questionnaire resource, a single QuestionnaireResponse resource, and any dependency Library and ValueSet instances needed to allow a renderer to fully render and otherwise process the Questionnaire.
oper-6^dtr-client^exchange:The operation **SHALL** take as input the Coverage resource(s) identifying the member and the type(s) of Coverage for which additional information is needed and at least one of:oper-6^dtr-client^exchange:The operation **SHALL** take as input the Coverage resource(s) identifying the member and the type(s) of Coverage for which additional information is needed and at least one of:jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<code value="questionnaire-package"/>
<resource value="Questionnaire"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<inputProfile
value="http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-qpackage-input-parameters"/>
<outputProfile
value="http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-qpackage-output-parameters"/>
<parameter>
<name value="coverage"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Coverage resource instances to establish the member and the coverage for which documentation is to be collected."/>
<type value="Coverage"/>
</parameter>
<parameter>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueUri value="Appointment"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueUri value="Encounter"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueUri value="CommunicationRequest"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueUri value="DeviceRequest"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueUri value="MedicationRequest"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueUri value="NutritionOrder"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueUri value="ServiceRequest"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueUri value="SupplyRequest"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
<valueUri value="VisionPrescription"/>
</extension>
<name value="order"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Order resource instances. e.g., DeviceRequest, ServiceRequest, MedicationRequest,... Encounter, Appointment, etc. to establish context for the information to be collected."/>
<type value="Resource"/>
</parameter>
<parameter>
<name value="questionnaire"/>
<use value="in"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Canonical url for Questionnaire(s) (possibly version-specific) to return."/>
<type value="canonical"/>
<targetProfile
value="http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-std-questionnaire"/>
</parameter>
<parameter>
<name value="context"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Context ID from CRD or CDex. May be used to determine what Questionnaires to return and/or to support pre-population."/>
<type value="string"/>
</parameter>
<parameter>
<name value="changedsince"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="If present, only Questionnaire bundles whose Questionnaire or associated artifacts have changed since the specified timestamp. If there are no changed artifacts the operation will simply return a 200 Ok indicating that nothing has changed since the specified timestamp."/>
<type value="instant"/>
</parameter>
<parameter>
<name value="packagebundle"/>
<use value="out"/>
<min value="0"/>
<max value="*"/>
<documentation
value="A Bundle with a single `Questionnaire`, a single `QuestionnaireResponse`, and 0..* Libraries containing needed CQL and/or ValueSets containing needed codes."/>
<type value="Bundle"/>
</parameter>
<parameter>
<name value="outcome"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Warning or information messages related to the successful execution of the operation"/>
<type value="OperationOutcome"/>
</parameter>
</OperationDefinition>
IG © 2022+ HL7 International / Clinical Decision Support.
Package hl7.fhir.us.davinci-dtr#2.2.0-snapshot based on FHIR 4.0.1.
Generated
2026-02-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change