New Zealand HPI Implementation Guide
1.5.0 - Release

New Zealand HPI Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 1.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions

Resource Profile: HPI Organization

Official URL: http://hl7.org.nz/fhir/StructureDefinition/HPIOrganization Version: 1.5.0
Active as of 2024-12-17 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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from NzOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization NzOrganization
... Slices for extension Content/Rules for all slices
.... extension:established 0..1 Established The period over which this Organization has been established
.... extension:funded-programme 0..0
... Slices for identifier 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by value:use, value:system
.... identifier:All Slices Content/Rules for all slices
..... use 0..1 code official | old
Binding: IdentifierUse (required)
.... identifier:orgId S 1..1 Identifier The current HPI organization Id for this Organization
..... use 1..1 code fixed to official
Fixed Value: official
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id
..... period 0..0
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:legacyOrgId 0..1 Identifier The MOH (NZHIS) Legacy agency code)
..... use 1..1 code fixed to official
Fixed Value: official
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id
..... period 0..0
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:nzbn S 0..1 Identifier The New Zealand Business Number
..... use 1..1 code fixed to official
Fixed Value: official
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-nzbn
..... period 0..0
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:dormant S 0..* Identifier Identifiers which have been deprecated
..... use 1..1 code fixed to old
Fixed Value: old
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id
..... period 0..0
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
... type 0..* CodeableConcept Kind of organization
Binding: Organisation Type (required)
.... Slices for extension Content/Rules for all slices
..... extension:alias-type 0..1 AliasType The type of alias for this Organization - eg its Maori name
...... Slices for value[x] Content/Rules for all slices
....... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: HPI Alias Type (Organization) (preferred)
... telecom
.... use 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
... address 0..0
... partOf 0..1 Reference(HPI Organization) The organization of which this organization forms a part
... contact 0..0
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.identifier.userequiredHpi_IdentfierUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Organization.typerequiredHpi_organisation_type
https://nzhts.digital.health.nz/fhir/ValueSet/organisation-type-code
Organization.alias.extension:alias-type.value[x]:valueCodeableConceptpreferredHpi_organization_alias_type
https://nzhts.digital.health.nz/fhir/ValueSet/organization-alias-type-code
Organization.telecom.userequiredHpi_ContactPointUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... 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
.... 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): Identifies the purpose for this identifier, if known .


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): Identifies the purpose for this identifier, if known .


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): Identifies the purpose for this identifier, if known .


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): Identifies the purpose for this identifier, if known .


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.identifier.userequiredHpi_IdentfierUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Organization.identifier:orgId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:legacyOrgId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:nzbn.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:dormant.userequiredFixed Value: old
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.typerequiredHpi_organisation_type
https://nzhts.digital.health.nz/fhir/ValueSet/organisation-type-code
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* NzOrganization A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... established 0..1 Period The period over which this Organization has been established
URL: http://hl7.org.nz/fhir/StructureDefinition/established
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier ΣC 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by value:use, value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code official | old
Binding: IdentifierUse (required)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:orgId SΣC 1..1 Identifier The current HPI organization Id for this Organization
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:legacyOrgId ΣC 0..1 Identifier The MOH (NZHIS) Legacy agency code)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:nzbn SΣC 0..1 Identifier The New Zealand Business Number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-nzbn
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:dormant SΣC 0..* Identifier Identifiers which have been deprecated
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: old
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
... type Σ 0..* CodeableConcept Kind of organization
Binding: Organisation Type (required)
... name ΣC 0..1 string Name used for the organization
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... alias-type 0..1 (Complex) The type of alias for this Organization - eg its Maori name
URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/alias-type"
...... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: HPI Alias Type (Organization) (preferred)
.... value 0..1 string Primitive value for string
Max Length:1048576
... telecom C 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... partOf Σ 0..1 Reference(HPI Organization) The organization of which this organization forms a part

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier.userequiredHpi_IdentfierUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.identifier:orgId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:legacyOrgId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:nzbn.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:dormant.userequiredFixed Value: old
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.typerequiredHpi_organisation_type
https://nzhts.digital.health.nz/fhir/ValueSet/organisation-type-code
Organization.alias.extension:alias-type.value[x]:valueCodeableConceptpreferredHpi_organization_alias_type
https://nzhts.digital.health.nz/fhir/ValueSet/organization-alias-type-code
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredHpi_ContactPointUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

This structure is derived from NzOrganization

Summary

Mandatory: 4 elements(6 nested mandatory elements)
Must-Support: 3 elements
Fixed: 8 elements
Prohibited: 12 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Organization.identifier

