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 0.3.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HealthConnect/ and changes regularly. See the Directory of published versions

Extension: HC Suppressed

Official URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hc-suppressed Version: 0.3.0-preview
Standards status: Draft Computable Name: HCSuppressed

Usage:Jurisdiction: Australia

Copyright/Legal: Copyright © 2025 Australian Digital Health Agency - All rights reserved. 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. A value of TRUE indicates that the resource should be hidden.

Context of Use

Usage notes

This extension is used to convey whether the parent resource should be hidden from display in the Provider Directory.

Datatype and context

The extension carries a boolean valueBoolean where a value of true denotes the resource SHALL be excluded from Provider Directory listings. This extension is profiled on: Organization, Practitioner and PractitionerRole.

Processing and client obligations

  • The default state of this extension, being optional, is that it is not present on a profile and that resource is visible.
  • If marked as true, the parent resource data will not be returned by subsequent API payload responses; it will no longer be visible but remain stored by the Health Connect Provider Directory system.
  • Client requester actors of the bulk data export service offered by the Health Connect Provider Directory system will receive a list of identifiers contained within a FHIR resource pertaining to Organisations or Practitioners which have elected to suppress their information.
  • Client requester actors SHALL be required to cleanse their local systems of resources related to such identifiers.

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..* Extension(4.0.1) Hide Practitioner Role in Directory
... extension 0..0 Extension
... url 1..1 uri "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hc-suppressed"
... value[x] 0..1 boolean True if the parent resource should be hidden

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension(4.0.1) Hide Practitioner Role in Directory
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 "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hc-suppressed"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type boolean: Indicates whether the parent resource should be hidden from display in the Provider Directory. A value of TRUE indicates that the resource should be hidden.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension(4.0.1) Hide Practitioner Role in Directory
... extension 0..0 Extension
... url 1..1 uri "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hc-suppressed"
... value[x] 0..1 boolean True if the parent resource should be hidden

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension(4.0.1) Hide Practitioner Role in Directory
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 "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hc-suppressed"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type boolean: Indicates whether the parent resource should be hidden from display in the Provider Directory. A value of TRUE indicates that the resource should be hidden.

 

Other representations of profile: CSV, Excel, Schematron

Constraints

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