Northern Region Implementation Guide
0.2.0 - CI Build

Northern Region Implementation Guide, published by healthAlliance. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of and changes regularly. See the Directory of published versions


This page has links to external sites used during development and are present to assist the temam members and reviewers. The page will be removed once the IG has been completed.


The following process is being used (roughly) to develop this guide.

  1. Technical use cases are identified to describe the nature of client API access requirements.
  2. Existing descriptions (schema, bespoke API) are used to help inform the content of the API. These are expressed as resource Profiles, and describe how the base resource types are adapted to the specific healthAlliance requirements. The use cases also inform this process.
  3. From these requirements, Logical Models are developed using the clinFHIR tooling. These are an intermediary information model that display the data requirements in an easy to visualize format which is useful for review.
  4. The information in the Logical Models are then converted into FHIR artifacts using the FHIR shorthand language (FSH), and the sushi tooling that implements FSH. These artifacts are listed in the artifacts tab of this guide, and contain the detailed information about the profiles needed by implementers.
  5. Other FHIR artifacts like the API descripions, examples and security are created and documented.

Business Use Cases

These are business focussed Use Cases that are being used to drive the API design (the technical usecases are derived from these.) Note that these documents may not be publically available.

Add links to the business use cases. Might want to keep these long term…

Lab use cases


The following models are currently being developed in the clinFHIR logical modeller. Clicking the link will open the model in read-only mode.

Model / Resource type Purpose
Patient Represents the patient. Generally there will be a single Patient resource for each patient
Practitioner Represents a person delivering healthcare (regardless of qualification).
Organization A group responsible for delivering care. The DHB or GP Ptactices are examples of this.