New Zealand HPI Implementation Guide
1.4.10 - Release
New Zealand HPI Implementation Guide
1.4.10 - Release
New Zealand HPI Implementation Guide - Local Development build (v1.4.10) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/HPIOrganization | Version: 1.4.10 | |||
| Active as of 2025-04-06 | Computable Name: HpiOrganization | |||
An entity that provides services of interest to, or is involved in, the business of health care service provision.
Describe the Organization that will be returned by the HPI
The Organisation resource represents any organisation that provides healthcare services.
HPI Organisations each have an identifier in the format GXXNNN-C where X is alphanumeric, N is numeric and C is a check character
Organisations are primarily legal entities e.g. Companies, Charitable trusts etc but can also be Sole traders or informal partnerships.
Organisations can also be parts of a legal entity that ‘trade’ as if they were a separate entity. These ‘sub-organisations’ will be related to their parent.
An example of an organisation with sub organisations would be a Company owning a number of discrete pharmacies . Each of the pharmacies would be set up as a separate organisation (sub-organisation) with each being related to the parent Organisation (organization.partOf)
Wherever possible Organisations are validated by the assignment of the NZBN.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization |
C | 0..* | NzOrganization | A grouping of people or organizations with a common purpose dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
Content/Rules for all slices | |||
   extension:established |
0..1 | Period | The period over which this Organization has been established URL: http://hl7.org.nz/fhir/StructureDefinition/established ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for identifier |
ΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:use, value:system ele-1: All FHIR elements must have a @value or children |
  identifier:All Slices |
Content/Rules for all slices | |||
 use |
?!Σ | 0..1 | code | official | old Binding: IdentifierUse (required) ele-1: All FHIR elements must have a @value or children |
| identifier:orgId |
SΣC | 1..1 | Identifier | The current HPI organization Id for this Organization ele-1: All FHIR elements must have a @value or children |
 use |
?!Σ | 1..1 | code | fixed to official Binding: IdentifierUse (required) ele-1: All FHIR elements must have a @value or children Fixed Value: official |
| system |
Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id |
  assigner |
Σ | 0..1 | Reference(HPI Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| identifier:legacyOrgId |
ΣC | 0..1 | Identifier | The MOH (NZHIS) Legacy agency code) ele-1: All FHIR elements must have a @value or children |
| use |
?!Σ | 1..1 | code | fixed to official Binding: IdentifierUse (required) ele-1: All FHIR elements must have a @value or children Fixed Value: official |
| system |
Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id |
| assigner |
Σ | 0..1 | Reference(HPI Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| identifier:nzbn |
SΣC | 0..1 | Identifier | The New Zealand Business Number ele-1: All FHIR elements must have a @value or children |
| use |
?!Σ | 1..1 | code | fixed to official Binding: IdentifierUse (required) ele-1: All FHIR elements must have a @value or children Fixed Value: official |
| system |
Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/hpi-nzbn |
| assigner |
Σ | 0..1 | Reference(HPI Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
 identifier:dormant |
SΣC | 0..* | Identifier | Identifiers which have been deprecated ele-1: All FHIR elements must have a @value or children |
 use |
?!Σ | 1..1 | code | fixed to old Binding: IdentifierUse (required) ele-1: All FHIR elements must have a @value or children Fixed Value: old |
| system |
Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id |
| assigner |
Σ | 0..1 | Reference(HPI Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use ele-1: All FHIR elements must have a @value or children |
 type |
Σ | 0..* | CodeableConcept | Kind of organization Binding: Organisation Type (required) ele-1: All FHIR elements must have a @value or children |
 partOf |
Σ | 0..1 | Reference(HPI Organization) | The organization of which this organization forms a part ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Organization.identifier.use | required | Hpi_IdentfierUsehttps://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code | |
| Organization.identifier:orgId.use | required | Fixed Value: officialhttps://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code | |
| Organization.identifier:legacyOrgId.use | required | Fixed Value: officialhttps://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code | |
| Organization.identifier:nzbn.use | required | Fixed Value: officialhttps://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code | |
| Organization.identifier:dormant.use | required | Fixed Value: oldhttps://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code | |
| Organization.type | required | Hpi_organisation_typehttps://nzhts.digital.health.nz/fhir/ValueSet/organisation-type-code |
Other representations of profile: CSV, Excel, Schematron
