Difference between revisions of "Context Roles"

From Hiasobi - FHIR
Jump to: navigation, search
Line 1: Line 1:
−
=Interface=
+
Current PRACTITONER ROLE CONTEXT
−
There are two codes represented in the API
+
  
−
* http://oridashi.com.au/system/code/role SYSADM System Administrator
+
REQUEST: htps://localhost.oridashi.com.au:8102/Observation/CTX-PRACTITIONERROLE
−
* http://oridashi.com.au/system/code/role CLINICAL Clinical User
+
  
−
=Best Practice=
+
RESPONSE:
−
* Permission: Setup/configuration (Add/Edit/Delete)
+
−
* Permission: Clinical record (Allow access)
+
  
−
=Medical Director=
+
<Observation xmlns="http://hl7.org/fhir">
−
* Permission: Doctor or Nurse Practitioner
+
    <id value="CTX-PRACTITIONERROLE" />
−
* Permission: Access Level (Full)
+
    <meta>
−
* Permission: Options Editing
+
        <lastUpdated value="2018-08-20T11:32:12.535+10:00" />
 +
    </meta>
 +
    <text>
 +
        <status value="generated" />
 +
        <div xmlns="http://www.w3.org/1999/xhtml">
 +
            <p> Context: PRACTITIONERROLE - 6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1</p>
 +
        </div>
 +
    </text>
 +
    <status value="final" />
 +
    <code>
 +
        <coding>
 +
            <system value="http://oridashi.com.au/system/code/context" />
 +
            <code value="PRACTITIONERROLE" />
 +
            <display value="Practitioner Role Context" />
 +
        </coding>
 +
    </code>
 +
    <effectiveDateTime value="2018-08-20T11:32:12.5350068+10:00" />
 +
    <valueString value="6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1" />
 +
</Observation>
 +
 
 +
 
 +
Use the PractitonerRole identifier provided to read details of the current user role:
 +
 +
 
 +
REQUEST: https://localhost.oridashi.com.au:8102/PractitionerRole/6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1
 +
 
 +
RESPONSE:
 +
<PractitionerRole xmlns="http://hl7.org/fhir">
 +
    <id value="6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1" />
 +
    <meta>
 +
        <lastUpdated value="2018-01-24T15:26:13+11:00" />
 +
    </meta>
 +
    <text>
 +
        <status value="generated" />
 +
        <div xmlns="http://www.w3.org/1999/xhtml">
 +
            <p>D'Sousa, Frederick Tao</p>
 +
        </div>
 +
    </text>
 +
    <identifier>
 +
        <use value="usual" />
 +
        <type>
 +
            <coding>
 +
                <system value="http://hl7.org.au/fhir/v2/0203" />
 +
                <code value="UPIN" />
 +
                <display value="Medicare Provider Number" />
 +
            </coding>
 +
            <text value="Medicare Provider Number" />
 +
        </type>
 +
        <system value="http://ns.electronichealth.net.au/id/medicare-provider-number" />
 +
        <value value="4024742F" />
 +
    </identifier>
 +
    <active value="true" />
 +
    <practitioner>
 +
        <reference value="Practitioner/6FA2AA1CA439ABFB38D48297E0ACC3FF.1" />
 +
    </practitioner>
 +
    <organization>
 +
        <reference value="Organization/6FA2AA1CA439ABFB38D48297E0ACC3FF.0" />
 +
    </organization>
 +
    <code>
 +
        <coding>
 +
            <system value="http://oridashi.com.au/system/code/bestpracticerole" />
 +
            <code value="3" />
 +
            <display value="Principal doctor" />
 +
        </coding>
 +
        <text value="Principal doctor" />
 +
    </code>
 +
    <code>
 +
        <coding>
 +
            <system value="http://oridashi.com.au/system/code/role" />
 +
            <code value="SYSADM" />
 +
            <display value="System Administrator" />
 +
        </coding>
 +
    </code>
 +
    <code>
 +
        <coding>
 +
            <system value="http://oridashi.com.au/system/code/role" />
 +
            <code value="CLINICAL" />
 +
            <display value="Clinical User" />
 +
        </coding>
 +
    </code>
 +
    <location>
 +
        <reference value="Location/6FA2AA1CA439ABFB38D48297E0ACC3FF.1" />
 +
    </location>
 +
