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

## Extension: Messaging Address

Official URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address | Version: 0.1.0
Active as of 2022-07-20 | Computable Name: Messaging_address

The address to where electronic communications might be sent. For historical reasons, there is an overlap with edi-address.

Context of Use

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

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

Example of extension

     <extension url="http://hl7.org.nz/fhir/StructureDefinition/messaging-address">
        <extension url="provider">
          <valueString value="healthLink"/>
        </extension>
        <extension url="value">
          <valueString value="abc123"/>
        </extension>
      </extension>

Example instances

PractitionerRole with messaging address

Usage info

Usages:

- Use this Extension: HealthcareService resource for use in NZ, Location resource for use in NZ, Organization resource for use in NZ, NZ Patient... Show 2 more, Practitioner resource for use in NZ and PractitionerRole resource for use in NZ
- Examples for this Extension: Patient/patient-messaging-address and PractitionerRole/practitionerRole-messaging-address

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..* | Extension | Messaging Address
extension |  | 2..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:provider |  | 1..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "provider"
value[x] |  | 0..1 | string | Value of extension
extension:value |  | 1..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "value"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/messaging-address"
value[x] |  | 0..0 |  | Value of extension
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Messaging Address
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 2..* | Extension | Extension Slice: Unordered, Open by value:url
extension:provider |  | 1..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "provider"
value[x] |  | 0..1 | string | Value of extension
extension:value |  | 1..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "value"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/messaging-address"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The address to where electronic communications might be sent. For historical reasons, there is an overlap with edi-address.

- provider: string: The messaging provider
- value: string: The identifier supplied by the provider

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Messaging Address
extension |  | 2..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:provider |  | 1..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "provider"
value[x] |  | 0..1 | string | Value of extension
extension:value |  | 1..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "value"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/messaging-address"
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..* | Extension | Messaging Address
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 2..* | Extension | Extension Slice: Unordered, Open by value:url
extension:provider |  | 1..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "provider"
value[x] |  | 0..1 | string | Value of extension
extension:value |  | 1..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "value"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/messaging-address"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The address to where electronic communications might be sent. For historical reasons, there is an overlap with edi-address.

- provider: string: The messaging provider
- value: string: The identifier supplied by the provider

Other representations of profile: CSV, Excel, Schematron

#### 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()`