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.1.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 Preferred Name

Official URL: http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-name Version: 0.1.0-preview
Standards status: Draft Computable Name: HcPreferredName

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/.

This extension applies to PractitionerRole, and represents a name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service.

Context of Use

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

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 Preferred name for practitioner in role context
... extension 0..0 Extension
... url 1..1 uri "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-name"
... value[x] 1..1 HumanName Preferred name
.... use S 0..1 code Preferred name use
.... family S 0..1 string Preferred family name
.... given S 0..* string Preferred given name(s)
.... prefix S 0..* string Preferred name prefix (title)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Preferred name for practitioner in role context
... id 0..1 string Unique id for inter-element referencing
... extension 0..0 Extension
Slice: Unordered, Open by value:url
... url 1..1 uri "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-name"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ 0..1 code Preferred name use
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family SΣ 0..1 string Preferred family name
.... given SΣ 0..* string Preferred given name(s)
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ 0..* string Preferred name prefix (title)
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type HumanName: This extension applies to PractitionerRole, and represents a name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Preferred name for practitioner in role context
... extension 0..0 Extension
... url 1..1 uri "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-name"
... value[x] 1..1 HumanName Preferred name
.... use S 0..1 code Preferred name use
.... family S 0..1 string Preferred family name
.... given S 0..* string Preferred given name(s)
.... prefix S 0..* string Preferred name prefix (title)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Preferred name for practitioner in role context
... id 0..1 string Unique id for inter-element referencing
... extension 0..0 Extension
Slice: Unordered, Open by value:url
... url 1..1 uri "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-name"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ 0..1 code Preferred name use
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family SΣ 0..1 string Preferred family name
.... given SΣ 0..* string Preferred given name(s)
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ 0..* string Preferred name prefix (title)
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type HumanName: This extension applies to PractitionerRole, and represents a name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service.

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.value[x].use Base required NameUse 📍4.0.1 FHIR Std.

Constraints

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