</PractitionerRole>
 +
 
 +
If you want to get both the PractitionerRole and Practitioner (with name etc) make a call like the following and get the associated practitioner.
 +
 
 +
REQUEST:  https://localhost.oridashi.com.au:8102/PractitionerRole?_id=6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1&_include=PractitionerRole:practitioner
 +
 
 +
RESPONSE:
 +
 
 +
<Bundle xmlns="http://hl7.org/fhir">
 +
    <id value="b314c00e-f22f-480e-a0eb-4e83bc768d77" />
 +
    <meta>
 +
        <versionId value="20180820114518" />
 +
        <lastUpdated value="2018-08-20T01:45:18.943+00:00" />
 +
    </meta>
 +
    <type value="searchset" />
 +
    <total value="1" />
 +
    <link>
 +
        <relation value="self" />
 +
        <url value="https://localhost.oridashi.com.au:8102/PractitionerRole?_id=6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1&amp;_include=PractitionerRole:practitioner" />
 +
    </link>
 +
    <link>
 +
        <relation value="last" />
 +
        <url value="https://localhost.oridashi.com.au:8102/PractitionerRole?_id=6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1&amp;_include=PractitionerRole:practitioner&amp;_page=1&amp;_snapshot=636703623149158566" />
 +
    </link>
 +
    <entry>
 +
        <fullUrl value="https://localhost.oridashi.com.au:8102/PractitionerRole/6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1" />
 +
        <resource>
 +
            <PractitionerRole>
 +
                <id value="6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1" />
 +
                <meta>
 +
                    <versionId value="20180124042613" />
 +
                    <lastUpdated value="2018-01-24T04:26:13+00:00" />
 +
                </meta>
 +
                <text>
 +
                    <status value="generated" />
 +
                    <div xmlns="http://www.w3.org/1999/xhtml">
 +
                        <p>D'Sousa, Frederick Tao</p>
 +
                    </div>
 +
                </text>
 +
                <identifier>
 +
                    <use value="usual" />
 +
                    <type>
 +
                        <coding>
 +
                            <system value="http://hl7.org.au/fhir/v2/0203" />
 +
                            <code value="UPIN" />
 +
                            <display value="Medicare Provider Number" />
 +
                        </coding>
 +
                        <text value="Medicare Provider Number" />
 +
                    </type>
 +
                    <system value="http://ns.electronichealth.net.au/id/medicare-provider-number" />
 +
                    <value value="4024742F" />
 +
                </identifier>
 +
                <active value="true" />
 +
                <practitioner>
 +
                    <reference value="Practitioner/6FA2AA1CA439ABFB38D48297E0ACC3FF.1" />
 +
                </practitioner>
 +
                <organization>
 +
                    <reference value="Organization/6FA2AA1CA439ABFB38D48297E0ACC3FF.0" />
 +
                </organization>
 +
                <code>
 +
                    <coding>
 +
                        <system value="http://oridashi.com.au/system/code/bestpracticerole" />
 +
                        <code value="3" />
 +
                        <display value="Principal doctor" />
 +
                    </coding>
 +
                    <text value="Principal doctor" />
 +
                </code>
 +
                <code>
 +
                    <coding>
 +
                        <system value="http://oridashi.com.au/system/code/role" />
 +
                        <code value="SYSADM" />
 +
                        <display value="System Administrator" />
 +
                    </coding>
 +
                </code>
 +
                <code>
 +
                    <coding>
 +
                        <system value="http://oridashi.com.au/system/code/role" />
 +
                        <code value="CLINICAL" />
 +
                        <display value="Clinical User" />
 +
                    </coding>
 +
                </code>
 +
                <location>
 +
                    <reference value="Location/6FA2AA1CA439ABFB38D48297E0ACC3FF.1" />
 +
                </location>
 +
            </PractitionerRole>
 +
        </resource>
 +
    </entry>
 +
    <entry>
 +
        <fullUrl value="https://localhost.oridashi.com.au:8102/Practitioner/6FA2AA1CA439ABFB38D48297E0ACC3FF.1" />
 +
        <resource>
 +
            <Practitioner>
 +
                <id value="6FA2AA1CA439ABFB38D48297E0ACC3FF.1" />
 +
                <meta>
 +
                    <versionId value="20180124042613" />
 +
                    <lastUpdated value="2018-01-24T04:26:13+00:00" />
 +
                </meta>
 +
                <text>
 +
                    <status value="generated" />
 +
                    <div xmlns="http://www.w3.org/1999/xhtml">
 +
                        <p>D'Sousa, Frederick Tao</p>
 +
                    </div>
 +
                </text>
 +
                <identifier>
 +
                    <use value="usual" />
 +
                    <type>
 +
                        <coding>
 +
                            <system value="http://hl7.org.au/v2/0203" />
 +
                            <code value="PRESC" />
 +
                            <display value="Prescriber Number" />
 +
                        </coding>
 +
                        <text value="Prescriber Number" />
 +
                    </type>
 +
                    <system value="http://ns.electronichealth.net.au/id/medicare-prescriber-number" />
 +
                    <value value="453221" />
 +
                </identifier>
 +
                <active value="true" />
 +
                <name>
 +
                    <use value="official" />
 +
                    <family value="D'Sousa" />
 +
                    <given value="Frederick Tao" />
 +
                    <prefix value="Dr" />
 +
                </name>
 +
                <telecom>
 +
                    <system value="phone" />
 +
                    <value value="456131345" />
 +
                    <use value="home" />
 +
                </telecom>
 +
                <telecom>
 +
                    <system value="phone" />
 +
                    <value value="05645613121" />
 +
                    <use value="mobile" />
 +
                </telecom>
 +
                <telecom>
 +
                    <system value="email" />
 +
                    <value value="findacure7@bpsoftware.com.au" />
 +
                    <use value="work" />
 +
                </telecom>
 +
            </Practitioner>
 +
        </resource>
 +
    </entry>
 +
