AU Base Implementation Guide
6.0.0-ballot - Ballot

AU Base Implementation Guide - Downloaded Version 6.0.0-ballot See the Directory of published versions

## Extension: HL7 V2 Receiving Application

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication | Version: 6.0.0-ballot
Standards status: Trial-use | Maturity Level: 3 | Computable Name: HL7V2ReceivingApplication
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This extension applies to the Endpoint resource and is used to represent routing HL7 V2 message payload details associated with an endpoint. This content allows a sender using these endpoint details to include Receiving Application (MSH-5) information in HL7 V2 messages sent via this channel which allow correct delivery within the receiving system.

Context of Use

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

- Element ID: `Endpoint`

### Usage Notes

Usage info

Usages:

- Examples for this Extension: Telstra Health Secure Messaging Endpoint

You can also check for usages in the FHIR IG Statistics

Changes since version 5.0.0:

- No changes

### 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 | HL7 V2 receiving application
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:namespace-id |  | 0..1 | Extension | Application Identifier
url |  | 1..1 | uri | "namespace-id"
value[x] |  | 0..1 | string | Value of extension
extension:universal-id |  | 0..1 | Extension | Universal Identifier Value
url |  | 1..1 | uri | "universal-id"
value[x] |  | 0..1 | string | Value of extension
extension:universal-id-type |  | 0..1 | Extension | Type scheme of universal-id
url |  | 1..1 | uri | "universal-id-type"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"
value[x] |  | 0..0 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | HL7 V2 receiving application
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:namespace-id |  | 0..1 | Extension | Application Identifier
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "namespace-id"
value[x] |  | 0..1 | string | Value of extension
extension:universal-id |  | 0..1 | Extension | Universal Identifier Value
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "universal-id"
value[x] |  | 0..1 | string | Value of extension
extension:universal-id-type |  | 0..1 | Extension | Type scheme of universal-id
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "universal-id-type"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension applies to the Endpoint resource and is used to represent routing HL7 V2 message payload details associated with an endpoint. This content allows a sender using these endpoint details to include Receiving Application (MSH-5) information in HL7 V2 messages sent via this channel which allow correct delivery within the receiving system.

- namespace-id: string: An Extension
- universal-id: string: Identifier values following the universal-id-type defined scheme.
- universal-id-type: string: Provides scheme to use to interpret the universal-id value .e.g. GUID, ISO etc. see HL7 V2 Table 0301 - Universal ID type.

Maturity: 3

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | HL7 V2 receiving application
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:namespace-id |  | 0..1 | Extension | Application Identifier
url |  | 1..1 | uri | "namespace-id"
value[x] |  | 0..1 | string | Value of extension
extension:universal-id |  | 0..1 | Extension | Universal Identifier Value
url |  | 1..1 | uri | "universal-id"
value[x] |  | 0..1 | string | Value of extension
extension:universal-id-type |  | 0..1 | Extension | Type scheme of universal-id
url |  | 1..1 | uri | "universal-id-type"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"
value[x] |  | 0..0 |  |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | HL7 V2 receiving application
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:namespace-id |  | 0..1 | Extension | Application Identifier
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "namespace-id"
value[x] |  | 0..1 | string | Value of extension
extension:universal-id |  | 0..1 | Extension | Universal Identifier Value
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "universal-id"
value[x] |  | 0..1 | string | Value of extension
extension:universal-id-type |  | 0..1 | Extension | Type scheme of universal-id
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "universal-id-type"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension applies to the Endpoint resource and is used to represent routing HL7 V2 message payload details associated with an endpoint. This content allows a sender using these endpoint details to include Receiving Application (MSH-5) information in HL7 V2 messages sent via this channel which allow correct delivery within the receiving system.

- namespace-id: string: An Extension
- universal-id: string: Identifier values following the universal-id-type defined scheme.
- universal-id-type: string: Provides scheme to use to interpret the universal-id value .e.g. GUID, ISO etc. see HL7 V2 Table 0301 - Universal ID type.

Maturity: 3

Other representations of profile: CSV, Excel, Schematron

#### Constraints

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