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

## Change Log

Page standards status: Informative

### Release TBD

- Expected Publication date: ??
- Expected Publication status: Working Standard
- Based on FHIR version: 4.0.1

The changes in this update are in progress and yet to be balloted.

To help implementers, only the more significant changes are listed here.

#### Changes in this version

- AU Variance Statement page added as required HL7 AU IG Content
- Licence and Legal page added as required HL7 AU IG Content
- Changed HL7 AU implementation guide publication structure and format to better align to current HL7 practices.
- Updated dependency on au-fhir-base version '4.1.0', from version '4.1.0-ballot'. Refer to au-fhir-base detailed change log. The specific changes impacting this IG are:
  - Changed Location Type (Physical) AU to deprecate concept 'vi'. This code has been deprecated as it has been replaced by an equivalent term provided by HL7 international.
- Profile: AU Vendor Directory Identifier - new
  - refactored from the in-line Identifier definitions in AU PD Healthcare Service and AU PD Practitioner Role, thereby amalgamating the respective definitions into a single datatype profile
  - constraints follow other HL7AU Base IG Identifier profiles, such as using `patternCodeableConcept` for `type.coding`, and not mandating `type.text`
- Profile: PD Secure Messaging Delivery Target Identifier - new
  - refactored from the in-line Identifier definitions in AU PD Secure Messaging Endpoint
- Profile: AU PD Healthcare Service
  - based on FHIR version 4.0.1 instead of 4.0.0
  - mandated at least one of the known and defined Identifier types (invariant `au-pd-hs-01`), i.e. AU HPI-O, AU Residential Aged Care Service Identifier or AU Vendor Directory Identifier - breaking change
  - removed in-line identifier definitions for `pdvendor` and instead reference the new AU Vendor Directory Identifier profile. The impact of this change on representations of vendor directory identifiers is that:
    - `type.coding.system` value is now `http://terminology.hl7.org.au/CodeSystem/v2-0203` (instead of `http://terminology.hl7.org/CodeSystem/v2-0203`) - breaking change
    - `type.text` value is no longer mandatory
  - the identifier slice discriminator has been updated to be `pattern:type`
  - the inheritance from the updated AU Base HealthcareService includes explicit Identifier types for all of the applicable organisation identifiers (i.e. HPI-O and AU Residential Aged Care Service Identifier)
  - the inheritance from the updated AU Base HealthcareService allows the HL7 V2 Assigning Authority Identifier extension on all Identifier slices
  - the inheritance from the updated AU Base HealthcareService introduces the Identifier Routability Identifier extension on all Identifier slices
  - HealthcareService.endpoint must only be a reference to an AU PD Secure Messaging Endpoint
  - HealthcareService.availableTime.availableStartTime and HealthcareService.availableTime.availableStartTime both include the Australian Time Zone extension with its required binding to the AU Time Zone ValueSet
- Profile: AU PD Location
  - based on FHIR version 4.0.1 instead of 4.0.0
  - at least one of the known and defined Identifier types should be present (invariant `au-pd-loc-01`), i.e. AU Location Specific Practice Number or AU NATA Site Number
  - Location.identifier is now must support = true
  - the inheritance from the updated AU Base Location includes AustralianAddress as an allowed Location.address type
  - the inheritance from the updated AU Base Location includes AU Location Specific Practice Number as an allowed Location.identifier type
- Profile: AU PD Organisation
  - based on FHIR version 4.0.1 instead of 4.0.0
  - mandated at least one of the known and defined Identifier types (invariant `au-pd-org-01`), i.e. AU HPI-O, AU PAI-O Identifier, AU CSP Registration Number, AU Australian Business Number, AU Australian Company Number, AU Australian Registered Body Number, AU NATA Accreditation Number or AU Pharmacy Approval Number - breaking change
  - the slicing discriminator on Organization.identifier is now `pattern:type`
  - Organization.identifier is now must support = true
  - the inheritance from the updated AU Base Organisation includes explicit Identifier types for all of the applicable organisation identifiers (i.e. HPI-O, ACN, ABN etc)
- Profile: AU PD Practitioner
  - based on FHIR version 4.0.1 instead of 4.0.0
  - mandated at least one of the known and defined Identifier types (invariant `au-pd-prac-01`), i.e. AU HPI-I, AU PBS Prescriber Number, AU Care Agency Employee Identifier orAU Ahpra Registration Number - breaking change
  - the Practitioner.identifier element has been updated to have slicing discriminator of `pattern:type`, must support = true and the HPI-I identifier datatype profile properly referenced
  - the inheritance from the updated AU Base Practitioner includes explicit Identifier types for all of the applicable practitioner identifiers (i.e. HPI-I, PBS prescriber number etc)
