Home

Tips and Tricks

Manual XML: slice by type on non-repeating element need to add cardinality for IG build
Manual XML: Forge sometimes drops cardinality of extensions (0..*) so need to manually add

Terminology resource conventions

All resources to be in namespace http://terminology.hl7.org.au/
1. Code systems in http://terminology.hl7.org.au/CodeSystem/
2. Value sets in http://terminology.hl7.org.au/ValueSet/
A value set defined as basically the implicit code system should share same name, id, title, and only be differentiated by the namespace in the url.
All resources should have a registered OID as the identifier
All resources should declare conformance to the applicable shareable resource profile:
- http://hl7.org/fhir/StructureDefinition/shareablevalueset
- http://hl7.org/fhir/StructureDefinition/shareablecodesystem

Example core value set that is extended: ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode

The AU code system that defines the AU local codes to:

convention for id: au-<external code system id> e.g. au-v3-ActCode
convention for url: <hl7 au namespace>/<external code system id> e.g. http://terminology.hl7.org.au/CodeSystem/v3-ActCode
convention for name: <external code system name>AU e.g. ActCodeAU
convention for title: <external code system title> AU e.g. ActCode AU
convention for description: Extended concept codes for <insert human description> for use in an Australian context. e.g. Extended concept codes for act coding for use in an Australian context.
Local AU concepts to be defined in same convention as code system being extended e.g. all caps or all lowercase or …

The AU value set that extends an external value set by adding AU local codes:

convention for id: au-<external value set id>-extended e.g. au-v3-ActEncounterCode-extended
convention for url: <hl7 au namespace>/<external value set id>-extended e.g. http://terminology.hl7.org.au/ValueSet/v3-ActEncounterCode-extended
convention for name: <external value set name>AUExtended e.g. ActEncounterCodeAUExtended
convention for title: <external value set title> - AU Extended e.g. ActEncounterCode - AU Extended
convention for description: <external value set title> extended for use in an Australian context.
Composed of core value set plus additional codes

Example HL7 AU publication of an external code system: GTIN http://www.gs1.org/gtin Example HL7 AU value set for the HL7 AU publication of an external code system: GTIN for Medicines http://terminology.hl7.org.au/ValueSet/gtin

HL7 AU publication of an external code system to:

convention for id: <something meaningful>-external e.g. gtin-external
convention for url: <code system owner defined url> e.g. http://www.gs1.org/gtin
convention for name: <external code system name> e.g. GTIN
convention for title: <meaningful title> e.g. GTIN
convention for publisher: <owner of the code system> e.g. GS1
convention for contact: <include url for the publisher> e.g. https://www.gs1au.org/
convention for the copyright: Copyright (c) <owner organisation> e.g. Copyright (c) GS1; Copyright (c) MIMS Australia Pty Ltd; Copyright (c) Department of Health, Commonwealth of Australia
convention for description: ```This CodeSystem resource represents the code system published by . . This is not the canonical publication of this code system nor it is intended to be publication on behalf of the Department of Health. For the complete content of the code system contact the publisher.”.
convention for jurisdiction: jurisdiction is not to be included

HL7 AU value set for the HL7 AU publication of an external code system:

convention for id: <something meaningful> e.g. gtin
convention for url: <hl7 au namespace>/<id> e.g. http://terminology.hl7.org.au/ValueSet/gtin
convention for name: <something meaningful> e.g. GTIN
convention for title: <something meaningful> e.g. GTIN
convention for description: ```The value set includes all values from published by . Further details can be found at .