SMART App Launch
2.2.0-ballot - CI-Build International flag

This page is part of the Smart App Launch Implementation Guide (v2.2.0-ballot: STU 2.2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

Task profile for requesting SMART launch (Experimental)

This section defines a set of profiles of the FHIR Task resource that requests launch of a SMART application. These tasks could be used to recommend an application for staff to launch, e.g. as a result of a Clinical Reasoning deployment.

Two profiles are defined:

Requesting an EHR launch

A Task with the profile task-ehr-launch, requests an EHR launch with optional appContext.

The Task.for field, if present indicates the Patient resource to be used in the launch context.

the Task.encounter field, if present indicates the Encounter resource to be used in the launch context.

The input field contains:

  • the url of the application to be launched
  • optional appContext to be included in the token response as is specified in a CDShooks Link

An example of such Task is presented below:

{
  "resourceType": "Task",
  "id": "task-for-ehr-launch",
  "status": "requested",
  "intent": "proposal",
  "code": {
    "coding": [{
      "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/smart-codes",
      "code": "launch-app-ehr",
      "display": "Launch application using the SMART EHR launch"
    }]
  },
  "for": {"reference": "https://example.org/fhir/Patient/123"},
  "encounter": {"reference": "https://example.org/fhir/Encounter/456"},
  "input": [
  {
    "type": {
        "coding":[{
          "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/smart-codes",
          "code": "smartonfhir-application",
          "display": "SMART on FHIR application URL."
        }]
    },
    "valueUrl": "https://www.example.org/myapplication"
  },
  {
    "type": {
        "coding":[{
          "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/smart-codes",
          "code": "smartonfhir-appcontext",
          "display": "Application context related to this launch."
        }]
    },
    "valueString": "{\"field1\":\"value\"}"
  }

Requesting an standalone launch

A Task according to the profile task-standalone-launch, requests an standalone launch.

The input field contains:

  • the url of the application to be launched

An example of such Task is presented below:

{
  "resourceType": "Task",
  "id": "task-for-standalone-launch",
  "status": "requested",
  "intent": "proposal",
  "code": 
  {
    "coding": [{
      "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/smart-codes",
      "code": "launch-app-standalone",
      "display": "Launch application using the SMART standalone launch"
    }]
  },
  "for": {"reference": "https://example.org/fhir/Patient/123"},
  "encounter": {"reference": "https://example.org/fhir/Encounter/456"},
  "input": [
  {
    "type": {
        "coding":[{
          "system": "http://hl7.org/fhir/smart-app-launch/CodeSystem/smart-codes",
          "code": "smartonfhir-application",
          "display": "SMART on FHIR application URL."
        }]
    },
    "valueUrl": "https://www.example.org/myapplication"
  }]
}