# Change Log - AU Provider Directory Implementation Guide v2.1.0-ci-build

* [**Table of Contents**](toc.md)
* **Change Log**

## Change Log

| |
| :--- |
| *Page standards status:*[Informative](http://hl7.org/fhir/R4/versions.html#std-process) |

### 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](variance.md) page added as required HL7 AU IG Content
* [Licence and Legal](license.md) 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](http://hl7.org.au/fhir/4.1.0/changes.html#release-410). The specific changes impacting this IG are: 
* Changed [Location Type (Physical) AU](http://hl7.org.au/fhir/4.1.0/CodeSystem-au-location-physical-type.html) 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](StructureDefinition-au-pd-vdi.md) - **new** 
* refactored from the in-line Identifier definitions in [AU PD Healthcare Service](StructureDefinition-au-pd-healthcareservice.md) and [AU PD Practitioner Role](StructureDefinition-au-pd-practitionerrole.md), 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](StructureDefinition-au-pd-smdtargetidentifier.md) - **new** 
* refactored from the in-line Identifier definitions in [AU PD Secure Messaging Endpoint](StructureDefinition-au-pd-sm-endpoint.md)
 
* Profile: [AU PD Healthcare Service](StructureDefinition-au-pd-healthcareservice.md) 
* 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](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-hpio.html), [AU Residential Aged Care Service Identifier](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-residentialagedcareserviceidentifier.html) or [AU Vendor Directory Identifier](StructureDefinition-au-pd-vdi.md) - **breaking change**
* removed in-line identifier definitions for `pdvendor` and instead reference the new [AU Vendor Directory Identifier](StructureDefinition-au-pd-vdi.md) 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](http://hl7.org.au/fhir/4.1.0/StructureDefinition-au-assigningauthority.html) on all Identifier slices
* the inheritance from the updated AU Base HealthcareService introduces the [Identifier Routability Identifier extension](http://hl7.org.au/fhir/4.1.0/StructureDefinition-identifier-routability.html) on all Identifier slices
* HealthcareService.endpoint must only be a reference to an [AU PD Secure Messaging Endpoint](StructureDefinition-au-pd-sm-endpoint.md)
* HealthcareService.availableTime.availableStartTime and HealthcareService.availableTime.availableStartTime both include the [Australian Time Zone extension](http://hl7.org.au/fhir/4.1.0/StructureDefinition-au-timezone.html) with its required binding to the [AU Time Zone ValueSet](http://hl7.org.au/fhir/4.1.0/ValueSet-au-timezone.html)
 
* Profile: [AU PD Location](StructureDefinition-au-pd-location.md) 
* 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](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-locationspecificpracticenumber.html) or [AU NATA Site Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-natasitenumber.html)
* Location.identifier is now must support = true
* the inheritance from the updated AU Base Location includes [AustralianAddress](http://hl7.org.au/fhir/4.1.0/StructureDefinition-au-address.html) as an allowed Location.address type 
* the inheritance from the updated AU Base Location includes [AU Location Specific Practice Number](http://hl7.org.au/fhir/4.1.0/StructureDefinition-au-locationspecificpracticenumber.html) as an allowed Location.identifier type 
 
* Profile: [AU PD Organisation](StructureDefinition-au-pd-organisation.md) 
* 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](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) or [AU Pharmacy Approval Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-pharmacyapprovalnumber.html) - **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](StructureDefinition-au-pd-practitioner.md) 
* 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](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) or[AU Ahpra Registration Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-ahpraregistrationnumber.html) - **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](StructureDefinition-au-pd-practitionerrole.md) 
* 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](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-medicareprovidernumber.html), [AU National Provider Identifier At Organisation](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-nationalprovideridentifieratorganisation.html), [AU Employee Number](https://hl7.org.au/fhir/4.1.0/StructureDefinition-au-employeenumber.html) or [AU Vendor Directory Identifier](StructureDefinition-au-pd-vdi.md) - **breaking change**
* removed in-line identifier definitions for `vendorAssignedDirectoryIdentifier` and instead reference the new [AU Vendor Directory Identifier](StructureDefinition-au-pd-vdi.md) 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](http://hl7.org.au/fhir/4.1.0/StructureDefinition-au-assigningauthority.html) on all Identifier slices
* the inheritance from the updated AU Base PractitionerRole introduces the [Identifier Routability Identifier extension](http://hl7.org.au/fhir/4.1.0/StructureDefinition-identifier-routability.html) 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](http://hl7.org.au/fhir/4.1.0/StructureDefinition-au-timezone.html) with its required binding to the [AU Time Zone ValueSet](http://hl7.org.au/fhir/4.1.0/ValueSet-au-timezone.html)
* PractitionerRole.endpoint must only be a reference to an [AU PD Secure Messaging Endpoint](StructureDefinition-au-pd-sm-endpoint.md)
 
* Profile: [AU PD Secure Messaging Endpoint](StructureDefinition-au-pd-sm-endpoint.md) 
* 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](StructureDefinition-au-pd-smdtargetidentifier.md) - **breaking change**
* removed in-line identifier definitions for `smdtarget` and instead references the new [PD Secure Messaging Delivery Target Identifier](StructureDefinition-au-pd-smdtargetidentifier.md) 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](ValueSet-service-interfaces.md) 
* the compose statement was updated to include the core specification Endpoint Connection Type valueSet
 
* CodeSystem: [Australian Endpoint Payload Types](CodeSystem-endpoint-payload-type.md) 
* 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](HealthcareService-example0.md): added a snippet of the AU Vendor Directory Identifier
* [practitionerrole-example0.xml](PractitionerRole-example0.md): 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

