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 |
{
"resourceType" : "OperationDefinition",
"id" : "questionnaire-package",
"language" : "en",
"text" : {
"status" : "generated",
"div" : "<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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></table></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"
}
]
}
}
],
"url" : "http://hl7.org/fhir/us/davinci-dtr/OperationDefinition/questionnaire-package",
"version" : "2.2.0-snapshot",
"name" : "QuestionnairePackage",
"title" : "Get Questionnaire Packge for given order(s)",
"status" : "active",
"kind" : "operation",
"date" : "2026-02-12T19:03:37+00:00",
"publisher" : "HL7 International / Clinical Decision Support",
"contact" : [
{
"name" : "HL7 International / Clinical Decision Support",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss"
}
]
}
],
"description" : "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.\n\noper-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" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"code" : "questionnaire-package",
"resource" : [
"Questionnaire"
],
"system" : false,
"type" : true,
"instance" : false,
"inputProfile" : "http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-qpackage-input-parameters",
"outputProfile" : "http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-qpackage-output-parameters",
"parameter" : [
{
"name" : "coverage",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Coverage resource instances to establish the member and the coverage for which documentation is to be collected.",
"type" : "Coverage"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
"valueUri" : "Appointment"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
"valueUri" : "Encounter"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
"valueUri" : "CommunicationRequest"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
"valueUri" : "DeviceRequest"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
"valueUri" : "MedicationRequest"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
"valueUri" : "NutritionOrder"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
"valueUri" : "ServiceRequest"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
"valueUri" : "SupplyRequest"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
"valueUri" : "VisionPrescription"
}
],
"name" : "order",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Order resource instances. e.g., DeviceRequest, ServiceRequest, MedicationRequest,... Encounter, Appointment, etc. to establish context for the information to be collected.",
"type" : "Resource"
},
{
"name" : "questionnaire",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "Canonical url for Questionnaire(s) (possibly version-specific) to return.",
"type" : "canonical",
"targetProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-std-questionnaire"
]
},
{
"name" : "context",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Context ID from CRD or CDex. May be used to determine what Questionnaires to return and/or to support pre-population.",
"type" : "string"
},
{
"name" : "changedsince",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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" : "instant"
},
{
"name" : "packagebundle",
"use" : "out",
"min" : 0,
"max" : "*",
"documentation" : "A Bundle with a single `Questionnaire`, a single `QuestionnaireResponse`, and 0..* Libraries containing needed CQL and/or ValueSets containing needed codes.",
"type" : "Bundle"
},
{
"name" : "outcome",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Warning or information messages related to the successful execution of the operation",
"type" : "OperationOutcome"
}
]
}
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