# Common Components FHIR Implementation Guide

26.0.0 - Trial

Common Components 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/common-components/ and changes regularly. See the Directory of published versions

## Extension: Suppression Indicator for Visibility

Official URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed | Version: 26.0.0
Active as of 2026-07-14 | Computable Name: Suppressed
Copyright/Legal: This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/

Indicates whether the parent resource should be hidden from display in the Provider Directory. Contains coded information about the actor who initiated the suppression and optional control flags.

This extension addresses the business requirement to control visibility of provider directory entries, enabling management of which practitioner roles, organizations, healthcare services, locations, or endpoints should be hidden from public directory searches while maintaining data in the system.

Context of Use

This extension may be used on the following element(s)

- Element ID: `PractitionerRole`
- Element ID: `Organization`
- Element ID: `Practitioner`
- Element ID: `HealthcareService`
- Element ID: `Location`
- Element ID: `Endpoint`

Usage info

Usages:

- Examples for this Extension: Suppressed Org and PractitionerRole/practitionerrole-suppressed-example

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.

- 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) | Hide Resource in Directory
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy | S | 1..1 | Extension | Who initiated the suppression
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "suppressedBy"
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)
extension:includeSelf | S | 0..1 | Extension | Controls Organization self-suppression
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "includeSelf"
value[x] | S | 0..1 | boolean | Value of extension
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
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) | Hide Resource in Directory 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:suppressedBy | S | 1..1 | Extension | Who initiated the suppression 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 | "suppressedBy"
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
extension:includeSelf | S | 0..1 | Extension | Controls Organization self-suppression 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 | "includeSelf"
value[x] | S | 0..1 | boolean | Value of extension
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Indicates whether the parent resource should be hidden from display in the Provider Directory. Contains coded information about the actor who initiated the suppression and optional control flags.

- suppressedBy: CodeableConcept: Identifies the actor who initiated the suppression request (e.g., practitioner, organisation).
- includeSelf: boolean: When true, this Organization and all child resources (HealthcareService, Location, PractitionerRole, Endpoint) are suppressed via cascade. When false, this Organization remains visible while child resources are suppressed via cascade. Only applies to Organization resources.

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) | Hide Resource in Directory
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy | S | 1..1 | Extension | Who initiated the suppression
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "suppressedBy"
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)
extension:includeSelf | S | 0..1 | Extension | Controls Organization self-suppression
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "includeSelf"
value[x] | S | 0..1 | boolean | Value of extension
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
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) | Hide Resource in Directory 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:suppressedBy | S | 1..1 | Extension | Who initiated the suppression 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 | "suppressedBy"
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
extension:includeSelf | S | 0..1 | Extension | Controls Organization self-suppression 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 | "includeSelf"
value[x] | S | 0..1 | boolean | Value of extension
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Indicates whether the parent resource should be hidden from display in the Provider Directory. Contains coded information about the actor who initiated the suppression and optional control flags.

- suppressedBy: CodeableConcept: Identifies the actor who initiated the suppression request (e.g., practitioner, organisation).
- includeSelf: boolean: When true, this Organization and all child resources (HealthcareService, Location, PractitionerRole, Endpoint) are suppressed via cascade. When false, this Organization remains visible while child resources are suppressed via cascade. Only applies to Organization resources.

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

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

#### Constraints

Id | Grade | Path(s) | Description | Expression
ele-1 | error | Extension, Extension.extension, Extension.extension:suppressedBy, Extension.extension:suppressedBy.value[x], Extension.extension:suppressedBy.value[x].extension, Extension.extension:suppressedBy.value[x].coding, Extension.extension:suppressedBy.value[x].text, Extension.extension:includeSelf, Extension.extension:includeSelf.value[x] | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | Extension, Extension.extension, Extension.extension:suppressedBy, Extension.extension:suppressedBy.value[x].extension, Extension.extension:includeSelf | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`