Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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: R5 R4B R4 R3

Example Consent/consent-example-smartonfhir (XML)

Community Based Collaborative Care Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Patient

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

Jump past Narrative

Template for recording a Smart on FHIR Authorization (id = "consent-example-smartonfhir")

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

<Consent xmlns="http://hl7.org/fhir">
  <!--   
  This example provides a basic template for recording
  the consent associated with a SMART on FHIR OAuth dance.

  In SMART on FHIR, the user grants (consents) to a set
  of actions that the server can take when with regard to
  release of information from their own record to the application

  This is not the main intended use of the Consent resource,
  and there's no need for the consent resource as part of
  the SMART on FHIR Authorization process, or when using
  Heart UMA. Using a Consent resource to record and exchange
  the users consent may be useful for recording and storing
  the consent and making it available to the user later,
  or for exchanging the patient's consent between AS and RS,
  or between systems in a multi-system virtual RS a very
  common scenario)

  Note that whichever system builds this Content resource,
  it needs access to information from both the AS and the
  RS.

  Note also, that a situation where a practitioner type user
  authorises the application to access information on a general
  set of patients does not count as 'consent'.
   -->
  <id value="consent-example-smartonfhir"/> 
  <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative: Consent</b> <a name="consent-example-smartonfhir"> </a> </p> <div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border:
       1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Consent &quot;consent-example-smartonfhir&quot; </p> </div> <p> <b> status</b> : active</p> <p> <b> category</b> : Patient Consent <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://loinc.org/">LOINC</a> #59284-0)</span> </p> <p> <b> subject</b> : <span title="  In this SMART on FHIR login, the user consents for data sharing for their elderly
         parent's record  "><a href="patient-example-xcda.html">Patient/xcda</a>  &quot;Henry LEVIN&quot;</span> </p> <p> <b> dateTime</b> : 2016-06-23T17:02:33+10:00</p> <p> <b> grantor</b> : <a href="relatedperson-example-peter.html">RelatedPerson/peter</a>  &quot;Peter CHALMERS&quot;</p> <p> <b> controller</b> : <a href="organization-example-f001-burgers.html">Organization/f001</a>  &quot;Burgers University Medical Center&quot;</p> <p> <b> regulatoryBasis</b> : <span title="  there's no source record for a Smart on FHIR consent
    smart on fhir requires a base opt-in policy  ">information access <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/3.1.0/CodeSystem-v3-ActCode.html">ActCode</a> #INFA)</span> </span> </p> <blockquote> <p> <b> provision</b> </p> <p> <b> type</b> : deny</p> <p> <b> period</b> : 2016-06-23T17:02:33+10:00 --&gt; 2016-06-23T17:32:33+10:00</p> <h3> Provisions</h3> <table class="grid"><tr> <td> -</td> <td> <b> Type</b> </td> <td> <b> Action</b> </td> <td> <b> Class</b> </td> </tr> <tr> <td> *</td> <td> <span title="  this rule corresponds to MedicationRequest/read  ">permit</span> </td> <td> <span title="  no actors here, or anything, just read/write and the resource type  ">Access <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/3.1.0/CodeSystem-consentaction.html">Consent Action Codes</a> #access)</span> </span> , Access and Correct <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/3.1.0/CodeSystem-consentaction.html">Consent Action Codes</a> #correct)</span> </td> <td> MedicationRequest (Details: http://hl7.org/fhir/fhir-types code MedicationRequest
               = 'MedicationRequest', stated as 'null')</td> </tr> </table> </blockquote> </div> </text> <status value="active"/> 

  <category> 
    <coding> 
      <system value="http://loinc.org"/> 
      <code value="59284-0"/> 
    </coding> 
  </category> 
  <!--    In this SMART on FHIR login, the user consents for data sharing for their elderly
   parent's record    -->
  <subject> 
    <reference value="Patient/xcda"/> 
  </subject> 
  <dateTime value="2016-06-23T17:02:33+10:00"/> 
  <grantor> 
    <!--    this is the patient record that matches the person
      making the decision. note: it's not always a related person    -->
    <reference value="RelatedPerson/peter"/> 
  </grantor> 
  <controller> 
    <!--    The organization running the Authentication server    -->
    <reference value="Organization/f001"/> 
  </controller> 
  <!--    there's no source record for a Smart on FHIR consent
    smart on fhir requires a base opt-in policy    -->
  <regulatoryBasis> 
    <coding> 
      <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> 
      <code value="INFA"/> 
    </coding> 
  </regulatoryBasis> 
  <!--    each scope that relates to FHIR resource access is represented as an exception
      -->
  <provision> 
    <type value="deny"/> 
    <period> 
      <start value="2016-06-23T17:02:33+10:00"/> 
      <end value="2016-06-23T17:32:33+10:00"/> 
    </period> 
    <provision> 
      <!--    this rule corresponds to MedicationRequest/read    -->
      <type value="permit"/> 
      <!--    no actors here, or anything, just read/write and the resource type    -->
      <action> 
        <coding> 
          <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
          <code value="access"/> 
        </coding> 
      </action> 
      <action> 
        <coding> 
          <system value="http://terminology.hl7.org/CodeSystem/consentaction"/> 
          <code value="correct"/> 
        </coding> 
      </action> 
      <class> 
        <system value="http://hl7.org/fhir/fhir-types"/> 
        <code value="MedicationRequest"/> 
      </class> 
    </provision> 
  </provision> 
</Consent> 

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.