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

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

## Resource Profile: AU PD Location 

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

 
This profile defines a provider directory entry for a location. 

This profile defines the service delivery location by address at a minimum.

### Usage Notes

**Profile specific implementation guidance:**

One of the following defined identifier types, known to this profile, **SHOULD** be supplied:

* [AU Location Specific Practice Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-locationspecificpracticenumber.html)
* [AU NATA Site Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-natasitenumber.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 Blacktown](Location-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-location.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-location.csv), [Excel](StructureDefinition-au-pd-location.xlsx), [Schematron](StructureDefinition-au-pd-location.sch) 

### Notes:

-------

**Read: Location**

Read identified location resource content.

`GET [base]/Location/[id]`

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

**Support:**

* MUST support read Location

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

-------

**Search: Active Status**

Search based on active status of the endpoint record.

`GET [base]/Endpoint?status=[code]`

**Example:** `GET [base]/Endpoint?status=active`

**Support:** MUST support search Organization by active status code (active | suspended | inactive)

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

-------

**Search: Location Address Parts**

Search based on address parts for postcode, suburb, and state.

`GET [base]/Location?address-postalcode=[postcode]`

`GET [base]/Location?address-city=[suburb]`

`GET [base]/Location?address-state=[state]`

**Example:**

`GET [base]/Location?address-postalcode=3101`

`GET [base]/Location?address-city=Bundaberg`

`GET [base]/Location?address-state=VIC`

**Support:**

* SHOULD support search Location by address parts address-postalcode, address-city, address-state.
* SHOULD support basic **param=[string]** search which is case and accent-insensitive search; field equals or starts with the string value.

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

-------

**Search: Location Distance**

Search based on address within a nominated distance.

`GET [base]/Location?near=[latitude]:[longitude]&near-distance=[prefix][value]|[units-system]|[units]`

**Example:** `GET [base]/Location?near=-83.694810:42.256500&near-distance=le10.0|http://unitsofmeasure.org|km`

**Support:**

* SHOULD support search Location within a distance.
* SHOULD support: [prefix] fixed 'le' is less than or equal to distance [value] is a decimal quantity number [units-system] fixed 'http://unitsofmeasure.org' identifies standard distance units are used [units] distance units must support 'km' or 'm'

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

-------

**Search: Combination**

* The following searches MUST be able to be perfomed together in a single request using logical AND for criteria. e.g in postcode within 2km

-------



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "au-pd-location",
  "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-location",
  "version" : "2.1.0-ci-build",
  "name" : "AUPDLocation",
  "title" : "AU PD Location",
  "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 a provider directory entry for a location.",
  "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" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Location",
  "baseDefinition" : "http://hl7.org.au/fhir/StructureDefinition/au-location",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Location",
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
        "valueCode" : "trial-use"
      }],
      "path" : "Location",
      "short" : "Australian Location Directory Entry",
      "constraint" : [{
        "key" : "au-pd-loc-01",
        "severity" : "warning",
        "human" : "At least one defined identifier, known to this AU PD Location profile, should be present",
        "expression" : "identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/id/location-specific-practice-number' or system='http://hl7.org.au/id/nata-site').exists()",
        "source" : "http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-location"
      }]
    },
    {
      "id" : "Location.meta",
      "path" : "Location.meta",
      "short" : "Metadata on Location"
    },
    {
      "id" : "Location.meta.source",
      "path" : "Location.meta.source",
      "mustSupport" : true
    },
    {
      "id" : "Location.identifier",
      "path" : "Location.identifier",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "Location.status",
      "path" : "Location.status",
      "short" : "Required status",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "Location.address",
      "path" : "Location.address",
      "short" : "Australian location",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "Location.address.state",
      "path" : "Location.address.state",
      "binding" : {
        "strength" : "required",
        "description" : "well known state representation",
        "valueSet" : "http://hl7.org.au/fhir/pd/ValueSet/au-physical-states-territories"
      }
    }]
  }
}

```