</Bundle>
 +
 
 +
 
 +
==Standard Permission Roles Coding==
 +
There are two codes represented in the API indicating asserted permissions as set in the practice systems
 +
 
 +
===System administrator rights (settings/options)===
 +
** Best Practice Permission: Setup/configuration (Add/Edit/Delete)
 +
** Medical Director Permission: Options Editing
 +
 
 +
e.g.
 +
              <code>
 +
                    <coding>
 +
                        <system value="http://oridashi.com.au/system/code/role" />
 +
                        <code value="SYSADM" />
 +
                        <display value="System Administrator" />
 +
                    </coding>
 +
                </code>
 +
 
 +
===Clinical viewing rights===
 +
* Best Practice Permission: Clinical record (Allow access)
 +
* Medical Director Permission: Doctor or Nurse Practitioner
 +
* Medical Director Permission: Access Level (Full)
 +
 
 +
e.g
 +
              <code>
 +
                    <coding>
 +
                        <system value="http://oridashi.com.au/system/code/role" />
 +
                        <code value="CLINICAL" />
 +
                        <display value="Clinical User" />
 +
                    </coding>
 +
                </code>

Revision as of 13:46, 19 February 2019

Current PRACTITONER ROLE CONTEXT

REQUEST: htps://localhost.oridashi.com.au:8102/Observation/CTX-PRACTITIONERROLE

RESPONSE:

<Observation xmlns="http://hl7.org/fhir"> 

   <id value="CTX-PRACTITIONERROLE" />
   <meta>
       <lastUpdated value="2018-08-20T11:32:12.535+10:00" />
   </meta>
   <text>
       <status value="generated" />

