HL7 AU Conventions: profile invariants and slices

Invariants conventions

The following conventions apply to all invariants within HL7 AU profiles (of resources and datatypes).

element	include	convention
element.constraint.key	yes	1) For invariants not on slices: 'inv-'<abbreviated resource name>'-'<integer, starting from 0> (There are no conventions on how to form abbreviations.) e.g. Invariants defined in AU Base BodySite profile: inv-bodsit-0, inv-bodsit-1 2) For invariants on slices: 'inv-'<abbreviation of slice name>'-'<integer, starting from 0> (There are no conventions on how to form abbreviations.) e.g. inv-csp-0, inv-npio-0, inv-hpio-0
element.constraint.severity	yes	Use 'error' (unless 'warning' is specifically required)
element.constraint.human	yes	Conformance verbs are 'shall' and 'shall not'
element.constraint.expression	yes	Use relative paths

Obsolete patterns

• 'inv-'<abbreviation of slice name>'-value-'<integer, starting from 0> e.g. inv-ihi-value-0, inv-hpio-value-0 - replace with inv-ihi-0, inv-hpio-0
• 'inv-'<abbreviation of slice name>'-length' e.g. inv-asic-abn-length - replace with inv-asic-abn-0
• 'inv-'<abbreviation of slice name>'-'<use case> e.g. inv-dva-number-gold, inv-amt-tpuu - replace with inv-dva-number-0, inv-amt-0
• 'inv-'<something random> e.g. inv-ahpra-value-id-0, inv-ahpra-qual-value-0

Slice conventions

element	include	convention
sliceName	yes	Short name in lower camel case; * for slices of identifier the name SHOULD use an abbreviated common name of the type of identifier, e.g. abn, ihiNumber, nataAccreditation * for slices of coding or CodeableConcept the name SHOULD use an abbreviated common name of the set of values set, e.g. pbs, amt or airVaccineCode * when the set of values all come from SNOMED CT "snomed" SHOULD be prepended to the normal slice name, e.g. snomedFinding or snomedRoute * for a use case slice the name SHOULD be an abbreviated description for the acronym
element.constraint.severity	yes	Use 'error' (unless 'warning' is specifically required)
short	yes	A title of the slice in title case. Examples include: National Individual Healthcare Identifier (IHI), Commonwealth Seniors Health Card Number, PBS Item Code, SNOMED CT Additional Instruction and Route of Administration (SNOMED CT), Air Vaccine