Ontario Health eForms Implementation Guide
0.1.0 - ci-build
CA-ON
Ontario Health eForms Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2025-07-04 |
{
"resourceType" : "OperationDefinition",
"id" : "InstantiateFormWorkflow",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition InstantiateFormWorkflow</b></p><a name=\"InstantiateFormWorkflow\"> </a><a name=\"hcInstantiateFormWorkflow\"> </a><p>URL: [base]/PlanDefinition/[id]/$instantiateFormWorkflow</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>subject</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> (<a href=\"StructureDefinition-EFormPatient.html\" title=\"http://ontario.ca/fhir/eforms/StructureDefinition/EFormPatient\">Patient Profile</a>)</td><td/><td><div><p>The individual who is the subject of the eForm. Sourced from CMS when possible</p>\n</div></td></tr><tr><td>IN</td><td>requester</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> (<a href=\"StructureDefinition-EFormPractitionerRole.html\" title=\"http://ontario.ca/fhir/eforms/StructureDefinition/EFormPractitionerRole\">PractitionerRole Profile</a>, <a href=\"StructureDefinition-EFormOrganization.html\" title=\"http://ontario.ca/fhir/eforms/StructureDefinition/EFormOrganization\">Organization Profile</a>)</td><td/><td><div><p>The Organization (or PractionerRole) <strong>placing</strong> the ServiceRequest. They are the initiators of the eForms workflow</p>\n</div></td></tr><tr><td>IN</td><td>performer</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> (<a href=\"StructureDefinition-EFormPractitionerRole.html\" title=\"http://ontario.ca/fhir/eforms/StructureDefinition/EFormPractitionerRole\">PractitionerRole Profile</a>, <a href=\"StructureDefinition-EFormOrganization.html\" title=\"http://ontario.ca/fhir/eforms/StructureDefinition/EFormOrganization\">Organization Profile</a>)</td><td/><td><div><p>The Organization (or PractionerRole) who will be <strong>assigned</strong> the ServiceRequest. They will be required to complete (at <strong>least</strong> one) QuestionnaireResponse</p>\n</div></td></tr><tr><td>OUT</td><td>bundle</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>A Bundle of type <strong>collection</strong> containing the persisted ServiceRequest as the\nfirst entry and all associated Task resources as subsequent entries.<br/>\nClients should treat the bundle as a read‑only snapshot of the workflow that\nhas just been created.</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>Optional OperationOutcome conveying warnings or informational messages.</p>\n</div></td></tr></table></div>"
},
"url" : "http://ontario.ca/fhir/eforms/OperationDefinition/InstantiateFormWorkflow",
"version" : "0.1.0",
"name" : "InstantiateFormWorkflow",
"title" : "[base]/PlanDefinition/[id]/$instantiateFormWorkflow",
"status" : "draft",
"kind" : "operation",
"date" : "2025-07-04",
"publisher" : "Joel Pettis",
"contact" : [
{
"name" : "Joel Pettis",
"telecom" : [
{
"system" : "url",
"value" : "http://smileditialhealth.com/JoelPettis"
},
{
"system" : "email",
"value" : "joel.pettis@smiledigitalhealth.com"
}
]
}
],
"description" : "Instantiates the eform Workflow by creating a ServiceRequesta as well as all required Tasks, \nas defined by the Plan Definition.activity[]. The Service `Request Questionnaire extension`\nprovides the reference(s) to the assoicated Quesstionnaires. \n\n\nThe operation **persists** all resources derived from the associate \nPaln Definition in the Repository and then returns a\n**collection** Bundle snapshot (plus an optional OperationOutcome).",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166:-2",
"code" : "CA-ON",
"display" : "Ontario"
}
]
}
],
"code" : "instantiateFormWorkflow",
"resource" : [
"PlanDefinition"
],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [
{
"name" : "subject",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The individual who is the subject of the eForm. Sourced from CMS when possible",
"type" : "Reference",
"targetProfile" : [
🔗 "http://ontario.ca/fhir/eforms/StructureDefinition/EFormPatient"
]
},
{
"name" : "requester",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The Organization (or PractionerRole) __placing__ the ServiceRequest. They are the initiators of the eForms workflow",
"type" : "Reference",
"targetProfile" : [
🔗 "http://ontario.ca/fhir/eforms/StructureDefinition/EFormPractitionerRole"🔗 ,
"http://ontario.ca/fhir/eforms/StructureDefinition/EFormOrganization"
]
},
{
"name" : "performer",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The Organization (or PractionerRole) who will be __assigned__ the ServiceRequest. They will be required to complete (at __least__ one) QuestionnaireResponse",
"type" : "Reference",
"targetProfile" : [
🔗 "http://ontario.ca/fhir/eforms/StructureDefinition/EFormPractitionerRole"🔗 ,
"http://ontario.ca/fhir/eforms/StructureDefinition/EFormOrganization"
]
},
{
"name" : "bundle",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "A Bundle of type **collection** containing the persisted ServiceRequest as the\nfirst entry and all associated Task resources as subsequent entries. \nClients should treat the bundle as a read‑only snapshot of the workflow that\nhas just been created.",
"type" : "Bundle"
},
{
"name" : "outcome",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "Optional OperationOutcome conveying warnings or informational messages.",
"type" : "OperationOutcome"
}
]
}