hl7au / au-fhir-base

AU Base FHIR Implementation Guide Source
38 stars 27 forks source link

Handling address identifiers in AU Base - extension for each or one identifier extension #478

Closed dtr-agency closed 3 years ago

dtr-agency commented 4 years ago

Recent PA working group discussion resulted in a position to move to supporting a GNAF address identifier as a specific extension of type string on Address. See https://github.com/hl7au/au-fhir-base/issues/464.

Further consideration of address identifier data type needs has noted interest in supporting further identifiers on address.

Want to re-examine this position on address identifiers as the recent decision is not the best fit for those requirements:

dtr-agency commented 4 years ago

Solution options

Solution options considered for handling common address identifiers:

  1. AU Base Address with each identifier as an extension of type string for that identifier type

    <address>
    <extension url="http://hl7.org.au/fhir/StructureDefinition/address-deliverypointidentifier">
      <valueString value="34567890"/>
    </extension>
    <extension url="http://hl7.org.au/fhir/StructureDefinition/address-gnafidentifier">
      <valueString value="GAVIC411711441"/>
    </extension>
    </address>
  2. AU Base Address with a single Address identifier extension of type Identifier, uses data type profiles to define common address identifiers

    <address>
    <extension url="http://hl7.org.au/fhir/StructureDefinition/address-identifier">
      <valueIdentifier>
        <type>
          <coding>
            <system value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
            <code value="DPID"/>
            <display value="Delivery Point Identifier"/>
          </coding>
        </type>
        <system value="http://hl7.org.au/id/dpid"/>
        <value value="34567890"/>
      </valueIdentifier>
    </extension>
    <extension url="http://hl7.org.au/fhir/StructureDefinition/address-identifier">
      <valueIdentifier>
        <type>
          <coding>
            <system value="http://terminology.hl7.org.au/CodeSystem/v2-0203"/>
            <code value="GNAF"/>
            <display value="Geocoded National Address File Identifier"/>
          </coding>
        </type>
        <system value="http://hl7.org.au/id/gnafidentifier"/>
        <value value="GAVIC411711441"/>
      </valueIdentifier>
    </extension>
    <address/>

NOTE1: Mocked up solution options 1. and 2 (see above hyperlinks). NOTE2: GitHub branch

Light analysis of solution options

Solution option Pros Cons
Extension of type string for each identifier type Lightweight solution; avoids needing to process an identifier system and/or code Won't be able to be handled with standard identifier processing; requires new extensions for each identifier (including building in custom processing); less interchangeable between one format and another as an identifier (e.g. OID based systems); has no inherent identifier semantics
A single extension of type Identifier + data type profiles for each identifier type Allows for handling with standard identifier processing; easily extensible with new identifiers; supports sending other identifiers that aren't defined by HL7 AU (identifier semantics); easy to interchange between formats as an identifier; Requires an identifier system;
dtr-agency commented 4 years ago

Associated changes to support address identifier data type profiles (G-NAF & Aus Post Delivery Point Identifier):

See proposed addition of DPID & GNAF to HL7 V2 Table 0203 - Identifier Type (AU Extended). The wording including using term 'location address' is taken primarily from [ANZSLIC] (https://www.anzlic.gov.au/) and the National Address Management Framework, Australia Post material, PSMA material, ABS materials on Statistical Spatial Framework.

NOTE: A code for Address Identifier (i.e. AI) is no longer proposed. Feedback leading to removal of proposal:

Identifiers with type MRN and EI are specific recognised concepts that are shared often between systems and used to reference entities within a known scope (healthcare institution, or employing organisation). A general address identifier type code (e.g. AI) does not define a typical usage or well recognised concept beyond that inferred by the identifier system; would recommend type code be allocated for each address identifier system if needed.

Summary of additions to http://hl7.org.au/id/

URL Type Description
http://hl7.org.au/id/gnafidentifier identifiers namespace A Geocoded National Address File (G-NAF) Identifier assigned to a location address in the G-NAF. The PSMA G-NAF is Australia’s authoritative, geocoded address file.In OID-based systems xxxxx may be used.
http://hl7.org.au/id/dpid identifiers namespace An Australia Post Delivery Point Identifier (DPID) allocated to an address. A DPID enables each delivery point in Australia to be uniquely identified. In OID-based systems xxxxx may be used.
dtr-agency commented 4 years ago

Discussed at recent PA WG (See 2020-09-09 Minutes). Outcomes:

brettesler-ext commented 4 years ago

https://jira.hl7.org/browse/FHIR-28950 raised as a ticket

mcguirek commented 4 years ago

As this has been implmented in https://github.com/hl7au/au-fhir-base/pull/571, suggest this issue be closed.

dtr-agency commented 2 years ago

The implementation of the PR differs in non-trivial normative ways from design proposal - no updated design material can be found in HL7 AU JIRA, GitHub, or confluence.

There is a ballot comment raised on this introduced material where the PR introduced a 0..1 design defect.