New Zealand HPI Implementation Guide
1.5.0 - Release

New Zealand HPI Implementation Guide - Local Development build (v1.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: HpiOrganization - Detailed Descriptions

Active as of 2024-09-05

Definitions for the HpiOrganization resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Organization
2. Organization.extension:established
Slice Nameestablished
ShortThe period over which this Organization has been established
4. Organization.extension:funded-programme
Slice Namefunded-programme
Control0..0
6. Organization.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..?
SlicingThis element introduces a set of slices on Organization.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ use
  • value @ system
  • 8. Organization.identifier.use
    Shortofficial | old
    BindingThe codes SHALL be taken from IdentifierUse
    (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code)
    10. Organization.identifier:orgId
    Slice NameorgId
    ShortThe current HPI organization Id for this Organization
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..1
    Must Supporttrue
    12. Organization.identifier:orgId.use
    Shortfixed to official
    Control1..?
    Fixed Valueofficial
    14. Organization.identifier:orgId.type
    Control0..0
    16. Organization.identifier:orgId.system
    Control1..?
    Fixed Valuehttps://standards.digital.health.nz/ns/hpi-organisation-id
    18. Organization.identifier:orgId.period
    Control0..0
    20. Organization.identifier:orgId.assigner
    TypeReference(HPI Organization)
    22. Organization.identifier:legacyOrgId
    Slice NamelegacyOrgId
    ShortThe MOH (NZHIS) Legacy agency code)
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    24. Organization.identifier:legacyOrgId.use
    Shortfixed to official
    Control1..?
    Fixed Valueofficial
    26. Organization.identifier:legacyOrgId.type
    Control0..0
    28. Organization.identifier:legacyOrgId.system
    Control1..?
    Fixed Valuehttps://standards.digital.health.nz/ns/nzhis-agency-id
    30. Organization.identifier:legacyOrgId.period
    Control0..0
    32. Organization.identifier:legacyOrgId.assigner
    TypeReference(HPI Organization)
    34. Organization.identifier:nzbn
    Slice Namenzbn
    ShortThe New Zealand Business Number
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    Must Supporttrue
    36. Organization.identifier:nzbn.use
    Shortfixed to official
    Control1..?
    Fixed Valueofficial
    38. Organization.identifier:nzbn.type
    Control0..0
    40. Organization.identifier:nzbn.system
    Control1..?
    Fixed Valuehttps://standards.digital.health.nz/ns/hpi-nzbn
    42. Organization.identifier:nzbn.period
    Control0..0
    44. Organization.identifier:nzbn.assigner
    TypeReference(HPI Organization)
    46. Organization.identifier:dormant
    Slice Namedormant
    ShortIdentifiers which have been deprecated
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    Must Supporttrue
    48. Organization.identifier:dormant.use
    Shortfixed to old
    Control1..?
    Fixed Valueold
    50. Organization.identifier:dormant.type
    Control0..0
    52. Organization.identifier:dormant.system
    Control1..?
    Fixed Valuehttps://standards.digital.health.nz/ns/hpi-organisation-id
    54. Organization.identifier:dormant.period
    Control0..0
    56. Organization.identifier:dormant.assigner
    TypeReference(HPI Organization)
    58. Organization.type
    BindingThe codes SHALL be taken from Organisation Type
    (required to https://nzhts.digital.health.nz/fhir/ValueSet/organisation-type-code)
    60. Organization.alias
    62. Organization.alias.extension:alias-type
    Slice Namealias-type
    ShortThe type of alias for this Organization - eg its Maori name
    64. Organization.alias.extension:alias-type.value[x]:valueCodeableConcept
    Slice NamevalueCodeableConcept
    BindingThe codes SHOULD be taken from HPI Alias Type (Organization)
    (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/organization-alias-type-code)
    TypeCodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    66. Organization.telecom
    68. Organization.telecom.use
    BindingThe codes SHALL be taken from Use values for a ContactPoint
    (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code)
    70. Organization.address
    Control0..0
    TypeAddress(Common NZ Address datatype)
    72. Organization.partOf
    TypeReference(HPI Organization)
    74. Organization.contact
    Control0..0
    76. Organization.endpoint
    Control0..0