# AU PD Practitioner - AU Provider Directory Implementation Guide v2.1.0-ci-build

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **AU PD Practitioner**

## Resource Profile: AU PD Practitioner 

| | | |
| :--- | :--- | :--- |
| *Official URL*:http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-practitioner | *Version*:2.1.0-ci-build | |
| * Standards status: *[Draft](http://hl7.org/fhir/R4/versions.html#std-process) | [Maturity Level](http://hl7.org/fhir/versions.html#maturity): 0 | *Computable Name*:AUPDPractitioner |
| **Copyright/Legal**: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. | | |

 
This profile defines provider directory details of an individual person delivering health related services. 

### Usage Notes

**Profile specific implementation guidance:**

At least one of the following defined identifier types, known to this profile, **SHALL** be supplied:

* [AU HPI-I](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-hpii.html)
* [AU PBS Prescriber Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-pbsprescribernumber.html)
* [AU Care Agency Employee Identifier](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-careagencyemployeeidentifier.html)
* [AU Ahpra Registration Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-ahpraregistrationnumber.html)

**Usages:**

* Refer to this Profile: [AU PD Practitioner Role](StructureDefinition-au-pd-practitionerrole.md)
* Examples for this Profile: [Practitioner/example0](Practitioner-example0.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/resource/hl7.fhir.au.pd|current/StructureDefinition/StructureDefinition-au-pd-practitioner.json)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-au-pd-practitioner.csv), [Excel](StructureDefinition-au-pd-practitioner.xlsx), [Schematron](StructureDefinition-au-pd-practitioner.sch) 

### Notes:

-------

**Read: Practitioner**

Read identified practitioner resource content.

`GET [base]/Practitioner/[id]`

**Example:** `GET [base]/Practitioner/1234`

**Support:** MUST support read Practitioner

**Implementation Notes:** [(how to read resource)](http://hl7.org/fhir/http.html#read)

-------

**Search: Active Status**

Search based on active status of the practitioner record.

`GET [base]/Practitioner?active=[status]`

**Example:** `GET [base]/Practitioner?active=true`

**Support:** MUST support search Practitioner by active status (true | false).

**Implementation Notes:** [(how to search by token)](http://hl7.org/fhir/search.html#token)

-------

**Search: Practitioner Name**

Search based on family, given and/or any name.

`GET [base]/Practitioner?family=[string]`

`GET [base]/Practitioner?family=[string]&given=[string]`

`GET [base]/Practitioner?name=[string]`

**Example:**

`GET [base]/Practitioner?family=Smith`

`GET [base]/Practitioner?family=Smith&practitioner.given=John`

`GET [base]/Practitioner?name=Smith`

**Support:** SHOULD support search by family, given and name.

**Implementation Notes:** [(how to search by string)](http://hl7.org/fhir/search.html#string)

-------

**Search: HPI-I**

Search based on identifier token.

`GET [base]/Practitioner?identifier=[system]|[value]`

**Example:** `GET [base]/Practitioner?identifier=http://ns.electronichealth.net.au/id/hi/hpii/1.0|8003610833334085`

**Support:** SHOULD support search by HPI-I.

**Implementation Notes:** [(how to search by token)](http://hl7.org/fhir/search.html#token)

-------



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "au-pd-practitioner",
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 0,
    "_valueInteger" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org.au/fhir/pd/ImplementationGuide/hl7.fhir.au.pd"
      }]
    }
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "draft",
    "_valueCode" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org.au/fhir/pd/ImplementationGuide/hl7.fhir.au.pd"
      }]
    }
  }],
  "url" : "http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-practitioner",
  "version" : "2.1.0-ci-build",
  "name" : "AUPDPractitioner",
  "title" : "AU PD Practitioner",
  "status" : "draft",
  "date" : "2026-06-23T04:50:00+00:00",
  "publisher" : "HL7 Australia",
  "contact" : [{
    "name" : "HL7 Australia FHIR Working Group",
    "telecom" : [{
      "system" : "url",
      "value" : "https://confluence.hl7.org/display/HAFWG",
      "use" : "work"
    }]
  }],
  "description" : "This profile defines provider directory details of an individual person delivering health related services.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "AU"
    }]
  }],
  "copyright" : "HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.",
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "v2",
    "uri" : "http://hl7.org/v2",
    "name" : "HL7 v2 Mapping"
  },
  {
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "servd",
    "uri" : "http://www.omg.org/spec/ServD/1.0/",
    "name" : "ServD"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Practitioner",
  "baseDefinition" : "http://hl7.org.au/fhir/StructureDefinition/au-practitioner",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Practitioner",
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
        "valueCode" : "trial-use"
      }],
      "path" : "Practitioner",
      "short" : "Australian Practitioner Directory Entry",
      "definition" : "Directory entry for a person who is directly or indirectly involved in the provisioning of healthcare.",
      "constraint" : [{
        "key" : "au-pd-prac-01",
        "severity" : "error",
        "human" : "At least one defined identifier, known to this AU PD Practitioner profile, must be present",
        "expression" : "identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpii/1.0' or system='http://ns.electronichealth.net.au/id/medicare-prescriber-number' or system='http://ns.electronichealth.net.au/id/pcehr/caei/1.0' or system='http://hl7.org.au/id/ahpra-registration-number').exists()",
        "source" : "http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-practitioner"
      }]
    },
    {
      "id" : "Practitioner.meta",
      "path" : "Practitioner.meta",
      "short" : "Metadata on Practitioner"
    },
    {
      "id" : "Practitioner.meta.source",
      "path" : "Practitioner.meta.source",
      "mustSupport" : true
    },
    {
      "id" : "Practitioner.identifier",
      "path" : "Practitioner.identifier",
      "slicing" : {
        "discriminator" : [{
          "type" : "pattern",
          "path" : "type"
        }],
        "rules" : "open"
      },
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "Practitioner.identifier:hpii",
      "path" : "Practitioner.identifier",
      "sliceName" : "hpii",
      "short" : "HPI-I for Directory Entry Practitioner",
      "definition" : "National identifier for the individual provider",
      "type" : [{
        "code" : "Identifier",
        "profile" : ["http://hl7.org.au/fhir/StructureDefinition/au-hpii"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "Practitioner.active",
      "path" : "Practitioner.active",
      "short" : "Required status",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "Practitioner.name",
      "path" : "Practitioner.name",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "use"
        }],
        "rules" : "openAtEnd"
      },
      "min" : 1
    },
    {
      "id" : "Practitioner.name:directory-practitioner-name",
      "path" : "Practitioner.name",
      "sliceName" : "directory-practitioner-name",
      "short" : "Usual practitioner name",
      "definition" : "Name used by practitioner that may be searched for in this directory entry",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "Practitioner.name:directory-practitioner-name.use",
      "path" : "Practitioner.name.use",
      "min" : 1,
      "fixedCode" : "usual"
    },
    {
      "id" : "Practitioner.name:directory-practitioner-name.family",
      "path" : "Practitioner.name.family",
      "min" : 1
    },
    {
      "id" : "Practitioner.name:directory-practitioner-name.given",
      "path" : "Practitioner.name.given",
      "min" : 1
    }]
  }
}

```
