Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

Example CodeSystem/smart-capabilities (XML)

Vocabulary Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

Definition for Code SystemSmartCapabilities

<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="smart-capabilities"/> 
  <meta> 
    <lastUpdated value="2022-09-07T10:58:29.429+10:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This code system 
        <code> http://terminology.hl7.org/CodeSystem/smart-capabilities</code>  defines the following codes:
      </p> 
      <table class="codes">
        <tr> 
          <td style="white-space:nowrap">
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">launch-ehr
            <a name="smart-capabilities-launch-ehr"> </a> 
          </td> 
          <td> EHR Launch Mode</td> 
          <td> support for SMART’s EHR Launch mode.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">launch-standalone
            <a name="smart-capabilities-launch-standalone"> </a> 
          </td> 
          <td> Standalone Launch Mode</td> 
          <td> support for SMART’s Standalone Launch mode.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">client-public
            <a name="smart-capabilities-client-public"> </a> 
          </td> 
          <td> Public Client Profile</td> 
          <td> support for SMART’s public client profile (no client authentication).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">client-confidential-symmetric
            <a name="smart-capabilities-client-confidential-symmetric"> </a> 
          </td> 
          <td> Confidential Client Profile</td> 
          <td> support for SMART’s confidential client profile (symmetric client secret authentication).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">sso-openid-connect
            <a name="smart-capabilities-sso-openid-connect"> </a> 
          </td> 
          <td> Supports OpenID Connect</td> 
          <td> support for SMART’s OpenID Connect profile.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">context-passthrough-banner
            <a name="smart-capabilities-context-passthrough-banner"> </a> 
          </td> 
          <td> Allows &quot;Need Patient Banner&quot;</td> 
          <td> support for “need patient banner” launch context (conveyed via need_patient_banner token
             parameter).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">context-passthrough-style
            <a name="smart-capabilities-context-passthrough-style"> </a> 
          </td> 
          <td> Allows &quot;Smart Style Style&quot;</td> 
          <td> support for “SMART style URL” launch context (conveyed via smart_style_url token parameter).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">context-ehr-patient
            <a name="smart-capabilities-context-ehr-patient"> </a> 
          </td> 
          <td> Allows &quot;Patient Level Launch Context (EHR)&quot;</td> 
          <td> support for patient-level launch context (requested by launch/patient scope, conveyed
             via patient token parameter).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">context-ehr-encounter
            <a name="smart-capabilities-context-ehr-encounter"> </a> 
          </td> 
          <td> Allows &quot;Encounter Level Launch Context (EHR)&quot;</td> 
          <td> support for encounter-level launch context (requested by launch/encounter scope, conveyed
             via encounter token parameter).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">context-standalone-patient
            <a name="smart-capabilities-context-standalone-patient"> </a> 
          </td> 
          <td> Allows &quot;Patient Level Launch Context (STANDALONE)&quot;</td> 
          <td> support for patient-level launch context (requested by launch/patient scope, conveyed
             via patient token parameter).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">context-standalone-encounter
            <a name="smart-capabilities-context-standalone-encounter"> </a> 
          </td> 
          <td> Allows &quot;Encounter Level Launch Context (STANDALONE)&quot;</td> 
          <td> support for encounter-level launch context (requested by launch/encounter scope, conveyed
             via encounter token parameter).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">permission-offline
            <a name="smart-capabilities-permission-offline"> </a> 
          </td> 
          <td> Supports Refresh Token</td> 
          <td> support for refresh tokens (requested by offline_access scope).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">permission-patient
            <a name="smart-capabilities-permission-patient"> </a> 
          </td> 
          <td> Supports Patient Level Scopes</td> 
          <td> support for patient-level scopes (e.g. patient/Observation.read).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">permission-user
            <a name="smart-capabilities-permission-user"> </a> 
          </td> 
          <td> Supports User Level Scopes</td> 
          <td> support for user-level scopes (e.g. user/Appointment.read).</td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <url value="http://terminology.hl7.org/CodeSystem/smart-capabilities"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.1.1265"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="SmartCapabilities"/> 
  <title value="SmartCapabilities"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2022-09-07T10:58:29+10:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="Codes that define what the server is capable of."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/smart-capabilities"/> 
  <content value="complete"/> 
  <concept> 
    <code value="launch-ehr"/> 
    <display value="EHR Launch Mode"/> 
    <definition value="support for SMART’s EHR Launch mode."/> 
  </concept> 
  <concept> 
    <code value="launch-standalone"/> 
    <display value="Standalone Launch Mode"/> 
    <definition value="support for SMART’s Standalone Launch mode."/> 
  </concept> 
  <concept> 
    <code value="client-public"/> 
    <display value="Public Client Profile"/> 
    <definition value="support for SMART’s public client profile (no client authentication)."/> 
  </concept> 
  <concept> 
    <code value="client-confidential-symmetric"/> 
    <display value="Confidential Client Profile"/> 
    <definition value="support for SMART’s confidential client profile (symmetric client secret authentication)."/> 
  </concept> 
  <concept> 
    <code value="sso-openid-connect"/> 
    <display value="Supports OpenID Connect"/> 
    <definition value="support for SMART’s OpenID Connect profile."/> 
  </concept> 
  <concept> 
    <code value="context-passthrough-banner"/> 
    <display value="Allows &quot;Need Patient Banner&quot;"/> 
    <definition value="support for “need patient banner” launch context (conveyed via need_patient_banner token
     parameter)."/> 
  </concept> 
  <concept> 
    <code value="context-passthrough-style"/> 
    <display value="Allows &quot;Smart Style Style&quot;"/> 
    <definition value="support for “SMART style URL” launch context (conveyed via smart_style_url token parameter)."/> 
  </concept> 
  <concept> 
    <code value="context-ehr-patient"/> 
    <display value="Allows &quot;Patient Level Launch Context (EHR)&quot;"/> 
    <definition value="support for patient-level launch context (requested by launch/patient scope, conveyed
     via patient token parameter)."/> 
  </concept> 
  <concept> 
    <code value="context-ehr-encounter"/> 
    <display value="Allows &quot;Encounter Level Launch Context (EHR)&quot;"/> 
    <definition value="support for encounter-level launch context (requested by launch/encounter scope, conveyed
     via encounter token parameter)."/> 
  </concept> 
  <concept> 
    <code value="context-standalone-patient"/> 
    <display value="Allows &quot;Patient Level Launch Context (STANDALONE)&quot;"/> 
    <definition value="support for patient-level launch context (requested by launch/patient scope, conveyed
     via patient token parameter)."/> 
  </concept> 
  <concept> 
    <code value="context-standalone-encounter"/> 
    <display value="Allows &quot;Encounter Level Launch Context (STANDALONE)&quot;"/> 
    <definition value="support for encounter-level launch context (requested by launch/encounter scope, conveyed
     via encounter token parameter)."/> 
  </concept> 
  <concept> 
    <code value="permission-offline"/> 
    <display value="Supports Refresh Token"/> 
    <definition value="support for refresh tokens (requested by offline_access scope)."/> 
  </concept> 
  <concept> 
    <code value="permission-patient"/> 
    <display value="Supports Patient Level Scopes"/> 
    <definition value="support for patient-level scopes (e.g. patient/Observation.read)."/> 
  </concept> 
  <concept> 
    <code value="permission-user"/> 
    <display value="Supports User Level Scopes"/> 
    <definition value="support for user-level scopes (e.g. user/Appointment.read)."/> 
  </concept> 
</CodeSystem>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.