Skip to main content
Version: Draft

Resource profiling

Rules for resource profiling​

Requirements​

  1. FHIR APIs MUST use FHIR resources and elements for their HL7-intended purposes💡

  2. FHIR APIs MUST NOT extend FHIR's primitive data types💡

  3. When a required terminology binding needs expanding, a FHIR API SHOULD define an Extension for this purpose. (APIs MUST NOT use other mechanisms to extend terminology bindings).💡

  4. Identifiers in FHIR APIs MUST be NZ standard identifiers where applicable. An Identifier in FHIR APIs can, via its system attribute, identify the applicable NZ identifier namespace by Uri. List of NZ identifier namespace Uris💡

warning

A FHIR API that uses any of the following tricks will be viewed as violating this standard.

  1. Defines new primitive data types,
  2. Misuses FHIR resource references for linkage other than what HL7 intended,
  3. Evades FHIR design work or payload schema validation by 'shoehorning' or encoding data in places where it cannot be validated nor recognised by API consumers. This means not just schoolboy tricks like encoding data in Annotation or text elements but also more sneaky attempts to hide business data in contained instances or instance metadata,
  4. Introduces resource profiles that cross several base FHIR resources (mongrel).