New Zealand HPI Implementation Guide, published by Ministry of Health. This is not an authorized publication; it is the continuous build for version 0.9.0). 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
| Defining URL: | http://hl7.org.nz/fhir/StructureDefinition/hpiOrganization |
| Version: | 0.9.0 |
| Name: | HpiOrganization |
| Title: | HPI Organization |
| Status: | Active as of 12/3/21, 2:22 AM |
| Definition: | An entity that provides services of interest to, or is involved in, the business of health care service provision. |
| Publisher: | Ministry of Health |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org.nz/fhir/StructureDefinition/hpiOrganization
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organization
Summary
Mandatory: 4 elements (6 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 8 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/established
- http://hl7.org.nz/fhir/StructureDefinition/alias-type
Slices
This structure defines the following Slices:
- The element Organization.identifier is sliced based on the values of value:use, value:system (Open at End)
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization | 0..* | Organization | A grouping of people or organizations with a common purpose | |
  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 | |
  Slices for identifier | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open At End 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 | |
 system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id | |
| identifier:legacyOrgId | 0..1 | Identifier | The MOH (NZHIS) Legacy agency code) | |
| use | 1..1 | code | fixed to official Fixed Value: official | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id | |
 identifier:nzbn | S | 0..0 | ||
 identifier:dormant | S | 0..* | Identifier | Identifies this organization across multiple systems |
 use | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: old | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/id/hpi-org | |
| type | 0..* | CodeableConcept | Kind of organization Binding: Organisation Type (required) | |
| alias | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 alias-type | 0..1 | CodeableConcept | The type of alias for this Organization - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: All the possible alias types (preferred) | |
| 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 | |||
| contact | 0..0 | |||
| endpoint | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | Organization | A grouping of people or organizations with a common purpose |
 id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| 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 | ΣI | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open At End by value:use, value:system |
| identifier:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for 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ΣI | 1..1 | Identifier | The current HPI organization Id for this Organization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for 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 |
| 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 | Σ | 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 |
| 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:legacyOrgId | ΣI | 0..1 | Identifier | The MOH (NZHIS) Legacy agency code) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for 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 |
| 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 | Σ | 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 |
| 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:dormant | SΣI | 0..* | Identifier | Identifies this organization across multiple systems |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old |
| 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 | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/id/hpi-org |
| 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) |
| 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 | ΣI | 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 | CodeableConcept | The type of alias for this Organization - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: All the possible alias types (preferred) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for 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 | I | 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 | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | ΣI | 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(Organization) | The organization of which this organization forms a part |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | Organization | A grouping of people or organizations with a common purpose |
| identifier:orgId | ΣI | 1..1 | Identifier | The current HPI organization Id for this Organization |
| identifier:dormant | ΣI | 0..* | Identifier | Identifies this organization across multiple systems |
| Documentation for this format | ||||
This structure is derived from Organization
Summary
Mandatory: 4 elements (6 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 8 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/established
- http://hl7.org.nz/fhir/StructureDefinition/alias-type
Slices
This structure defines the following Slices:
- The element Organization.identifier is sliced based on the values of value:use, value:system (Open at End)
Differential View
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | 0..* | Organization | A grouping of people or organizations with a common purpose | |
| 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 | |
| Slices for identifier | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open At End 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 | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id | |
| identifier:legacyOrgId | 0..1 | Identifier | The MOH (NZHIS) Legacy agency code) | |
| use | 1..1 | code | fixed to official Fixed Value: official | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id | |
| identifier:nzbn | S | 0..0 | ||
| identifier:dormant | S | 0..* | Identifier | Identifies this organization across multiple systems |
| use | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: old | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/id/hpi-org | |
| type | 0..* | CodeableConcept | Kind of organization Binding: Organisation Type (required) | |
| alias | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| alias-type | 0..1 | CodeableConcept | The type of alias for this Organization - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: All the possible alias types (preferred) | |
| 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 | |||
| contact | 0..0 | |||
| endpoint | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | Organization | A grouping of people or organizations with a common purpose |
| id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| 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 | ΣI | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open At End by value:use, value:system |
| identifier:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for 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ΣI | 1..1 | Identifier | The current HPI organization Id for this Organization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for 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 |
| 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 | Σ | 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 |
| 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:legacyOrgId | ΣI | 0..1 | Identifier | The MOH (NZHIS) Legacy agency code) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for 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 |
| 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 | Σ | 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 |
| 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:dormant | SΣI | 0..* | Identifier | Identifies this organization across multiple systems |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old |
| 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 | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/id/hpi-org |
| 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) |
| 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 | ΣI | 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 | CodeableConcept | The type of alias for this Organization - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: All the possible alias types (preferred) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for 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 | I | 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 | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | ΣI | 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(Organization) | The organization of which this organization forms a part |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| Organization.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Organization.identifier.use | required | Hpi_IdentfierUse |
| Organization.identifier.type | extensible | Identifier Type Codes |
| Organization.identifier:orgId.use | required | Fixed Value: official |
| Organization.identifier:orgId.type | extensible | Identifier Type Codes |
| Organization.identifier:legacyOrgId.use | required | Fixed Value: official |
| Organization.identifier:legacyOrgId.type | extensible | Identifier Type Codes |
| Organization.identifier:nzbn.use | required | Fixed Value: official |
| Organization.identifier:nzbn.type | extensible | Identifier Type Codes |
| Organization.identifier:dormant.use | required | Fixed Value: old |
| Organization.identifier:dormant.type | extensible | Identifier Type Codes |
| Organization.type | required | Hpi_organisation_type |
| Organization.alias.extension:alias-type.value[x]:valueCodeableConcept | preferred | Hpi_organization_alias_type |
| Organization.telecom.system | required | ContactPointSystem |
| Organization.telecom.use | required | Hpi_ContactPointUse |
| Organization.contact.purpose | extensible | ContactEntityType |
Constraints
| Id | Path | Details | Requirements |
| org-3 | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |