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 - JSON Representation

Raw json | Download

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