FHIR IG analytics
| Package | au.digitalhealth.r4.healthconnect |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-hc-preferred-name.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/AuDigitalHealth/HealthConnect/StructureDefinition-hc-preferred-name.html |
| URL | http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-name |
| Version | 0.2.0-preview |
| Status | draft |
| Date | 2026-01-29T05:23:49+00:00 |
| Name | HcPreferredName |
| Title | HC Preferred Name |
| Realm | au |
| Authority | national |
| Description | 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. |
| Copyright | 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/. |
| Type | Extension |
| Kind | complex-type |
Resources that use this resource
Resources that this resource uses
No resources found
Examples of Use for Extension
Narrative
Note: links and images are rebased to the (stated) source
Source1
{
"resourceType": "StructureDefinition",
"id": "hc-preferred-name",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://ns.electronichealth.net.au/hc/ImplementationGuide/au.digitalhealth.r4.healthconnect"
}
]
}
}
],
"url": "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-name",
"version": "0.2.0-preview",
"name": "HcPreferredName",
"title": "HC Preferred Name",
"status": "draft",
"experimental": false,
"date": "2026-01-29T05:23:49+00:00",
"publisher": "Australian Digital Health Agency",
"contact": [
{
"name": "Australian Digital Health Agency",
"telecom": [
{
"system": "url",
"value": "https://www.digitalhealth.gov.au/"
},
{
"system": "email",
"value": "help@digitalhealth.gov.au"
}
]
},
{
"name": "Australian Digital Health Agency",
"telecom": [
{
"system": "email",
"value": "mailto:help@digitalhealth.gov.au",
"use": "work"
}
]
}
],
"description": "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.",
"useContext": [
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "jurisdiction"
},
"valueCodeableConcept": {
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "AU",
"display": "Australia"
}
]
}
}
],
"copyright": "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/.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "PractitionerRole"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Preferred name for practitioner in role context",
"definition": "A name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service. This may differ from their registered legal name.",
"min": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}
],
"isModifier": false
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Extension.url",
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-name",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Preferred name",
"definition": "The preferred name by which the practitioner wishes to be known in this role context.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "HumanName"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x].id",
"path": "Extension.value[x].id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.value[x].extension",
"path": "Extension.value[x].extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.value[x].use",
"path": "Extension.value[x].use",
"short": "Preferred name use",
"definition": "The use of this preferred name (usual, temp, etc.)",
"comment": "Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
"requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"mustSupport": true,
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NameUse"
}
],
"strength": "required",
"description": "The use of a human name.",
"valueSet": "http://hl7.org/fhir/ValueSet/name-use|4.0.1"
},
"mapping": [
{
"identity": "v2",
"map": "XPN.7, but often indicated by which field contains the name"
},
{
"identity": "rim",
"map": "unique(./use)"
},
{
"identity": "servd",
"map": "./NamePurpose"
}
]
},
{
"id": "Extension.value[x].text",
"path": "Extension.value[x].text",
"short": "Text representation of the full name",
"definition": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.",
"comment": "Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.",
"requirements": "A renderable, unencoded form.",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "implied by XPN.11"
},
{
"identity": "rim",
"map": "./formatted"
}
]
},
{
"id": "Extension.value[x].family",
"path": "Extension.value[x].family",
"short": "Preferred family name",
"definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.",
"comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).",
"alias": [
"surname"
],
"min": 0,
"max": "1",
"base": {
"path": "HumanName.family",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN.1/FN.1"
},
{
"identity": "rim",
"map": "./part[partType = FAM]"
},
{
"identity": "servd",
"map": "./FamilyName"
}
]
},
{
"id": "Extension.value[x].given",
"path": "Extension.value[x].given",
"short": "Preferred given name(s)",
"definition": "Given name.",
"comment": "If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called \"first name\" since given names do not always come first.",
"alias": [
"first name",
"middle name"
],
"min": 0,
"max": "*",
"base": {
"path": "HumanName.given",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"orderMeaning": "Given Names appear in the correct order for presenting the name",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN.2 + XPN.3"
},
{
"identity": "rim",
"map": "./part[partType = GIV]"
},
{
"identity": "servd",
"map": "./GivenNames"
}
]
},
{
"id": "Extension.value[x].prefix",
"path": "Extension.value[x].prefix",
"short": "Preferred name prefix (title)",
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.",
"min": 0,
"max": "*",
"base": {
"path": "HumanName.prefix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"orderMeaning": "Prefixes appear in the correct order for presenting the name",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN.5"
},
{
"identity": "rim",
"map": "./part[partType = PFX]"
},
{
"identity": "servd",
"map": "./TitleCode"
}
]
},
{
"id": "Extension.value[x].suffix",
"path": "Extension.value[x].suffix",
"short": "Parts that come after the name",
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.",
"min": 0,
"max": "*",
"base": {
"path": "HumanName.suffix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"orderMeaning": "Suffixes appear in the correct order for presenting the name",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN/4"
},
{
"identity": "rim",
"map": "./part[partType = SFX]"
}
]
},
{
"id": "Extension.value[x].period",
"path": "Extension.value[x].period",
"short": "Time period when name was/is in use",
"definition": "Indicates the period of time when this name was valid for the named person.",
"requirements": "Allows names to be placed in historical context.",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN.13 + XPN.14"
},
{
"identity": "rim",
"map": "./usablePeriod[type=\"IVL<TS>\"]"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Preferred name for practitioner in role context",
"definition": "A name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service. This may differ from their registered legal name."
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://ns.electronichealth.net.au/hc/StructureDefinition/hc-preferred-name"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Preferred name",
"definition": "The preferred name by which the practitioner wishes to be known in this role context.",
"min": 1,
"type": [
{
"code": "HumanName"
}
]
},
{
"id": "Extension.value[x].use",
"path": "Extension.value[x].use",
"short": "Preferred name use",
"definition": "The use of this preferred name (usual, temp, etc.)",
"mustSupport": true
},
{
"id": "Extension.value[x].family",
"path": "Extension.value[x].family",
"short": "Preferred family name",
"mustSupport": true
},
{
"id": "Extension.value[x].given",
"path": "Extension.value[x].given",
"short": "Preferred given name(s)",
"mustSupport": true
},
{
"id": "Extension.value[x].prefix",
"path": "Extension.value[x].prefix",
"short": "Preferred name prefix (title)",
"mustSupport": true
}
]
}
}
Extension 
extension 
value[x] 
FHIR
FHIRsmith