AU Base Implementation Guide
4.1.2-preview - Preview Australia flag

This page is part of the Australian Base IG (v4.1.2-preview: AU Base) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Extension: HL7 V2 Receiving Application

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication Version: 4.1.2-preview
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.

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

  • Element ID Endpoint

Usage Notes

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionHL7 V2 receiving application
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:namespace-id 0..1ExtensionApplication Identifier
.... url 1..1uri"namespace-id"
.... value[x] 0..1stringValue of extension
... extension:universal-id 0..1ExtensionUniversal Identifier Value
.... url 1..1uri"universal-id"
.... value[x] 0..1stringValue of extension
.... url 1..1uri"universal-id-type"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionHL7 V2 receiving application
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:namespace-id 0..1ExtensionApplication Identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"namespace-id"
.... value[x] 0..1stringValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"universal-id"
.... value[x] 0..1stringValue of extension
... extension:universal-id-type 0..1ExtensionType scheme of universal-id
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"universal-id-type"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"

doco 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionHL7 V2 receiving application
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:namespace-id 0..1ExtensionApplication Identifier
.... url 1..1uri"namespace-id"
.... value[x] 0..1stringValue of extension
... extension:universal-id 0..1ExtensionUniversal Identifier Value
.... url 1..1uri"universal-id"
.... value[x] 0..1stringValue of extension
.... url 1..1uri"universal-id-type"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionHL7 V2 receiving application
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:namespace-id 0..1ExtensionApplication Identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"namespace-id"
.... value[x] 0..1stringValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"universal-id"
.... value[x] 0..1stringValue of extension
... extension:universal-id-type 0..1ExtensionType scheme of universal-id
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"universal-id-type"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()