[FEEDBACK] - Canonical URL naming pattern should include IG name guidance

daniel-thomson commented 3 months ago

Summary

When creating an IG using the HNZ IG builder for hosting at https://fhir-ig.digital.health.nz/, you need to define a name for the IG, that gets included in the canonical URL. I.e. the canonical has the form https://fhir-ig.digital.health.nz/{{IgName}}.

This is also the shortName property that's added as part of the HNZ IG builder setup for a new IG.

Currently, most of the IGs use names that are:

descriptive of the product/business area
lower case
use hyphen separated words

The standard doesn't give any guidance at the moment for the igName, but it would be good to include some so we end up with consistently named IGs

Link to standards item

https://apistandards.digital.health.nz/draft/fhir-api-standard/Standards/CanonicalUrls#requirements-for-fhir-apis

Which area of the standards does this apply to?

[ ] Part A - API Concepts
[ ] Part B - API Security
[ ] Part C - API Design and Development
[X] Part D - FHIR
[ ] Community guidelines

spud023 commented 3 months ago

Hi @daniel-thomson ,

This is the first time I've seen a reference to the HNZ IG Builder. Can you please send me a reference to documentation about it that already exists on the Te Whatu Ora web? Or if not, can you tell me which tool set is being used as standard for FHIR IGs inside Health NZ.

Thanks, Keith

daniel-thomson commented 2 months ago

@spud023 sorry for the slow reply. I don't think the docs are public at the moment. The 'HNZ IG builder' is a tool we created to automate running the HL7 IG publisher, then publish the results at https://fhir-ig.digital.health.nz/{nameOfTheIGHere} - it's a github workflow that clones the repo, runs the publisher, and publishes the output to hosting using our URL. You can see the current list of IGs here: https://fhir-ig.digital.health.nz/

A big benefit is, if you define the canonical URLs to use fhir-ig.digital etc as the base, URLs of all the artefacts in the IG will resolve to the page that describes them.

Cheers Daniel

spud023 commented 2 months ago

Thanks @daniel-thomson ! This is the information I was looking for.

best regards, Keith

tewhatuora / api-standards