Context: PRACTITIONERROLE - 6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1

   </text>
   <status value="final" />
   
       <coding>
           <system value="http://oridashi.com.au/system/code/context" />
           <code value="PRACTITIONERROLE" />
           <display value="Practitioner Role Context" />
       </coding>
   
   <effectiveDateTime value="2018-08-20T11:32:12.5350068+10:00" />
   <valueString value="6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1" />

</Observation>


Use the PractitonerRole identifier provided to read details of the current user role:


REQUEST: https://localhost.oridashi.com.au:8102/PractitionerRole/6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1

RESPONSE: <PractitionerRole xmlns="http://hl7.org/fhir"> 

   <id value="6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1" />
   <meta>
       <lastUpdated value="2018-01-24T15:26:13+11:00" />
   </meta>
   <text>
       <status value="generated" />

D'Sousa, Frederick Tao

   </text>
   <identifier>
       <use value="usual" />
       <type>
           <coding>
               <system value="http://hl7.org.au/fhir/v2/0203" />
               <code value="UPIN" />
               <display value="Medicare Provider Number" />
           </coding>
           <text value="Medicare Provider Number" />
       </type>
       <system value="http://ns.electronichealth.net.au/id/medicare-provider-number" />
       <value value="4024742F" />
   </identifier>
   <active value="true" />
   <practitioner>
       <reference value="Practitioner/6FA2AA1CA439ABFB38D48297E0ACC3FF.1" />
   </practitioner>
   <organization>
       <reference value="Organization/6FA2AA1CA439ABFB38D48297E0ACC3FF.0" />
   </organization>
   
       <coding>
           <system value="http://oridashi.com.au/system/code/bestpracticerole" />
           <code value="3" />
           <display value="Principal doctor" />
       </coding>
       <text value="Principal doctor" />
   
   
       <coding>
           <system value="http://oridashi.com.au/system/code/role" />
           <code value="SYSADM" />
           <display value="System Administrator" />
       </coding>
   
   
       <coding>
           <system value="http://oridashi.com.au/system/code/role" />
           <code value="CLINICAL" />
           <display value="Clinical User" />
       </coding>
   
   <location>
       <reference value="Location/6FA2AA1CA439ABFB38D48297E0ACC3FF.1" />
   </location>

</PractitionerRole>

If you want to get both the PractitionerRole and Practitioner (with name etc) make a call like the following and get the associated practitioner.

REQUEST: https://localhost.oridashi.com.au:8102/PractitionerRole?_id=6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1&_include=PractitionerRole:practitioner

RESPONSE:

<Bundle xmlns="http://hl7.org/fhir"> 

   <id value="b314c00e-f22f-480e-a0eb-4e83bc768d77" />
   <meta>
       <versionId value="20180820114518" />
       <lastUpdated value="2018-08-20T01:45:18.943+00:00" />
   </meta>
   <type value="searchset" />
   <total value="1" />
   <link>
       <relation value="self" />
       <url value="https://localhost.oridashi.com.au:8102/PractitionerRole?_id=6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1&_include=PractitionerRole:practitioner" />
   </link>
   <link>
       <relation value="last" />
       <url value="https://localhost.oridashi.com.au:8102/PractitionerRole?_id=6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1&_include=PractitionerRole:practitioner&_page=1&_snapshot=636703623149158566" />
   </link>
   <entry>
       <fullUrl value="https://localhost.oridashi.com.au:8102/PractitionerRole/6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1" />
       <resource>
           <PractitionerRole>
               <id value="6FA2AA1CA439ABFB38D48297E0ACC3FF.1-1" />
               <meta>
                   <versionId value="20180124042613" />
                   <lastUpdated value="2018-01-24T04:26:13+00:00" />
               </meta>
               <text>
                   <status value="generated" />

