This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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
Community Based Collaborative Care Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Patient |
Raw XML (canonical form + also see XML Format Specification)
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"> <id value="consent-example-smartonfhir"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative</b> </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-example-smartonfhir" </p> </div> <p> <b> status</b> : active</p> <p> <b> scope</b> : Privacy Consent <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="codesystem-consent-scope.html">Consent Scope Codes</a> #patient-privacy)</span> </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> patient</b> : <a href="patient-xcda.html">Patient/xcda</a> "Henry LEVIN"</p> <p> <b> dateTime</b> : 2016-06-23T17:02:33+10:00</p> <p> <b> performer</b> : <a href="relatedperson-peter.html">RelatedPerson/peter</a> "Peter CHALMERS"</p> <p> <b> organization</b> : <a href="organization-f001.html">Organization/f001</a> "Burgers University Medical Center"</p> <p> <b> policyRule</b> : opt-in <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> #OPTIN)</span> </p> <blockquote> <p> <b> provision</b> </p> <p> <b> period</b> : 2016-06-23T17:02:33+10:00 --> 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> permit</td> <td> Access <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="codesystem-consent-action.html">Consent Action Codes</a> #access)</span> </td> <td> MedicationRequest (Details: http://hl7.org/fhir/resource-types code MedicationRequest = 'MedicationRequest', stated as 'null')</td> </tr> </table> </blockquote> </div> </text> <status value="active"/> <scope> <coding> <system value="http://terminology.hl7.org/CodeSystem/consentscope"/> <code value="patient-privacy"/> </coding> </scope> <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 --> <patient> <reference value="Patient/xcda"/> </patient> <dateTime value="2016-06-23T17:02:33+10:00"/> <performer> <!-- this is the patient record that matches the person making the decision. note: it's not always a related person --> <reference value="RelatedPerson/peter"/> </performer> <organization> <!-- The organization running the Authentication server --> <reference value="Organization/f001"/> </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 --> <policyRule> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode"/> <code value="OPTIN"/> </coding> </policyRule> <!-- each scope that relates to FHIR resource access is represented as an exception --> <provision> <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> <class> <system value="http://hl7.org/fhir/resource-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.