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: EDI Address

Official URL: http://hl7.org.nz/fhir/StructureDefinition/edi-address | Version: 0.1.0
Active as of 2020-07-20 | Computable Name: Edi_address
Copyright/Legal: HL7 New Zealand© 2020+; Licensed Under Creative Commons No Rights Reserved.

Represents an Electronic Data Interchange (EDI) address. It is intended as an extension on ContactPoint.system, with the system value being 'other'. The value of the extension is the EDI supplier, the actual EDI address is the value element. Note that a new extension 'messaging address' is preferred.

Context of Use

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

- Element ID: `ContactPoint.system`

This extension has been deprecated, and the Messaging Address extension should be used instead. The status will be changed to 'retired' in the next version of this guide.

This extension allows an EDI address to be added to the ContactPoint.system element.

As the FHIR specification has a required binding for this element, it is necessary to provide a value from the defined set (eg 'other') then place the extension on that value.

The actual value of the edi address is the .value element.

In the example below, the extension (on telecom.system) indicates that this is an EDI address supplied by HealthLink. The actual value of the EDI address (on telecom.value) is 001a

Example of extension

      <telecom>
        <system value="other">
          <extension url="http://hl7.org.nz/fhir/StructureDefinition/edi-address">
            <valueString value="healthlink"/>
          </extension>
        </system>
        <value value="001a"/>
      </telecom>

Example instances

Patient with EDI Address

Usage info

Usages:

- Examples for this Extension: Health R Us and Practitioner/practitioner-edi-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 | EDI Address
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/edi-address"
value[x] |  | 0..1 | string | Value of extension
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | EDI Address
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://hl7.org.nz/fhir/StructureDefinition/edi-address"
value[x] |  | 0..1 | string | Value of extension
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type string: Represents an Electronic Data Interchange (EDI) address. It is intended as an extension on ContactPoint.system, with the system value being 'other'. The value of the extension is the EDI supplier, the actual EDI address is the value element. Note that a new extension 'messaging address' is preferred.

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | EDI Address
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/edi-address"
value[x] |  | 0..1 | string | Value of extension
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | EDI Address
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://hl7.org.nz/fhir/StructureDefinition/edi-address"
value[x] |  | 0..1 | string | Value of extension
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type string: Represents an Electronic Data Interchange (EDI) address. It is intended as an extension on ContactPoint.system, with the system value being 'other'. The value of the extension is the EDI supplier, the actual EDI address is the value element. Note that a new extension 'messaging address' is preferred.

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