Skip to content
dtr-agency edited this page Jun 30, 2021 · 32 revisions

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

  1. 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/
  2. An 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.

Conventions for extending a core (or external) terminology in Australia

Example core code system: ActCode http://terminology.hl7.org/CodeSystem/v3-ActCode

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