Differential View

This structure is derived from NzOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization NzOrganization
... Slices for extension Content/Rules for all slices
.... extension:established 0..1 Established The period over which this Organization has been established
.... extension:funded-programme 0..0
... Slices for identifier 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by value:use, value:system
.... identifier:All Slices Content/Rules for all slices
..... use 0..1 code official | old
Binding: IdentifierUse (required)
.... identifier:orgId S 1..1 Identifier The current HPI organization Id for this Organization
..... use 1..1 code fixed to official
Fixed Value: official
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id
..... period 0..0
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:legacyOrgId 0..1 Identifier The MOH (NZHIS) Legacy agency code)
..... use 1..1 code fixed to official
Fixed Value: official
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id
..... period 0..0
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:nzbn S 0..1 Identifier The New Zealand Business Number
..... use 1..1 code fixed to official
Fixed Value: official
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-nzbn
..... period 0..0
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:dormant S 0..* Identifier Identifiers which have been deprecated
..... use 1..1 code fixed to old
Fixed Value: old
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id
..... period 0..0
..... assigner 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
... type 0..* CodeableConcept Kind of organization
Binding: Organisation Type (required)
.... Slices for extension Content/Rules for all slices
..... extension:alias-type 0..1 AliasType The type of alias for this Organization - eg its Maori name
...... Slices for value[x] Content/Rules for all slices
....... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: HPI Alias Type (Organization) (preferred)
... telecom
.... use 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
... address 0..0
... partOf 0..1 Reference(HPI Organization) The organization of which this organization forms a part
... contact 0..0
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.identifier.userequiredHpi_IdentfierUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Organization.typerequiredHpi_organisation_type
https://nzhts.digital.health.nz/fhir/ValueSet/organisation-type-code
Organization.alias.extension:alias-type.value[x]:valueCodeableConceptpreferredHpi_organization_alias_type
https://nzhts.digital.health.nz/fhir/ValueSet/organization-alias-type-code
Organization.telecom.userequiredHpi_ContactPointUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... 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
.... 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): Identifies the purpose for this identifier, if known .


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): Identifies the purpose for this identifier, if known .


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): Identifies the purpose for this identifier, if known .


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): Identifies the purpose for this identifier, if known .


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.identifier.userequiredHpi_IdentfierUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Organization.identifier:orgId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:legacyOrgId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:nzbn.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:dormant.userequiredFixed Value: old
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.typerequiredHpi_organisation_type
https://nzhts.digital.health.nz/fhir/ValueSet/organisation-type-code

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* NzOrganization A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... established 0..1 Period The period over which this Organization has been established
URL: http://hl7.org.nz/fhir/StructureDefinition/established
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier ΣC 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by value:use, value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code official | old
Binding: IdentifierUse (required)
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:orgId SΣC 1..1 Identifier The current HPI organization Id for this Organization
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:legacyOrgId ΣC 0..1 Identifier The MOH (NZHIS) Legacy agency code)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:nzbn SΣC 0..1 Identifier The New Zealand Business Number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to official
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-nzbn
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
.... identifier:dormant SΣC 0..* Identifier Identifiers which have been deprecated
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code fixed to old
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: old
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... assigner Σ 0..1 Reference(HPI Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
... type Σ 0..* CodeableConcept Kind of organization
Binding: Organisation Type (required)
... name ΣC 0..1 string Name used for the organization
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... alias-type 0..1 (Complex) The type of alias for this Organization - eg its Maori name
URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/alias-type"
...... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: HPI Alias Type (Organization) (preferred)
.... value 0..1 string Primitive value for string
Max Length:1048576
... telecom C 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: Use values for a ContactPoint (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... partOf Σ 0..1 Reference(HPI Organization) The organization of which this organization forms a part

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier.userequiredHpi_IdentfierUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.identifier:orgId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:legacyOrgId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:nzbn.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:dormant.userequiredFixed Value: old
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.typerequiredHpi_organisation_type
https://nzhts.digital.health.nz/fhir/ValueSet/organisation-type-code
Organization.alias.extension:alias-type.value[x]:valueCodeableConceptpreferredHpi_organization_alias_type
https://nzhts.digital.health.nz/fhir/ValueSet/organization-alias-type-code
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredHpi_ContactPointUse
https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

This structure is derived from NzOrganization

Summary

Mandatory: 4 elements(6 nested mandatory elements)
Must-Support: 3 elements
Fixed: 8 elements
Prohibited: 12 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Organization.identifier

 

Other representations of profile: CSV, Excel, Schematron