search

AuDigitalHealth / ci-medicare-records

Working drafts of HL7™ FHIR® artefacts authored and maintained by the Informatics Architecture team at the Australian Digital Health Agency that represent atomic Medicare records in the My Health Record system and related applications.
Other
1 stars 1 forks source link

Immunization Australian Immunisation Register - consider including major version number in the URL to manage breaking changes #9

Closed dbojicic-agency closed 2 years ago

dbojicic-agency commented 3 years ago

Prerequisites

The issue / feature

Change description

The Australian Immunisation Register Immunisation (StructureDefinition-immunization-air) profile has been updated in v2.1.0 of the implementation guide, including removing some of the unused version 1 and adding new functionality; subsequently the profile major version number increased. The profile URL has not changed between the versions.

It is recommended (though not required) to include major version number in the canonical URL for a profile so that it can be referenced by its major version. Managing version dependencies can also be done by other methods (e.g. managing a set of resources with specific versioned references via an Implementation Guide).

How would NIO & Services Australia like to manage breaking changes in the future?

What it actually enables people to do

Allow a reference to a particular business version of the structure definition.

How awesome would it be?

Workarounds

N/A

Additional context

N/A

dtr-agency commented 2 years ago

The content in this space is managed under different conventions. All profiles should be managed the same - only one profile for Flag has a version number in the URL which was introduced in the latest set. This should be reverted so that the content managed under this IG is all managed in the same way.