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

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

## Resource Profile: AU PD Organisation 

| | | |
| :--- | :--- | :--- |
| *Official URL*:http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-organisation | *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*:AUPDOrganisation |
| **Copyright/Legal**: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. | | |

 
This profile defines a provider directory entry for an organisation. 

### Usage Notes

**Profile specific implementation guidance:**

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

* [AU HPI-O](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-hpio.html)
* [AU PAI-O Identifier](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-paioidentifier.html)
* [AU CSP Registration Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-cspregistrationnumber.html)
* [AU Australian Business Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-australianbusinessnumber.html)
* [AU Australian Company Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-australiancompanynumber.html)
* [AU Australian Registered Body Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-australianregistredbodynumber.html)
* [AU NATA Accreditation Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-nataaccreditationnumber.html)
* [AU Pharmacy Approval Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-pharmacyapprovalnumber.html)

**Usages:**

* Refer to this Profile: [AU PD Healthcare Service](StructureDefinition-au-pd-healthcareservice.md) and [AU PD Practitioner Role](StructureDefinition-au-pd-practitionerrole.md)
* Examples for this Profile: [Downunder Hospital](Organization-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-organisation.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-organisation.csv), [Excel](StructureDefinition-au-pd-organisation.xlsx), [Schematron](StructureDefinition-au-pd-organisation.sch) 

### Notes:

-------

**Read: Organisation**

Read identified organisation resource content.

`GET [base]/Organization/[id]`

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

**Support:** MUST support read Organisation

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

-------

**Search: Active Status**

Search based on active status of the organisation record.

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

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

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

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

-------

**Search: HPI-O**

Search based on identifier token.

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

**Example:** `GET [base]/Organization?identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003627500000328`

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

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

-------

**Search: Name**

Search for a organisation by name.

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

**Example:** `GET [base]/Organization?name=southern%20clinic`

**Support:**

* MUST support search by Organisation name.

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

-------

**Search: Combination**

* Searches MUST be able to be perfomed in a single request using logical AND for criteria. e.g name and status

-------



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "au-pd-organisation",
  "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-organisation",
  "version" : "2.1.0-ci-build",
  "name" : "AUPDOrganisation",
  "title" : "AU PD Organisation",
  "status" : "draft",
  "date" : "2026-06-17T22:24:03+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 a provider directory entry for an organisation.",
  "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" : "Organization",
  "baseDefinition" : "http://hl7.org.au/fhir/StructureDefinition/au-organization",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Organization",
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
        "valueCode" : "trial-use"
      }],
      "path" : "Organization",
      "short" : "Australian Organisation Directory Entry",
      "definition" : "Directory entry Australian realm Organisation profile often healthcare or related service provision.",
      "constraint" : [{
        "key" : "au-pd-org-01",
        "severity" : "error",
        "human" : "At least one defined identifier, known to this AU PD Organisation profile, must be present",
        "expression" : "identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/hi/hpio/1.0' or system='http://ns.electronichealth.net.au/id/pcehr/paio/1.0' or system='http://ns.electronichealth.net.au/id/hi/csp/1.0' or system='http://hl7.org.au/id/abn' or system='http://hl7.org.au/id/acn' or system='http://hl7.org.au/id/arbn' or system='http://hl7.org.au/id/nata-accreditation' or system='http://ns.electronichealth.net.au/id/pharmacy-approval-number').exists()",
        "source" : "http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-organisation"
      }]
    },
    {
      "id" : "Organization.meta",
      "path" : "Organization.meta",
      "short" : "Metadata on Organisation"
    },
    {
      "id" : "Organization.meta.source",
      "path" : "Organization.meta.source",
      "mustSupport" : true
    },
    {
      "id" : "Organization.identifier",
      "path" : "Organization.identifier",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "system"
        }],
        "rules" : "open"
      },
      "short" : "Organisation Directory Entry Identifiers",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "Organization.identifier:hpio",
      "path" : "Organization.identifier",
      "sliceName" : "hpio",
      "type" : [{
        "code" : "Identifier",
        "profile" : ["http://hl7.org.au/fhir/StructureDefinition/au-hpio"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "Organization.active",
      "path" : "Organization.active",
      "short" : "Status of Directory Entry Organisation",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "Organization.name",
      "path" : "Organization.name",
      "short" : "Name of Directory Entry Organisation",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "Organization.telecom",
      "path" : "Organization.telecom",
      "short" : "Contact Details of Directory Entry Organisation",
      "mustSupport" : true
    },
    {
      "id" : "Organization.address",
      "path" : "Organization.address",
      "short" : "Addresses of Directory Entry Organisation",
      "mustSupport" : true
    },
    {
      "id" : "Organization.address.state",
      "path" : "Organization.address.state",
      "binding" : {
        "strength" : "required",
        "description" : "well known state representation",
        "valueSet" : "http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories"
      }
    }]
  }
}

```
