FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions . Page versions: R5 R4B R4 R3

Consent-example-smartonfhir.ttl

Example Consent/consent-example-smartonfhir (Turtle)

Maturity Level : N/A
Responsible Owner: Community Based Collaborative Care Work Group Ballot Standards Status : Informative Compartments : Group , Patient

Raw Turtle , JSON-LD (+ also see Turtle/RDF Format Specification )

Template for recording a Smart on FHIR Authorization

@prefix fhir: <http://hl7.org/fhir/> .
@prefix loinc: <https://loinc.org/rdf/> .

@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .

@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<http://hl7.org/fhir/Consent/consent-example-smartonfhir> a fhir:Consent;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "consent-example-smartonfhir"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.div "<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>patient</b>: <a>Patient/xcda</a></p><p><b>period</b>: 23/06/2016 5:02:33 PM --&gt; 23/06/2016 5:32:33 PM</p><p><b>dateTime</b>: 23/06/2016 5:02:33 PM</p><p><b>consentingParty</b>: <a>RelatedPerson/peter</a></p><p><b>organization</b>: <a>Organization/example</a></p><p><b>policyRule</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>"
  ];
  fhir:Consent.status [ fhir:value "active"];
  fhir:Consent.patient [
     fhir:link <http://hl7.org/fhir/Patient/xcda>;
     fhir:Reference.reference [ fhir:value "Patient/xcda" ]
  ];
  fhir:Consent.period [
     fhir:Period.start [ fhir:value "2016-06-23T17:02:33+10:00"^^xsd:dateTime ];
     fhir:Period.end [ fhir:value "2016-06-23T17:32:33+10:00"^^xsd:dateTime ]
  ];
  fhir:Consent.dateTime [ fhir:value "2016-06-23T17:02:33+10:00"^^xsd:dateTime];
  fhir:Consent.consentingParty [
     fhir:index 0;
     fhir:link <http://hl7.org/fhir/RelatedPerson/peter>;
     fhir:Reference.reference [ fhir:value "RelatedPerson/peter" ]
  ];
  fhir:Consent.organization [
     fhir:index 0;
     fhir:link <http://hl7.org/fhir/Organization/example>;
     fhir:Reference.reference [ fhir:value "Organization/example" ]
  ];
  fhir:Consent.policyRule [ fhir:value "http://hl7.org/fhir/ConsentPolicy/opt-in"];
  fhir:Consent.except [
     fhir:index 0;
     fhir:Consent.except.type [ fhir:value "permit" ];
     fhir:Consent.except.action [
       fhir:index 0;
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://hl7.org/fhir/consentaction" ];
         fhir:Coding.code [ fhir:value "access" ]
       ]
     ];
     fhir:Consent.except.class [
       fhir:index 0;
       fhir:Coding.system [ fhir:value "http://hl7.org/fhir/resource-types" ];
       fhir:Coding.code [ fhir:value "MedicationRequest" ]
     ]
  ] .

<http://hl7.org/fhir/Consent/consent-example-smartonfhir> a fhir:Consent ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "consent-example-smartonfhir"] ; #  
#  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'.
# 
  fhir:status [ fhir:v "active"] ; # 
  fhir:category ( [
     fhir:coding ( [
       a loinc:59284-0 ;
       fhir:system [
         fhir:v "http://loinc.org"^^xsd:anyURI ;
         fhir:l <http://loinc.org>
       ] ;
       fhir:code [ fhir:v "59284-0" ]
     ] )
  ] ) ; # 
  fhir:subject [
     fhir:l <http://hl7.org/fhir/Patient/xcda> ;
     fhir:reference [ fhir:v "Patient/xcda" ]
  ] ; #   In this SMART on FHIR login, the user consents for data sharing for their elderly parent's record  
  fhir:date [ fhir:v "2016-06-23"^^xsd:date] ; # 
  fhir:grantor ( [
     fhir:l <http://hl7.org/fhir/RelatedPerson/peter> ;
     fhir:reference [ fhir:v "RelatedPerson/peter" ] #   this is the patient record that matches the person\n      making the decision. note: it's not always a related person  
  ] ) ; # 
  fhir:controller ( [
     fhir:l <http://hl7.org/fhir/Organization/f001> ;
     fhir:reference [ fhir:v "Organization/f001" ] #   The organization running the Authentication server  
  ] ) ; # 
  fhir:regulatoryBasis ( [
     fhir:coding ( [
       fhir:system [
         fhir:v "http://terminology.hl7.org/CodeSystem/v3-ActCode"^^xsd:anyURI ;
         fhir:l <http://terminology.hl7.org/CodeSystem/v3-ActCode>
       ] ;
       fhir:code [ fhir:v "INFA" ]
     ] )
  ] ) ; #   there's no source record for a Smart on FHIR consent
#    smart on fhir requires a base opt-in policy  
  fhir:decision [ fhir:v "permit"] ; #   each scope that relates to FHIR resource access is represented as an exception  
  fhir:provision ( [
     fhir:period [
       fhir:start [ fhir:v "2016-06-23T17:02:33+10:00"^^xsd:dateTime ] ;
       fhir:end [ fhir:v "2016-06-23T17:32:33+10:00"^^xsd:dateTime ]
     ] ;
     fhir:provision ( [
       fhir:action ( [
         fhir:coding ( [
           fhir:system [
             fhir:v "http://terminology.hl7.org/CodeSystem/consentaction"^^xsd:anyURI ;
             fhir:l <http://terminology.hl7.org/CodeSystem/consentaction>
           ] ;
           fhir:code [ fhir:v "access" ]
         ] )
       ] [
         fhir:coding ( [
           fhir:system [
             fhir:v "http://terminology.hl7.org/CodeSystem/consentaction"^^xsd:anyURI ;
             fhir:l <http://terminology.hl7.org/CodeSystem/consentaction>
           ] ;
           fhir:code [ fhir:v "correct" ]
         ] )
       ] ) ; #   this rule corresponds to MedicationRequest\/read  ,   no actors here, or anything, just read\/write and the resource type  
       fhir:resourceType ( [
         fhir:system [
           fhir:v "http://hl7.org/fhir/resource-types"^^xsd:anyURI ;
           fhir:l <http://hl7.org/fhir/resource-types>
         ] ;
         fhir:code [ fhir:v "MedicationRequest" ]
       ] )
     ] )
  ] ) . # 


<http://hl7.org/fhir/Patient/xcda> a fhir:Patient .

<http://hl7.org/fhir/RelatedPerson/peter> a fhir:RelatedPerson .

<http://hl7.org/fhir/Organization/example> a fhir:Organization .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/Consent/consent-example-smartonfhir.ttl> a owl:Ontology;
  owl:imports fhir:fhir.ttl;
  owl:versionIRI <http://hl7.org/fhir/STU3/Consent/consent-example-smartonfhir.ttl> .

<http://hl7.org/fhir/Organization/f001> a fhir:Organization .


# -------------------------------------------------------------------------------------


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.