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

• Narrative Content
• JSON

: [base]/ServiceRequest/[id]/$transitionWorkflow - JSON Representation

Draft as of 2025-07-06

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "TransitionWorkflow",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition TransitionWorkflow</b></p><a name=\"TransitionWorkflow\"> </a><a name=\"hcTransitionWorkflow\"> </a><p>URL: [base]/ServiceRequest/[id]/$transitionWorkflow</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>targetStatus</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td><a href=\"ValueSet-business-status.html\">eForms Business Status ValueSet</a> (Required)</td><td><div><p>Desired new businessStatus value.</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>Snapshot Bundle (type=collection) containing the updated ServiceRequest and\nall Task resources whose status changed or were newly created by the transition.</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 with warnings or authorization errors.</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://ontario.ca/fhir/eforms/OperationDefinition/TransitionWorkflow",
  "version" : "0.1.0",
  "name" : "TransitionWorkflow",
  "title" : "[base]/ServiceRequest/[id]/$transitionWorkflow",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2025-07-06",
  "publisher" : "Joel Pettis",
  "contact" : [
    {
      "name" : "Joel Pettis",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://smileditialhealth.com/JoelPettis"
        },
        {
          "system" : "email",
          "value" : "joel.pettis@smiledigitalhealth.com"
        }
      ]
    }
  ],
  "description" : "Instance-level operation on ServiceRequest that changes the businessStatus\nextension (eForms workflow state) and updates associated Task resources.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166:-2",
          "code" : "CA-ON",
          "display" : "Ontario"
        }
      ]
    }
  ],
  "code" : "transitionWorkflow",
  "resource" : [
    "ServiceRequest"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "targetStatus",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Desired new businessStatus value.",
      "type" : "code",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://ontario.ca/fhir/eforms/ValueSet/business-status"
      }
    },
    {
      "name" : "bundle",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Snapshot Bundle (type=collection) containing the updated ServiceRequest and\nall Task resources whose status changed or were newly created by the transition.",
      "type" : "Bundle"
    },
    {
      "name" : "outcome",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "Optional OperationOutcome with warnings or authorization errors.",
      "type" : "OperationOutcome"
    }
  ]
}