AU Base Implementation Guide
5.1.0-preview - Preview Australia flag

This page is part of the Australian Base IG (v5.1.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: HL7 V2 Assigning Authority

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-assigningauthority Version: 5.1.0-preview
Standards status: Trial-use Maturity Level: 3 Computable Name: HL7V2AssigningAuthority

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

This extension applies to the Identifier data type and is used to represent HL7 V2 assigning authority details for HL7 V2 identification for routing.

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

  • Element ID Identifier

This content provides the values for a sender to use where assigning authority components should be valued in fields in HL7 messages.

Example HL7 V2 fields that will use this are:

  • PRD-7 Provider Identifiers (CM)
  • PV1-9 Consulting Doctor (XCN)
  • OBR-28 Result copies to (XCN)

Usage Notes

Usage:

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.

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension HL7 V2 assigning authority
    ... 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-assigningauthority"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension HL7 V2 assigning authority
    ... 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-assigningauthority"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: This extension applies to the Identifier data type and is used to represent HL7 V2 assigning authority details for HL7 V2 identification for routing.

    • 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..* Extension HL7 V2 assigning authority
    ... 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-assigningauthority"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension HL7 V2 assigning authority
    ... 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-assigningauthority"

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