HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type | Version: 1.0.0 | |||
| Active as of 2025-09-08 | Computable Name: AliasType | |||
Used to indicate what sort of alias is being used in a Location or Organization - eg that it is a legal name.
Context of Use
This extension may be used on the following element(s)
Location.alias
Organization.alias
Example of extension
<alias value="Best health">
<extension url="http://hl7.org.nz/fhir/StructureDefinition/alias-type">
<valueCodeableConcept>
<coding>
<system value="https://standards.digital.health.nz/ns/alias-type-code"/>
<code value="short"/>
<display value="Local name"/>
</coding>
</valueCodeableConcept>
</extension>
</alias>
Example instances
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Extension | |
  extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/alias-type" | |
  value[x] |
0..1 | CodeableConcept | Value of extension Binding: Alias types (preferred) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Extension | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/alias-type" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: Alias types (preferred) | |
| Documentation for this format | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/alias-type" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: Alias types (preferred) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/alias-type" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: Alias types (preferred) | |
| Documentation for this format | ||||
This structure is derived from Extension
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet | URI |
| Extension.value[x] | preferred | AliasType(a valid code from Type of Alias)https://nzhts.digital.health.nz/fhir/ValueSet/alias-type-codeFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |