AU Provider Directory Implementation Guide
2.1.0-ci-build - Draft

AU Provider Directory Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 2.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-pd/ and changes regularly. See the Directory of published versions

## : Bundle - example PractitionerRole search response - XML Representation

Raw xml | Download

    <Bundle xmlns="http://hl7.org/fhir">
      <id value="search1"/>
      <meta>
        <lastUpdated value="2018-09-11T05:03:45.071+00:00"/>
      </meta>
      <type value="searchset"/>
      <total value="1"/>
      <link>
        <relation value="self"/>
        <url
             value="https://sqlonfhir-aupd.azurewebsites.net/fhir/PractitionerRole?active=true&amp;identifier=http://ns.electronichealth.net.au/id/medicare-provider-number%7C2426621B&amp;endpoint.payload-type=http://hl7.org.au/fhir/CodeSystem/codesystem-au-endpoint-payload-type%7Chttp://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706&amp;_include=PractitionerRole:endpoint&amp;_include=PractitionerRole:location&amp;_include=PractitionerRole:organization&amp;_include=PractitionerRole:practitioner&amp;_snapshot=636722390250714988"/>
      </link>
      <link>
        <relation value="first"/>
        <url
             value="https://sqlonfhir-aupd.azurewebsites.net/fhir/PractitionerRole?active=true&amp;identifier=http://ns.electronichealth.net.au/id/medicare-provider-number%7C2426621B&amp;endpoint.payload-type=http://hl7.org.au/fhir/CodeSystem/codesystem-au-endpoint-payload-type%7Chttp://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706&amp;_include=PractitionerRole:endpoint&amp;_include=PractitionerRole:location&amp;_include=PractitionerRole:organization&amp;_include=PractitionerRole:practitioner&amp;_snapshot=636722390250714988"/>
      </link>
      <link>
        <relation value="last"/>
        <url
             value="https://sqlonfhir-aupd.azurewebsites.net/fhir/PractitionerRole?active=true&amp;identifier=http://ns.electronichealth.net.au/id/medicare-provider-number%7C2426621B&amp;endpoint.payload-type=http://hl7.org.au/fhir/CodeSystem/codesystem-au-endpoint-payload-type%7Chttp://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706&amp;_include=PractitionerRole:endpoint&amp;_include=PractitionerRole:location&amp;_include=PractitionerRole:organization&amp;_include=PractitionerRole:practitioner&amp;_snapshot=636722390250714988&amp;_page=0"/>
      </link>
      <entry>
        <fullUrl
                 value="https://sqlonfhir-aupd.azurewebsites.net/fhir/PractitionerRole/practitionerrole0"/>
        <resource>
          <PractitionerRole>
            <id value="practitionerrole0"/>
            <meta>
              <versionId value="14"/>
              <lastUpdated value="2018-04-19T05:34:06.896+00:00"/>
            </meta>
            <text>
              <status value="generated"/>
              <div xmlns="http://www.w3.org/1999/xhtml"><a name="PractitionerRole_practitionerrole0"> </a>
                            <p>
                                <b>Generated Narrative with Details</b>
                            </p>
                            <p>
                                <b>id</b>: practitionerrole0
                            </p>
                            <p>
                                <b>identifier</b>: Medicare Provider Number = 2426621B, Vendor Delivery Identifier = BD6000000X9
                            </p>
                            <p>
                                <b>active</b>: true
                            </p>
                            <p>
                                <b>practitioner</b>:
                                <a href="Practitioner-example0.html">Generated Summary: id: example0; HPI-I = 8003610833334085, Prescriber Number = 453221; active; Helen Mayo ; helen.mayo@downunderhospital.com.au(WORK)</a>
                            </p>
                            <p>
                                <b>organization</b>:
                                <a href="Organization-example0.html">Generated Summary: id: example0; HPI-O = 8003627500000328; active;

                                    <span title="Codes: {http://www.abs.gov.au/ausstats/abs@.nsf/mf/1292.0 8401}">Hospitals (except Psychiatric Hospitals)</span>,
                                    <span title="Codes: {http://www.abs.gov.au/ausstats/abs@.nsf/mf/1292.0 8401-15}">Public acute care Hospital</span>; name: Downunder Hospital; helen.mayo@downunderhospital.com.au(WORK)
                                </a>
                            </p>
                            <p>
                                <b>code</b>: Cardiologist
                                <span style="background: LightGoldenRodYellow">(Details : {SNOMED CT code '17561000' = 'Cardiologist', given as 'Cardiologist'})</span>
                            </p>
                            <p>
                                <b>location</b>:
                                <a href="Location-example0.html">Generated Summary: id: example0; status: active; name: Downunder Hospital Blacktown; ph: 025553555(WORK)</a>
                            </p>
                            <p>
                                <b>telecom</b>: ph: 025553333(WORK)
                            </p>
                            <p>
                                <b>endpoint</b>:
                                <a href="Endpoint-example0.html">Generated Summary: id: example0; status: active;

                                    <span title="{http://ns.electronichealth.net.au/smd/intf http://ns.electronichealth.net.au/smd/intf/SealedMessageDelivery/TLS/2010}">Sealed Message Delivery</span>; name: Medical Objects Test Secure Messaging Endpoint; jared@example.org(WORK); period: 18/08/2017 --&gt; (ongoing);
                                    <span title="Codes: {http://hl7.org.au/fhir/CodeSystem/codesystem-au-endpoint-payload-type http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706}, {http://hl7.org.au/fhir/CodeSystem/codesystem-au-endpoint-payload-type http://ns.electronichealth.net.au/ds/sc/deliver/hl7Mdm/2012}">Simplified Profile for HL7 V2.4 REF message</span>; payloadMimeType: application/hl7-v2; address: https://smd-ep.test.medical-objects.com.au/smd/2010
                                </a>
                            </p>
                        </div>
            </text>
            <identifier>
              <extension
                         url="http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority">
                <extension url="namespace-id">
                  <valueString value="Medical-Objects"/>
                </extension>
                <extension url="universal-id">
                  <valueString value="33443682-91F6-11D2-8F2C-444553540123"/>
                </extension>
                <extension url="universal-id-type">
                  <valueString value="GUID"/>
                </extension>
              </extension>
              <type>
                <coding>
                  <system
                          value="http://terminology.hl7.org.au/CodeSystem/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="2426621B"/>
            </identifier>
            <identifier>
              <extension
                         url="http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority">
                <extension url="namespace-id">
                  <valueString value="Medical-Objects"/>
                </extension>
                <extension url="universal-id">
                  <valueString value="33443682-91F6-11D2-8F2C-444553540123"/>
                </extension>
                <extension url="universal-id-type">
                  <valueString value="GUID"/>
                </extension>
              </extension>
              <type>
                <coding>
                  <system
                          value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
                  <code value="VDI"/>
                  <display value="Vendor Directory Identifier"/>
                </coding>
                <text value="Vendor Directory Identifier"/>
              </type>
              <system value="http://ns.medical-objects.com.au/id/routing-id"/>
              <value value="BD6000000X9"/>
              <assigner>
                <display value="Medical-Objects"/>
              </assigner>
            </identifier>
            <active value="true"/>
            <practitioner>
              <reference value="Practitioner/practitioner0"/>
              <display value="Mayo, Helen Dr"/>
            </practitioner>
            <organization>
              <reference value="Organization/organization0"/>
              <display value="Downunder Hospital"/>
            </organization>
            <specialty>
              <coding>
                <system value="http://snomed.info/sct"/>
                <code value="17561000"/>
                <display value="Cardiologist"/>
              </coding>
            </specialty>
            <location>
              <reference value="Location/location0"/>
            </location>
            <telecom>
              <system value="phone"/>
              <value value="025553333"/>
              <use value="work"/>
            </telecom>
            <endpoint>
              <reference value="Endpoint/endpoint0"/>
            </endpoint>
          </PractitionerRole>
        </resource>
        <search>
          <mode value="match"/>
        </search>
      </entry>
      <entry>
        <fullUrl
                 value="https://sqlonfhir-aupd.azurewebsites.net/fhir/Endpoint/endpoint0"/>
        <resource>
          <Endpoint>
            <id value="endpoint0"/>
            <meta>
              <versionId value="18"/>
              <lastUpdated value="2018-04-19T05:34:07.568+00:00"/>
            </meta>
            <text>
              <status value="generated"/>
              <div xmlns="http://www.w3.org/1999/xhtml"><a name="Endpoint_endpoint0"> </a>
                            <b>Medical Objects Test Secure Messaging Endpoint</b>
                            <hr/>
                            <span style="color: gray;">Work - Email:</span> jared@example.org
                        </div>
            </text>
            <extension
                       url="http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509">
              <valueString
                           value="-----BEGIN   CERTIFICATE-----"/>
            </extension>
            <extension
                       url="http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility">
              <extension url="namespace-id">
                <valueString value="Buderim Medical Center"/>
              </extension>
              <extension url="universal-id">
                <valueString value="877F9695-1298-4E6A-B432-0FDD46AD80B8"/>
              </extension>
              <extension url="universal-id-type">
                <valueString value="GUID"/>
              </extension>
            </extension>
            <extension
                       url="http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication">
              <extension url="namespace-id">
                <valueString value="Equator"/>
              </extension>
              <extension url="universal-id">
                <valueString value="Equator:3.1.4"/>
              </extension>
              <extension url="universal-id-type">
                <valueString value="L"/>
              </extension>
            </extension>
            <status value="active"/>
            <connectionType>
              <system value="http://hl7.org.au/fhir/CodeSystem/smd-interfaces"/>
              <code
                    value="http://ns.electronichealth.net.au/smd/intf/SealedMessageDelivery/TLS/2010"/>
            </connectionType>
            <name value="Medical Objects Test Secure Messaging Endpoint"/>
            <managingOrganization>
              <display value="Medical Objects"/>
            </managingOrganization>
            <contact>
              <system value="email"/>
              <value value="jared@example.org"/>
              <use value="work"/>
            </contact>
            <period>
              <start value="2017-08-18"/>
            </period>
            <payloadType>
              <coding>
                <system
                        value="http://hl7.org.au/fhir/CodeSystem/endpoint-payload-type"/>
                <code
                      value="http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706"/>
              </coding>
              <coding>
                <system
                        value="http://hl7.org.au/fhir/CodeSystem/endpoint-payload-type"/>
                <code
                      value="http://ns.electronichealth.net.au/ds/sc/deliver/hl7Mdm/2012"/>
              </coding>
            </payloadType>
            <payloadMimeType value="application/hl7-v2"/>
            <address value="https://smd-ep.test.medical-objects.com.au/smd/2010"/>
          </Endpoint>
        </resource>
        <search>
          <mode value="include"/>
        </search>
      </entry>
      <entry>
        <fullUrl
                 value="https://sqlonfhir-aupd.azurewebsites.net/fhir/Location/location0"/>
        <resource>
          <Location>
            <id value="location0"/>
            <meta>
              <versionId value="18"/>
              <lastUpdated value="2018-04-19T05:33:11.811+00:00"/>
            </meta>
            <text>
              <status value="generated"/>
              <div xmlns="http://www.w3.org/1999/xhtml"><a name="Location_location0"> </a>
                            <p>
                                <b>Generated Narrative with Details</b>
                            </p>
                            <p>
                                <b>id</b>: example0
                            </p>
                            <p>
                                <b>status</b>: active
                            </p>
                            <p>
                                <b>name</b>: Downunder Hospital Blacktown
                            </p>
                            <p>
                                <b>telecom</b>: ph: 025553555(WORK)
                            </p>
                            <p>
                                <b>address</b>: 3 McGregor Street Blacktown NSW 2148 Australia (WORK)
                            </p>
                        </div>
            </text>
            <status value="active"/>
            <name value="Downunder Hospital Blacktown"/>
            <telecom>
              <system value="phone"/>
              <value value="025553555"/>
              <use value="work"/>
            </telecom>
            <address>
              <use value="work"/>
              <line value="3 McGregor Street"/>
              <city value="Blacktown"/>
              <state value="NSW"/>
              <postalCode value="2148"/>
              <country value="Australia"/>
            </address>
          </Location>
        </resource>
        <search>
          <mode value="include"/>
        </search>
      </entry>
      <entry>
        <fullUrl
                 value="https://sqlonfhir-aupd.azurewebsites.net/fhir/Organization/organization0"/>
        <resource>
          <Organization>
            <id value="organization0"/>
            <meta>
              <versionId value="22"/>
              <lastUpdated value="2018-04-19T05:34:05.14+00:00"/>
            </meta>
            <text>
              <status value="generated"/>
              <div xmlns="http://www.w3.org/1999/xhtml"><a name="Organization_organization0"> </a>
                            <p>
                                <b>Generated Narrative with Details</b>
                            </p>
                            <p>
                                <b>id</b>: example0
                            </p>
                            <p>
                                <b>identifier</b>: HPI-O = 8003627500000328
                            </p>
                            <p>
                                <b>active</b>: true
                            </p>
                            <p>
                                <b>type</b>: Hospitals (except Psychiatric Hospitals)
                                <span style="background: LightGoldenRodYellow">(Details : {http://www.abs.gov.au/ausstats/abs@.nsf/mf/1292.0 code '8401' = 'Hospitals (except Psychiatric Hospitals)', given as 'Hospitals (except Psychiatric Hospitals)'})</span>, Public acute care Hospital
                                <span style="background: LightGoldenRodYellow">(Details : {http://www.abs.gov.au/ausstats/abs@.nsf/mf/1292.0 code '8401-15' = 'Public acute care Hospital', given as 'Public acute care Hospital'})</span>
                            </p>
                            <p>
                                <b>name</b>: Downunder Hospital
                            </p>
                            <p>
                                <b>telecom</b>: helen.mayo@downunderhospital.com.au(WORK)
                            </p>
                            <p>
                                <b>address</b>: 3 McGregor Street Blacktown NSW 2148 Australia (WORK)
                            </p>
                        </div>
            </text>
            <identifier>
              <type>
                <coding>
                  <system
                          value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
                  <code value="NOI"/>
                  <display value="National Organisation Identifier"/>
                </coding>
                <text value="HPI-O"/>
              </type>
              <system value="http://ns.electronichealth.net.au/id/hi/hpio/1.0"/>
              <value value="8003627500000328"/>
            </identifier>
            <active value="true"/>
            <type>
              <coding>
                <system
                        value="http://www.abs.gov.au/ausstats/abs@.nsf/mf/1292.0"/>
                <code value="8401"/>
                <display value="Hospitals (except Psychiatric Hospitals)"/>
              </coding>
            </type>
            <type>
              <coding>
                <system
                        value="http://www.abs.gov.au/ausstats/abs@.nsf/mf/1292.0"/>
                <code value="8401-15"/>
                <display value="Public acute care Hospital"/>
              </coding>
            </type>
            <name value="Downunder Hospital"/>
            <telecom>
              <system value="email"/>
              <value value="helen.mayo@downunderhospital.com.au"/>
              <use value="work"/>
            </telecom>
            <address>
              <use value="work"/>
              <line value="3 McGregor Street"/>
              <city value="Blacktown"/>
              <state value="NSW"/>
              <postalCode value="2148"/>
              <country value="Australia"/>
            </address>
          </Organization>
        </resource>
        <search>
          <mode value="include"/>
        </search>
      </entry>
      <entry>
        <fullUrl
                 value="https://sqlonfhir-aupd.azurewebsites.net/fhir/Practitioner/practitioner0"/>
        <resource>
          <Practitioner>
            <id value="practitioner0"/>
            <meta>
              <versionId value="8"/>
              <lastUpdated value="2018-04-19T05:34:05.968+00:00"/>
            </meta>
            <text>
              <status value="generated"/>
              <div xmlns="http://www.w3.org/1999/xhtml"><a name="Practitioner_practitioner0"> </a>
                            <p>
                                <b>Generated Narrative with Details</b>
                            </p>
                            <p>
                                <b>id</b>: example0
                            </p>
                            <p>
                                <b>identifier</b>: HPI-I = 8003610833334085, Prescriber Number = 453221
                            </p>
                            <p>
                                <b>active</b>: true
                            </p>
                            <p>
                                <b>name</b>: Helen Mayo
                            </p>
                            <p>
                                <b>telecom</b>: helen.mayo@downunderhospital.com.au(WORK)
                            </p>
                            <p>
                                <b>address</b>: 3 McGregor Street Blacktown NSW 2148 Australia (WORK)
                            </p>
                        </div>
            </text>
            <identifier>
              <type>
                <coding>
                  <system
                          value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
                  <code value="NPIO"/>
                  <display value="National provider at organisation identifier"/>
                </coding>
                <text value="HPI-I"/>
              </type>
              <system value="http://ns.electronichealth.net.au/id/hi/hpii/1.0"/>
              <value value="8003610833334085"/>
            </identifier>
            <identifier>
              <type>
                <coding>
                  <system
                          value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
                  <code value="PRES"/>
                  <display value="Prescriber Number"/>
                </coding>
                <text value="Prescriber Number"/>
              </type>
              <system
                      value="http://ns.electronichealth.net.au/id/prescriber-number"/>
              <value value="453221"/>
            </identifier>
            <active value="true"/>
            <name>
              <use value="usual"/>
              <text value="Mayo, Helen Dr"/>
              <family value="Mayo"/>
              <given value="Helen"/>
              <prefix value="Dr"/>
            </name>
            <telecom>
              <system value="email"/>
              <value value="helen.mayo@downunderhospital.com.au"/>
              <use value="work"/>
            </telecom>
            <address>
              <use value="work"/>
              <line value="3 McGregor Street"/>
              <city value="Blacktown"/>
              <state value="NSW"/>
              <postalCode value="2148"/>
              <country value="Australia"/>
            </address>
          </Practitioner>
        </resource>
        <search>
          <mode value="include"/>
        </search>
      </entry>
    </Bundle>