D'Sousa, Frederick Tao

               </text>
               <identifier>
                   <use value="usual" />
                   <type>
                       <coding>
                           <system value="http://hl7.org.au/fhir/v2/0203" />
                           <code value="UPIN" />
                           <display value="Medicare Provider Number" />
                       </coding>
                       <text value="Medicare Provider Number" />
                   </type>
                   <system value="http://ns.electronichealth.net.au/id/medicare-provider-number" />
                   <value value="4024742F" />
               </identifier>
               <active value="true" />
               <practitioner>
                   <reference value="Practitioner/6FA2AA1CA439ABFB38D48297E0ACC3FF.1" />
               </practitioner>
               <organization>
                   <reference value="Organization/6FA2AA1CA439ABFB38D48297E0ACC3FF.0" />
               </organization>
               
                   <coding>
                       <system value="http://oridashi.com.au/system/code/bestpracticerole" />
                       <code value="3" />
                       <display value="Principal doctor" />
                   </coding>
                   <text value="Principal doctor" />
               
               
                   <coding>
                       <system value="http://oridashi.com.au/system/code/role" />
                       <code value="SYSADM" />
                       <display value="System Administrator" />
                   </coding>
               
               
                   <coding>
                       <system value="http://oridashi.com.au/system/code/role" />
                       <code value="CLINICAL" />
                       <display value="Clinical User" />
                   </coding>
               
               <location>
                   <reference value="Location/6FA2AA1CA439ABFB38D48297E0ACC3FF.1" />
               </location>
           </PractitionerRole>
       </resource>
   </entry>
   <entry>
       <fullUrl value="https://localhost.oridashi.com.au:8102/Practitioner/6FA2AA1CA439ABFB38D48297E0ACC3FF.1" />
       <resource>
           <Practitioner>
               <id value="6FA2AA1CA439ABFB38D48297E0ACC3FF.1" />
               <meta>
                   <versionId value="20180124042613" />
                   <lastUpdated value="2018-01-24T04:26:13+00:00" />
               </meta>
               <text>
                   <status value="generated" />

D'Sousa, Frederick Tao

               </text>
               <identifier>
                   <use value="usual" />
                   <type>
                       <coding>
                           <system value="http://hl7.org.au/v2/0203" />
                           <code value="PRESC" />
                           <display value="Prescriber Number" />
                       </coding>
                       <text value="Prescriber Number" />
                   </type>
                   <system value="http://ns.electronichealth.net.au/id/medicare-prescriber-number" />
                   <value value="453221" />
               </identifier>
               <active value="true" />
               <name>
                   <use value="official" />
                   <family value="D'Sousa" />
                   <given value="Frederick Tao" />
                   <prefix value="Dr" />
               </name>
               <telecom>
                   <system value="phone" />
                   <value value="456131345" />
                   <use value="home" />
               </telecom>
               <telecom>
                   <system value="phone" />
                   <value value="05645613121" />
                   <use value="mobile" />
               </telecom>
               <telecom>
                   <system value="email" />
                   <value value="findacure7@bpsoftware.com.au" />
                   <use value="work" />
               </telecom>
           </Practitioner>
       </resource>
   </entry>

</Bundle>


Standard Permission Roles Coding

There are two codes represented in the API indicating asserted permissions as set in the practice systems

System administrator rights (settings/options)

    • Best Practice Permission: Setup/configuration (Add/Edit/Delete)
    • Medical Director Permission: Options Editing

e.g. 

              
                   <coding>
                       <system value="http://oridashi.com.au/system/code/role" />
                       <code value="SYSADM" />
                       <display value="System Administrator" />
                   </coding>

Clinical viewing rights

  • Best Practice Permission: Clinical record (Allow access)
  • Medical Director Permission: Doctor or Nurse Practitioner
  • Medical Director Permission: Access Level (Full)

e.g 

             
                   <coding>
                       <system value="http://oridashi.com.au/system/code/role" />
                       <code value="CLINICAL" />
                       <display value="Clinical User" />
                   </coding>
Retrieved from "http://fhir.oridashi.com.au/wiki/index.php?title=Context_Roles&oldid=717"