Health Connect Australia Provider Directory FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 26.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HCPD-Snapshot-26.0.0-HL7AU-Connectathon-Aug-25-26/ and changes regularly. See the Directory of published versions

Extension: Deactivated

Official URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Version: 26.0.0
Active as of 2026-08-14 Computable Name: Deactivated

Copyright/Legal: This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/

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.

Captures who initiated a status or active-flag change on a Health Connect Provider Directory resource, enabling audit traceability and supporting cascade deactivation management across the provider directory hierarchy.

Context of Use

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:

  Suppressed DeactivatedBy
Purpose Hides the resource from directory display while keeping it active in the system Records who changed the active/status element to a non-active state
Applied to The resource root The active or status element directly
Resource remains active? Yes — suppression is a visibility flag only No — the resource is genuinely inactive

Cascade hierarchy

The deactivation cascade follows the same organisational hierarchy as suppression:

Resource Type organisation-initiated practitioner-initiated
Organization ✓ ✗
HealthcareService ✓ ✗
Location ✓ ✗
Endpoint ✓ ✗
PractitionerRole ✓ ✓
Practitioner ✗ ✓

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) Who initiated deactivation
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:deactivatedBy S 1..1 Extension Who initiated the deactivation
..... extension 0..0 Extension
..... url 1..1 uri "deactivatedBy"
..... value[x] S 1..1 CodeableConcept Value of extension
...... coding 1..2 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)
... url 1..1 uri "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"

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

doco 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).

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) Who initiated deactivation
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:deactivatedBy S 1..1 Extension Who initiated the deactivation
..... extension 0..0 Extension
..... url 1..1 uri "deactivatedBy"
..... value[x] S 1..1 CodeableConcept Value of extension
...... coding 1..2 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)
... url 1..1 uri "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) Who initiated deactivation
Constraints: ext-1
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:deactivatedBy S 1..1 Extension Who initiated the deactivation
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "deactivatedBy"
..... value[x] S 1..1 CodeableConcept Value of extension
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... coding Σ 1..2 Coding Code defined by a terminology system
Binding: ResponsiblePartyType_VS (26.0.0) (required)
...... text Σ 0..1 string Plain text representation of the concept
... url 1..1 uri "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"

doco 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).

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:deactivatedBy.​value[x].coding Base required Responsible Party Type 📍26.0.0 This IG

Constraints

Id Grade Path(s) Description Expression