Health Connect Australia Provider Directory FHIR Implementation Guide

Usage notes

This extension indicates whether a Health Connect Provider Directory resource has been deactivated and identifies the party responsible for initiating the status change. It carries coded information about the actor who initiated the deactivation and is applied to the active element (Organization, Practitioner, PractitionerRole, HealthcareService) or the status element (Location, Endpoint). This extension is expected to be present whenever that element indicates the resource is no longer active.

Datatype and context

The DeactivatedBy extension is a simple extension with a single required CodeableConcept value. It is applied directly to the active or status element of the relevant HCPD resource profiles. The coded value is drawn from the Responsible Party Type CodeSystem.

This extension is profiled on the following HCPD resource elements with fixed values:

• Organization — organisation-initiated only
• Practitioner — practitioner-initiated only
• PractitionerRole — either code permitted
• HealthcareService — organisation-initiated only
• Location — organisation-initiated only
• Endpoint — organisation-initiated only

Deactivation scenarios

1. Practitioner self-deactivation:
   • Practitioner sets their own active = false, carrying practitioner-initiated in DeactivatedBy
   • This cascades to deactivate all their associated PractitionerRole resources
2. Organisation-initiated deactivation:
   • An organisation administrator sets active = false (or status to a non-active value) on any of their resources, carrying organisation-initiated in DeactivatedBy
   • When applied to an Organization, deactivation automatically cascades to all child HealthcareService, Location, PractitionerRole, and Endpoint resources
3. PractitionerRole deactivation:
   • A PractitionerRole may be deactivated by either party; the code indicates which actor initiated the change without affecting the referenced Practitioner

Relationship to the Suppressed extension

Both DeactivatedBy and the Suppressed extension follow the same cascade hierarchy. The key distinction is:

Cascade hierarchy

The deactivation cascade follows the same organisational hierarchy as suppression:

• Differential Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Extension

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..1	Extension(4.0.1)	Who initiated deactivation
Extension.extension		1..*	Extension	Extension
Extension.Slices for extension				Content/Rules for all slices
Extension.Slices for extension.extension:deactivatedBy	S This element must be supported.	1..1	Extension	Who initiated the deactivation
Extension.Slices for extension.extension:deactivatedBy.extension		0..0		Extension
Extension.Slices for extension.extension:deactivatedBy.url		1..1	uri	"deactivatedBy"
Extension.Slices for extension.extension:deactivatedBy.value[x]	S This element must be supported.	1..1	CodeableConcept	Value of extension
Extension.Slices for extension.extension:deactivatedBy.value[x].coding		1..2	Coding	Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required)
Extension.url		1..1	uri	"http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
Extension.value[x]		0..0		Value of extension
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..1	Extension(4.0.1)	Who initiated deactivation Constraints: ext-1
Extension.id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Extension.Slices for extension.extension:deactivatedBy	S This element must be supported.	1..1	Extension	Who initiated the deactivation Constraints: ext-1
Extension.Slices for extension.extension:deactivatedBy.id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:deactivatedBy.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
Extension.Slices for extension.extension:deactivatedBy.url		1..1	uri	"deactivatedBy"
Extension.Slices for extension.extension:deactivatedBy.value[x]	S This element must be supported.	1..1	CodeableConcept	Value of extension
Extension.Slices for extension.extension:deactivatedBy.value[x].id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:deactivatedBy.value[x].extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
Extension.Slices for extension.extension:deactivatedBy.value[x].coding	Σ This element is included in summaries.	1..2	Coding	Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required)
Extension.Slices for extension.extension:deactivatedBy.value[x].text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Extension.url		1..1	uri	"http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
Documentation for this format

Differential View

This structure is derived from Extension

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..1	Extension(4.0.1)	Who initiated deactivation
Extension.extension		1..*	Extension	Extension
Extension.Slices for extension				Content/Rules for all slices
Extension.Slices for extension.extension:deactivatedBy	S This element must be supported.	1..1	Extension	Who initiated the deactivation
Extension.Slices for extension.extension:deactivatedBy.extension		0..0		Extension
Extension.Slices for extension.extension:deactivatedBy.url		1..1	uri	"deactivatedBy"
Extension.Slices for extension.extension:deactivatedBy.value[x]	S This element must be supported.	1..1	CodeableConcept	Value of extension
Extension.Slices for extension.extension:deactivatedBy.value[x].coding		1..2	Coding	Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required)
Extension.url		1..1	uri	"http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
Extension.value[x]		0..0		Value of extension
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..1	Extension(4.0.1)	Who initiated deactivation Constraints: ext-1
Extension.id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
Extension.Slices for extension.extension:deactivatedBy	S This element must be supported.	1..1	Extension	Who initiated the deactivation Constraints: ext-1
Extension.Slices for extension.extension:deactivatedBy.id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:deactivatedBy.extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
Extension.Slices for extension.extension:deactivatedBy.url		1..1	uri	"deactivatedBy"
Extension.Slices for extension.extension:deactivatedBy.value[x]	S This element must be supported.	1..1	CodeableConcept	Value of extension
Extension.Slices for extension.extension:deactivatedBy.value[x].id		0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:deactivatedBy.value[x].extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
Extension.Slices for extension.extension:deactivatedBy.value[x].coding	Σ This element is included in summaries.	1..2	Coding	Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required)
Extension.Slices for extension.extension:deactivatedBy.value[x].text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Extension.url		1..1	uri	"http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Identifies the party responsible for setting the parent resource to an inactive or suspended state. This extension is expected to be present whenever the resource's active or status element indicates it is no longer active, and provides audit metadata about the actor who initiated the change.

• deactivatedBy: CodeableConcept: Identifies the actor who initiated the deactivation request (e.g., practitioner, organisation).