- Profile: AU PD Practitioner Role
  - based on FHIR version 4.0.1 instead of 4.0.0
  - mandated at least one of the known and defined Identifier types (invariant `au-pd-pracrole-01`), i.e. AU Medicare Provider Number, AU National Provider Identifier At Organisation, AU Employee Number or AU Vendor Directory Identifier - breaking change
  - removed in-line identifier definitions for `vendorAssignedDirectoryIdentifier` and instead reference the new AU Vendor Directory Identifier profile. The impact of this change on representations of vendor directory identifiers is that:
    - `type` value is now mandatory - breaking change
    - `type.coding.system` is now mandatory with a fixed value of `http://terminology.hl7.org.au/CodeSystem/v2-0203` - breaking change
    - `type.coding.code` is now mandatory - breaking change
    - `type.text` value is no longer mandatory
    - `system` is now mandatory - breaking change
    - `value` is now mandatory - breaking change
  - the identifier slice discriminator has been updated to be `pattern:type`
  - the inheritance from the updated AU Base PractitionerRole includes explicit Identifier types for all of the applicable practitioner role identifiers (i.e. Medicare provider number, National Provider Identifier At Organisation etc)
  - the inheritance from the updated AU Base PractitionerRole allows the HL7 V2 Assigning Authority Identifier extension on all Identifier slices
  - the inheritance from the updated AU Base PractitionerRole introduces the Identifier Routability Identifier extension on all Identifier slices
  - PractitionerRole.location - exactly one must be present
  - PractitionerRole.availableTime.availableStartTime and PractitionerRole.availableTime.availableStartTime both include the Australian Time Zone extension with its required binding to the AU Time Zone ValueSet
  - PractitionerRole.endpoint must only be a reference to an AU PD Secure Messaging Endpoint
- Profile: AU PD Secure Messaging Endpoint
  - based on FHIR version 4.0.1 instead of 4.0.0
  - mandated at least one of the known and defined Identifier types (invariant `au-pd-ep-01`), i.e. PD Secure Messaging Delivery Target Identifier - breaking change
  - removed in-line identifier definitions for `smdtarget` and instead references the new PD Secure Messaging Delivery Target Identifier profile. This update does not involve any constraint changes.
  - the identifier slice discriminator has been updated to be `pattern:type`
  - Endpoint.identifier is now must support = true
- ValueSet: Australian Service Interfaces
  - the compose statement was updated to include the core specification Endpoint Connection Type valueSet
- CodeSystem: Australian Endpoint Payload Types
  - 4 concepts were added for HL7 v2.4 ORU, ORM, ORR and ACK messages
  - concepts no longer have a nested hierarchy
- Examples:
  - healthcareservice-example0.xml: added a snippet of the AU Vendor Directory Identifier
  - practitionerrole-example0.xml: corrected wrong system value for Medicare Provider Number identifier
- Guidance page
  - guidance was updated
- SearchParameter page
  - the 3 listed SearchParameters in v2.0 are no longer present in v2.1.0
- Capability Statement page
  - the table 'Type Level Search' has introduced a differentiation of search parameters for must support vs should support
- Federation of Directory Services page
  - requirement `FED04 Paging of directory service results` now includes explicit support for servers

### Release 2.0.1

- Publication date: 2019-08-15
- Publication status: PD 2 on FHIR R4
- Based on FHIR version: 4.0.0

### Release 1.0.0

- Publication date: 2019-05-14
- Publication status: PD 1 on FHIR STU3 (no ballot)
- Based on FHIR version: 3.0.1

### Release 0.9.0

- Publication date: 2019-02-20
- Publication status: February 2019 QA Preview
- Based on FHIR version: 3.0.1

### Release 0.5.0

- Publication date: 2018-09-12
- Publication status: October 2018 Build
- Based on FHIR version: 3.0.1

### Release 0.4.0

- Publication date: 2018-03-07
- Publication status: March 2018 Build
- Based on FHIR version: 3.0.1

### Release 0.3.0

- Publication date: 2017-11-24
- Publication status: Dec 2017 Build
- Based on FHIR version: 3.0.1

### Release 0.2.0

- Publication date: 2017-09-20
- Publication status: September 2017 Build
- Based on FHIR version: 3.0.1

### Release 0.1.0

- Publication date: 2017-07-09
- Publication status: July 2017 build. First official published version of this implementation guide.
- Based on FHIR version: 3.0.1