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 - JSON Representation

Active as of 2026-04-30

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "TiroPopulate",
  "text" : {
    "status" : "generated",
    "div" : "<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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></table></div>"
  },
  "url" : "http://fhir.tiro.health/OperationDefinition/TiroPopulate",
  "version" : "0.1.0",
  "name" : "TiroPopulate",
  "title" : "Tiro Questionnaire $populate",
  "status" : "active",
  "kind" : "operation",
  "date" : "2026-04-30T09:19:32+00:00",
  "publisher" : "Tiro.health",
  "contact" : [
    {
      "name" : "Tiro.health",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://tiro.health"
        }
      ]
    }
  ],
  "description" : "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" : "populate",
  "resource" : [
    "Questionnaire"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "questionnaire",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Canonical URL (optionally versioned) of the Questionnaire to populate. If the operation is invoked on a Questionnaire instance, this parameter is optional.",
      "type" : "canonical"
    },
    {
      "name" : "subject",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Patient resource or reference used as the population subject.",
      "type" : "Reference"
    },
    {
      "name" : "mode",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Population mode: pre-populate | re-populate | contextual-populate. Defaults to pre-populate.",
      "type" : "string"
    },
    {
      "name" : "context",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Named context groups providing data for population. For contextual-populate, include a group with name='clinical-artifacts'.",
      "part" : [
        {
          "name" : "name",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "Context group name (e.g. 'clinical-artifacts').",
          "type" : "string"
        },
        {
          "name" : "content",
          "use" : "in",
          "min" : 0,
          "max" : "*",
          "documentation" : "Content resource for this context group (e.g. a DocumentReference with an HTML or PDF attachment).",
          "type" : "Reference"
        }
      ]
    },
    {
      "name" : "responseCandidate",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Existing QuestionnaireResponse used as the base for re-populate mode.",
      "type" : "QuestionnaireResponse"
    },
    {
      "name" : "response",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The populated QuestionnaireResponse.",
      "type" : "QuestionnaireResponse"
    },
    {
      "name" : "issues",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "Issues encountered during population (warnings, errors).",
      "type" : "OperationOutcome"
    },
    {
      "name" : "provenance",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "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" : "Provenance"
    }
  ]
}