AU Base 1.1.1 on FHIR STU3

Australian Base Implementation Guide (AU Base 1.1.1)

This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-receivingapplication

Receiving Application Extension [FMM Level 2]

This extension defines a HL7v2 receiving application value for HL7v2 routing purposes associated with an endpoint. This content allows a sender using these endpoint details to include Receiving Application (MSH-5) information in HL7v2 messages sent via this channel which allow correct delivery within the receiving system.

Endpoint with secure message extensions

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication

Values for routing HLV2 message payloads associated with an endpoint. Suitable for MSH-5.

This profile builds on Extension.

This profile was published on Wed Oct 03 00:00:00 AEST 2018 as a draft by Health Level Seven Australia (Patient Administration WG).

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

Differential Table
Snapshot Table
All

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	HL7 V2 receiving application
extension	0..*	Extension	Slice: Unordered, Open by value:url
extension:namespace-id	0..1	Extension	Application Identifier
url	1..1	uri	"namespace-id"
valueString:valueString	0..1	string
extension:universal-id	0..1	Extension	Universal Identifier Value
url	1..1	uri	"universal-id"
valueString:valueString	0..1	string
extension:universal-id-type	0..1	Extension	Type Scheme of universal-id
url	1..1	uri	"universal-id-type"
valueString:valueString	0..1	string
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
Extension	I	0..*	Extension	HL7 V2 receiving application
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:namespace-id		0..1	Extension	Application Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"namespace-id"
value[x]		0..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		0..1	string	Value of extension
extension:universal-id		0..1	Extension	Universal Identifier Value
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"universal-id"
value[x]		0..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		0..1	string	Value of extension
extension:universal-id-type		0..1	Extension	Type Scheme of universal-id
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"universal-id-type"
value[x]		0..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		0..1	string	Value of extension
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"
Documentation for this format

Differential View

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	HL7 V2 receiving application
extension	0..*	Extension	Slice: Unordered, Open by value:url
extension:namespace-id	0..1	Extension	Application Identifier
url	1..1	uri	"namespace-id"
valueString:valueString	0..1	string
extension:universal-id	0..1	Extension	Universal Identifier Value
url	1..1	uri	"universal-id"
valueString:valueString	0..1	string
extension:universal-id-type	0..1	Extension	Type Scheme of universal-id
url	1..1	uri	"universal-id-type"
valueString:valueString	0..1	string
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
Extension	I	0..*	Extension	HL7 V2 receiving application
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:namespace-id		0..1	Extension	Application Identifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"namespace-id"
value[x]		0..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		0..1	string	Value of extension
extension:universal-id		0..1	Extension	Universal Identifier Value
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"universal-id"
value[x]		0..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		0..1	string	Value of extension
extension:universal-id-type		0..1	Extension	Type Scheme of universal-id
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"universal-id-type"
value[x]		0..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString		0..1	string	Value of extension
url		1..1	uri	"http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"
Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-receivingapplication

none defined