AU Base Implementation Guide
4.2.2-ballot - Ballot Australia flag

This page is part of the Australian Base IG (v4.2.2-ballot: AU Base R4.2 Ballot 5) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, see the Directory of published versions

Extension: Identifier Routability

Official URL: http://hl7.org.au/fhir/StructureDefinition/identifier-routability Version: 4.2.2-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: IdentifierRoutability

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This extension applies to the Identifier data type. Identifier routability preferences for an asserter.

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

  • Element ID Identifier

Usage Notes

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

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 C 0..1 Extension Identifier routability
inv-idrout-0: preference is required when flag is true
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:routability-flag 1..1 Extension Indicates asserter can route associated identifier
..... url 1..1 uri "routability-flag"
..... value[x] C 1..1 boolean Value of extension
.... extension:routability-preference 0..1 Extension Indicates the asserter's preference for selection of this identifier for routing
..... url 1..1 uri "routability-preference"
..... value[x] C 1..1 unsignedInt Value of extension
.... extension:routability-asserter 1..* Extension Identifies asserter
..... url 1..1 uri "routability-asserter"
..... value[x] 1..1 uri Value of extension
... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/identifier-routability"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..1 Extension Identifier routability
inv-idrout-0: preference is required when flag is true
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:routability-flag 1..1 Extension Indicates asserter can route associated 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 "routability-flag"
..... value[x] C 1..1 boolean Value of extension
.... extension:routability-preference 0..1 Extension Indicates the asserter's preference for selection of this identifier for routing
..... 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 "routability-preference"
..... value[x] C 1..1 unsignedInt Value of extension
.... extension:routability-asserter 1..* Extension Identifies asserter
..... 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 "routability-asserter"
..... value[x] 1..1 uri Value of extension
... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/identifier-routability"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension applies to the Identifier data type. Identifier routability preferences for an asserter.

  • routability-flag: boolean: An Extension
  • routability-preference: unsignedInt: Lower value is higher preference. 0 is highest priority.
  • routability-asserter: uri: An Extension

Maturity: 2

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..1 Extension Identifier routability
inv-idrout-0: preference is required when flag is true
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:routability-flag 1..1 Extension Indicates asserter can route associated identifier
..... url 1..1 uri "routability-flag"
..... value[x] C 1..1 boolean Value of extension
.... extension:routability-preference 0..1 Extension Indicates the asserter's preference for selection of this identifier for routing
..... url 1..1 uri "routability-preference"
..... value[x] C 1..1 unsignedInt Value of extension
.... extension:routability-asserter 1..* Extension Identifies asserter
..... url 1..1 uri "routability-asserter"
..... value[x] 1..1 uri Value of extension
... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/identifier-routability"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..1 Extension Identifier routability
inv-idrout-0: preference is required when flag is true
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:routability-flag 1..1 Extension Indicates asserter can route associated 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 "routability-flag"
..... value[x] C 1..1 boolean Value of extension
.... extension:routability-preference 0..1 Extension Indicates the asserter's preference for selection of this identifier for routing
..... 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 "routability-preference"
..... value[x] C 1..1 unsignedInt Value of extension
.... extension:routability-asserter 1..* Extension Identifies asserter
..... 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 "routability-asserter"
..... value[x] 1..1 uri Value of extension
... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/identifier-routability"

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()
inv-idrout-0errorExtensionpreference is required when flag is true
: extension.where(url='routability-flag').value.single()=true implies extension.where(url='routability-preference').exists()