Tiro.health Implementation Guide
0.1.0 - ci-build

Tiro.health Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Tiro Questionnaire $populate - XML Representation

Active as of 2026-04-30

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="TiroPopulate"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition TiroPopulate</b></p><a name="TiroPopulate"> </a><a name="hcTiroPopulate"> </a><p>URL: [base]/Questionnaire/$populate</p><p>URL: [base]/Questionnaire/[id]/$populate</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>questionnaire</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#canonical">canonical</a></td><td/><td><div><p>Canonical URL (optionally versioned) of the Questionnaire to populate. If the operation is invoked on a Questionnaire instance, this parameter is optional.</p>
</div></td></tr><tr><td>IN</td><td>subject</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/references.html#Reference">Reference</a></td><td/><td><div><p>Patient resource or reference used as the population subject.</p>
</div></td></tr><tr><td>IN</td><td>mode</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td/><td><div><p>Population mode: pre-populate | re-populate | contextual-populate. Defaults to pre-populate.</p>
</div></td></tr><tr><td>IN</td><td>context</td><td/><td>0..*</td><td/><td/><td><div><p>Named context groups providing data for population. For contextual-populate, include a group with name='clinical-artifacts'.</p>
</div></td></tr><tr><td>IN</td><td>context.name</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td/><td><div><p>Context group name (e.g. 'clinical-artifacts').</p>
</div></td></tr><tr><td>IN</td><td>context.content</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R5/references.html#Reference">Reference</a></td><td/><td><div><p>Content resource for this context group (e.g. a DocumentReference with an HTML or PDF attachment).</p>
</div></td></tr><tr><td>IN</td><td>responseCandidate</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/questionnaireresponse.html">QuestionnaireResponse</a></td><td/><td><div><p>Existing QuestionnaireResponse used as the base for re-populate mode.</p>
</div></td></tr><tr><td>OUT</td><td>response</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/questionnaireresponse.html">QuestionnaireResponse</a></td><td/><td><div><p>The populated QuestionnaireResponse.</p>
</div></td></tr><tr><td>OUT</td><td>issues</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/operationoutcome.html">OperationOutcome</a></td><td/><td><div><p>Issues encountered during population (warnings, errors).</p>
</div></td></tr><tr><td>OUT</td><td>provenance</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R5/provenance.html">Provenance</a></td><td/><td><div><p>One FormProvenance per populated field, describing how the value was obtained. Repeated — one entry per item. Each Provenance.target[0].extension[targetElement].valueUri points to the QuestionnaireResponse.item.id of the populated field.</p>
</div></td></tr></table></div>
  </text>
  <url value="http://fhir.tiro.health/OperationDefinition/TiroPopulate"/>
  <version value="0.1.0"/>
  <name value="TiroPopulate"/>
  <title value="Tiro Questionnaire $populate"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2026-04-30T09:19:32+00:00"/>
  <publisher value="Tiro.health"/>
  <contact>
    <name value="Tiro.health"/>
    <telecom>
      <system value="url"/>
      <value value="http://tiro.health"/>
    </telecom>
  </contact>
  <description
               value="Populate a Questionnaire with pre-existing data or AI-extracted values from clinical documents. Extends SDC Questionnaire/$populate with the contextual-populate mode and a provenance output parameter."/>
  <code value="populate"/>
  <resource value="Questionnaire"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="questionnaire"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Canonical URL (optionally versioned) of the Questionnaire to populate. If the operation is invoked on a Questionnaire instance, this parameter is optional."/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="subject"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Patient resource or reference used as the population subject."/>
    <type value="Reference"/>
  </parameter>
  <parameter>
    <name value="mode"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Population mode: pre-populate | re-populate | contextual-populate. Defaults to pre-populate."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="context"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="Named context groups providing data for population. For contextual-populate, include a group with name='clinical-artifacts'."/>
    <part>
      <name value="name"/>
      <use value="in"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="Context group name (e.g. 'clinical-artifacts')."/>
      <type value="string"/>
    </part>
    <part>
      <name value="content"/>
      <use value="in"/>
      <min value="0"/>
      <max value="*"/>
      <documentation
                     value="Content resource for this context group (e.g. a DocumentReference with an HTML or PDF attachment)."/>
      <type value="Reference"/>
    </part>
  </parameter>
  <parameter>
    <name value="responseCandidate"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Existing QuestionnaireResponse used as the base for re-populate mode."/>
    <type value="QuestionnaireResponse"/>
  </parameter>
  <parameter>
    <name value="response"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The populated QuestionnaireResponse."/>
    <type value="QuestionnaireResponse"/>
  </parameter>
  <parameter>
    <name value="issues"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Issues encountered during population (warnings, errors)."/>
    <type value="OperationOutcome"/>
  </parameter>
  <parameter>
    <name value="provenance"/>
    <use value="out"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="One FormProvenance per populated field, describing how the value was obtained. Repeated — one entry per item. Each Provenance.target[0].extension[targetElement].valueUri points to the QuestionnaireResponse.item.id of the populated field."/>
    <type value="Provenance"/>
  </parameter>
</OperationDefinition>