STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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

Consent-example-smartonfhir.xml

Raw XML (canonical form)

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

<Consent xmlns="http://hl7.org/fhir"> 
  <id value="consent-example-smartonfhir"/>
  <text><status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: consent-example-smartonfhir</p><p><b>status</b>: active</p><p><b>dateTime</b>: 23/06/2016 5:02:33 PM</p><p><b>period</b>: 23/06/2016 5:02:33 PM --&gt; 23/06/2016 5:32:33 PM</p><p><b>patient</b>: <a>Patient/xcda</a></p><p><b>consentor</b>: <a>RelatedPerson/peter</a></p><p><b>organization</b>: <a>Organization/example</a></p><p><b>policy</b>: <a>http://hl7.org/fhir/ConsentPolicy/opt-in</a></p><h3>Excepts</h3><table><tr><td>-</td><td><b>Type</b></td><td><b>Action</b></td><td><b>Class</b></td></tr><tr><td>*</td><td>permit</td><td>Access <span>(Details : {http://hl7.org/fhir/consentaction code 'access' = 'Access)</span></td><td>MedicationRequest (Details: http://hl7.org/fhir/resource-types code MedicationRequest
             = 'MedicationRequest', stated as 'null')</td></tr></table></div></text><status value="active"/>
  <dateTime value="2016-06-23T17:02:33+10:00"/>
  <period>
    <start value="2016-06-23T17:02:33+10:00"/>
    <end value="2016-06-23T17:32:33+10:00"/>
  </period>

  <!--    
   In this SMART on FHIR login, the user consents for data sharing 
   for their elderly parent's record
     -->
  <patient>
    <reference value="Patient/xcda"/>
  </patient>
  <consentor>
    <!--    this is the patient record that matches the person
      making the decision. note: it's not always a related person
       -->
    <reference value="RelatedPerson/peter"/>
  </consentor>
  <organization>
    <!--    The organization running the Authentication server    -->
    <reference value="Organization/example"/>
  </organization>

  <!--    there's no source record for a Smart on FHIR consent    -->

  <!--    now the consent details itself start    -->

  <!--    smart on fhir is always the base opt-in policy    -->
  <policy value="http://hl7.org/fhir/ConsentPolicy/opt-in"/>

  <!--    each scope that relates to FHIR resource access is represented as an exception    -->
  <except>  
    <!--    this except corresponds to MedicationRequest/read    -->
    <type value="permit"/>
    <!--    no actors here, or anything, just read/write and the resource type    -->
    <action> 
      <coding>
        <system value="http://hl7.org/fhir/consentaction"/>
        <code value="access"/>
      </coding>
    </action>
    <class>
      <system value="http://hl7.org/fhir/resource-types"/>
      <code value="MedicationRequest"/>
    </class>
  </except>
</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.