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.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	NzOrganization	A grouping of people or organizations with a common purpose Constraints: org-1
Organization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Organization.Slices for extension				Content/Rules for all slices
Organization.Slices for extension.extension:established		0..1	Period	The period over which this Organization has been established URL: http://hl7.org.nz/fhir/StructureDefinition/established
Organization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.Slices for identifier	Σ This element is included in summaries. C	1..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:use, value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	official | old Binding: IdentifierUse (required)
Organization.Slices for identifier.identifier:orgId	S This element must be supported. Σ This element is included in summaries. C	1..1	Identifier	The current HPI organization Id for this Organization
Organization.Slices for identifier.identifier:orgId.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:orgId.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id (no extensions allowed)
Organization.Slices for identifier.identifier:orgId.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:legacyOrgId	Σ This element is included in summaries. C	0..1	Identifier	The MOH (NZHIS) Legacy agency code)
Organization.Slices for identifier.identifier:legacyOrgId.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:legacyOrgId.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id (no extensions allowed)
Organization.Slices for identifier.identifier:legacyOrgId.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:nzbn	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	The New Zealand Business Number
Organization.Slices for identifier.identifier:nzbn.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:nzbn.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-nzbn (no extensions allowed)
Organization.Slices for identifier.identifier:nzbn.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:dormant	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	Identifiers which have been deprecated
Organization.Slices for identifier.identifier:dormant.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old (no extensions allowed)
Organization.Slices for identifier.identifier:dormant.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id (no extensions allowed)
Organization.Slices for identifier.identifier:dormant.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether the organization's record is still in active use
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: Organisation Type (required)
Organization.partOf	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	The organization of which this organization forms a part
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier.​use	Base	required	IdentifierUse	📦1.0	HIP FHIR Common Terminology Guide v1.9
Organization.identifier:orgId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:legacyOrgId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:nzbn.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:dormant.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.type	Base	required	Organisation Type	📦1.2	HIP FHIR Common Terminology Guide v1.9

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from NzOrganization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization		0..*	NzOrganization	A grouping of people or organizations with a common purpose
Organization.Slices for extension				Content/Rules for all slices
Organization.Slices for extension.extension:established		0..1	Established	The period over which this Organization has been established
Organization.Slices for extension.extension:funded-programme		0..0		Funded Healthcare Programme
Organization.Slices for identifier		1..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:use, value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.use		0..1	code	official | old Binding: IdentifierUse (required)
Organization.Slices for identifier.identifier:orgId	S This element must be supported.	1..1	Identifier	The current HPI organization Id for this Organization
Organization.Slices for identifier.identifier:orgId.use		1..1	code	fixed to official Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:orgId.type		0..0		Description of identifier
Organization.Slices for identifier.identifier:orgId.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id (no extensions allowed)
Organization.Slices for identifier.identifier:orgId.period		0..0		Time period when id is/was valid for use
Organization.Slices for identifier.identifier:orgId.assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:legacyOrgId		0..1	Identifier	The MOH (NZHIS) Legacy agency code)
Organization.Slices for identifier.identifier:legacyOrgId.use		1..1	code	fixed to official Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:legacyOrgId.type		0..0		Description of identifier
Organization.Slices for identifier.identifier:legacyOrgId.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id (no extensions allowed)
Organization.Slices for identifier.identifier:legacyOrgId.period		0..0		Time period when id is/was valid for use
Organization.Slices for identifier.identifier:legacyOrgId.assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:nzbn	S This element must be supported.	0..1	Identifier	The New Zealand Business Number
Organization.Slices for identifier.identifier:nzbn.use		1..1	code	fixed to official Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:nzbn.type		0..0		Description of identifier
Organization.Slices for identifier.identifier:nzbn.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-nzbn (no extensions allowed)
Organization.Slices for identifier.identifier:nzbn.period		0..0		Time period when id is/was valid for use
Organization.Slices for identifier.identifier:nzbn.assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:dormant	S This element must be supported.	0..*	Identifier	Identifiers which have been deprecated
Organization.Slices for identifier.identifier:dormant.use		1..1	code	fixed to old Fixed Value: old (no extensions allowed)
Organization.Slices for identifier.identifier:dormant.type		0..0		Description of identifier
Organization.Slices for identifier.identifier:dormant.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id (no extensions allowed)
Organization.Slices for identifier.identifier:dormant.period		0..0		Time period when id is/was valid for use
Organization.Slices for identifier.identifier:dormant.assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.type		0..*	CodeableConcept	Kind of organization Binding: Organisation Type (required)
Organization.alias
Organization.alias.Slices for extension				Content/Rules for all slices
Organization.alias.Slices for extension.extension:alias-type		0..1	AliasType	The type of alias for this Organization - eg its Maori name
Organization.alias.Slices for extension.extension:alias-type.valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: HPI Alias Type (Organization) (preferred)
Organization.telecom
Organization.telecom.use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required)
Organization.address		0..0		An address for the organization
Organization.partOf		0..1	Reference(HPI Organization)	The organization of which this organization forms a part
Organization.contact		0..0		Contact for the organization for a certain purpose
Organization.endpoint		0..0		Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier.​use	Base	required	IdentifierUse	📦1.0	HIP FHIR Common Terminology Guide v1.9
Organization.type	Base	required	Organisation Type	📦1.2	HIP FHIR Common Terminology Guide v1.9
Organization.alias.extension:alias-type.​valueCodeableConcept	Base	preferred	HPI Alias Type (Organization)	📦1.0	HIP FHIR Common Terminology Guide v1.9
Organization.telecom.​use	Base	required	Use values for a ContactPoint	📦1.0	HIP FHIR Common Terminology Guide v1.9

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	NzOrganization	A grouping of people or organizations with a common purpose Constraints: org-1
Organization.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Organization.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Organization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Organization.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Organization.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Organization.contained		0..*	Resource	Contained, inline Resources
Organization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Organization.Slices for extension.extension:established		0..1	Period	The period over which this Organization has been established URL: http://hl7.org.nz/fhir/StructureDefinition/established
Organization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.Slices for identifier	Σ This element is included in summaries. C	1..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:use, value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:All Slices.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	official | old Binding: IdentifierUse (required)
Organization.Slices for identifier.identifier:All Slices.type	Σ This element is included in summaries.	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.
Organization.Slices for identifier.identifier:All Slices.system	Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:All Slices.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:All Slices.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:All Slices.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:orgId	S This element must be supported. Σ This element is included in summaries. C	1..1	Identifier	The current HPI organization Id for this Organization
Organization.Slices for identifier.identifier:orgId.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:orgId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:orgId.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:orgId.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id (no extensions allowed)
Organization.Slices for identifier.identifier:orgId.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:orgId.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:legacyOrgId	Σ This element is included in summaries. C	0..1	Identifier	The MOH (NZHIS) Legacy agency code)
Organization.Slices for identifier.identifier:legacyOrgId.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:legacyOrgId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:legacyOrgId.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:legacyOrgId.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id (no extensions allowed)
Organization.Slices for identifier.identifier:legacyOrgId.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:legacyOrgId.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:nzbn	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	The New Zealand Business Number
Organization.Slices for identifier.identifier:nzbn.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:nzbn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:nzbn.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:nzbn.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-nzbn (no extensions allowed)
Organization.Slices for identifier.identifier:nzbn.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:nzbn.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:dormant	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	Identifiers which have been deprecated
Organization.Slices for identifier.identifier:dormant.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:dormant.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:dormant.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old (no extensions allowed)
Organization.Slices for identifier.identifier:dormant.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id (no extensions allowed)
Organization.Slices for identifier.identifier:dormant.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:dormant.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether the organization's record is still in active use
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: Organisation Type (required)
Organization.name	Σ This element is included in summaries. C	0..1	string	Name used for the organization
Organization.alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
Organization.alias.id		0..1	string	xml:id (or equivalent in JSON)
Organization.alias.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Organization.alias.Slices for extension.extension: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
Organization.alias.Slices for extension.extension:alias-type.id		0..1	string	Unique id for inter-element referencing
Organization.alias.Slices for extension.extension:alias-type.extension		0..0		Extension Slice: Unordered, Open by value:url
Organization.alias.Slices for extension.extension:alias-type.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/alias-type"
Organization.alias.Slices for extension.extension:alias-type.Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
Organization.alias.Slices for extension.extension:alias-type.Slices for value[x]				Content/Rules for all slices
Organization.alias.Slices for extension.extension:alias-type.Slices for value[x].value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: HPI Alias Type (Organization) (preferred)
Organization.alias.value		0..1	string	Primitive value for string Max Length:1048576
Organization.telecom	C	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
Organization.telecom.id		0..1	string	Unique id for inter-element referencing
Organization.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.telecom.system	Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Organization.telecom.value	Σ This element is included in summaries.	0..1	string	The actual contact point details
Organization.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required)
Organization.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Organization.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Organization.partOf	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	The organization of which this organization forms a part
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Organization.identifier.​use	Base	required	IdentifierUse	📦1.0	HIP FHIR Common Terminology Guide v1.9
Organization.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Organization.identifier:orgId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:legacyOrgId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:nzbn.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:dormant.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.type	Base	required	Organisation Type	📦1.2	HIP FHIR Common Terminology Guide v1.9
Organization.alias.extension:alias-type.​value[x]:valueCodeableConcept	Base	preferred	HPI Alias Type (Organization)	📦1.0	HIP FHIR Common Terminology Guide v1.9
Organization.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Organization.telecom.​use	Base	required	Use values for a ContactPoint	📦1.0	HIP FHIR Common Terminology Guide v1.9
Organization.contact.​purpose	Base	extensible	Contact entity type	📦4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	NzOrganization	A grouping of people or organizations with a common purpose Constraints: org-1
Organization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Organization.Slices for extension				Content/Rules for all slices
Organization.Slices for extension.extension:established		0..1	Period	The period over which this Organization has been established URL: http://hl7.org.nz/fhir/StructureDefinition/established
Organization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.Slices for identifier	Σ This element is included in summaries. C	1..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:use, value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	official | old Binding: IdentifierUse (required)
Organization.Slices for identifier.identifier:orgId	S This element must be supported. Σ This element is included in summaries. C	1..1	Identifier	The current HPI organization Id for this Organization
Organization.Slices for identifier.identifier:orgId.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:orgId.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id (no extensions allowed)
Organization.Slices for identifier.identifier:orgId.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:legacyOrgId	Σ This element is included in summaries. C	0..1	Identifier	The MOH (NZHIS) Legacy agency code)
Organization.Slices for identifier.identifier:legacyOrgId.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:legacyOrgId.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id (no extensions allowed)
Organization.Slices for identifier.identifier:legacyOrgId.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:nzbn	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	The New Zealand Business Number
Organization.Slices for identifier.identifier:nzbn.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:nzbn.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-nzbn (no extensions allowed)
Organization.Slices for identifier.identifier:nzbn.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:dormant	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	Identifiers which have been deprecated
Organization.Slices for identifier.identifier:dormant.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old (no extensions allowed)
Organization.Slices for identifier.identifier:dormant.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id (no extensions allowed)
Organization.Slices for identifier.identifier:dormant.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether the organization's record is still in active use
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: Organisation Type (required)
Organization.partOf	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	The organization of which this organization forms a part
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier.​use	Base	required	IdentifierUse	📦1.0	HIP FHIR Common Terminology Guide v1.9
Organization.identifier:orgId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:legacyOrgId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:nzbn.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:dormant.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.type	Base	required	Organisation Type	📦1.2	HIP FHIR Common Terminology Guide v1.9

Constraints

Id

Grade

Path(s)

Description

Expression

Differential View

This structure is derived from NzOrganization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization		0..*	NzOrganization	A grouping of people or organizations with a common purpose
Organization.Slices for extension				Content/Rules for all slices
Organization.Slices for extension.extension:established		0..1	Established	The period over which this Organization has been established
Organization.Slices for extension.extension:funded-programme		0..0		Funded Healthcare Programme
Organization.Slices for identifier		1..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:use, value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.use		0..1	code	official | old Binding: IdentifierUse (required)
Organization.Slices for identifier.identifier:orgId	S This element must be supported.	1..1	Identifier	The current HPI organization Id for this Organization
Organization.Slices for identifier.identifier:orgId.use		1..1	code	fixed to official Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:orgId.type		0..0		Description of identifier
Organization.Slices for identifier.identifier:orgId.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id (no extensions allowed)
Organization.Slices for identifier.identifier:orgId.period		0..0		Time period when id is/was valid for use
Organization.Slices for identifier.identifier:orgId.assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:legacyOrgId		0..1	Identifier	The MOH (NZHIS) Legacy agency code)
Organization.Slices for identifier.identifier:legacyOrgId.use		1..1	code	fixed to official Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:legacyOrgId.type		0..0		Description of identifier
Organization.Slices for identifier.identifier:legacyOrgId.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id (no extensions allowed)
Organization.Slices for identifier.identifier:legacyOrgId.period		0..0		Time period when id is/was valid for use
Organization.Slices for identifier.identifier:legacyOrgId.assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:nzbn	S This element must be supported.	0..1	Identifier	The New Zealand Business Number
Organization.Slices for identifier.identifier:nzbn.use		1..1	code	fixed to official Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:nzbn.type		0..0		Description of identifier
Organization.Slices for identifier.identifier:nzbn.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-nzbn (no extensions allowed)
Organization.Slices for identifier.identifier:nzbn.period		0..0		Time period when id is/was valid for use
Organization.Slices for identifier.identifier:nzbn.assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:dormant	S This element must be supported.	0..*	Identifier	Identifiers which have been deprecated
Organization.Slices for identifier.identifier:dormant.use		1..1	code	fixed to old Fixed Value: old (no extensions allowed)
Organization.Slices for identifier.identifier:dormant.type		0..0		Description of identifier
Organization.Slices for identifier.identifier:dormant.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id (no extensions allowed)
Organization.Slices for identifier.identifier:dormant.period		0..0		Time period when id is/was valid for use
Organization.Slices for identifier.identifier:dormant.assigner		0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.type		0..*	CodeableConcept	Kind of organization Binding: Organisation Type (required)
Organization.alias
Organization.alias.Slices for extension				Content/Rules for all slices
Organization.alias.Slices for extension.extension:alias-type		0..1	AliasType	The type of alias for this Organization - eg its Maori name
Organization.alias.Slices for extension.extension:alias-type.valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: HPI Alias Type (Organization) (preferred)
Organization.telecom
Organization.telecom.use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required)
Organization.address		0..0		An address for the organization
Organization.partOf		0..1	Reference(HPI Organization)	The organization of which this organization forms a part
Organization.contact		0..0		Contact for the organization for a certain purpose
Organization.endpoint		0..0		Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier.​use	Base	required	IdentifierUse	📦1.0	HIP FHIR Common Terminology Guide v1.9
Organization.type	Base	required	Organisation Type	📦1.2	HIP FHIR Common Terminology Guide v1.9
Organization.alias.extension:alias-type.​valueCodeableConcept	Base	preferred	HPI Alias Type (Organization)	📦1.0	HIP FHIR Common Terminology Guide v1.9
Organization.telecom.​use	Base	required	Use values for a ContactPoint	📦1.0	HIP FHIR Common Terminology Guide v1.9

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	NzOrganization	A grouping of people or organizations with a common purpose Constraints: org-1
Organization.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Organization.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Organization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Organization.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Organization.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Organization.contained		0..*	Resource	Contained, inline Resources
Organization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Organization.Slices for extension.extension:established		0..1	Period	The period over which this Organization has been established URL: http://hl7.org.nz/fhir/StructureDefinition/established
Organization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.Slices for identifier	Σ This element is included in summaries. C	1..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:use, value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:All Slices.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	official | old Binding: IdentifierUse (required)
Organization.Slices for identifier.identifier:All Slices.type	Σ This element is included in summaries.	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.
Organization.Slices for identifier.identifier:All Slices.system	Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:All Slices.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:All Slices.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:All Slices.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:orgId	S This element must be supported. Σ This element is included in summaries. C	1..1	Identifier	The current HPI organization Id for this Organization
Organization.Slices for identifier.identifier:orgId.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:orgId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:orgId.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:orgId.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id (no extensions allowed)
Organization.Slices for identifier.identifier:orgId.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:orgId.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:legacyOrgId	Σ This element is included in summaries. C	0..1	Identifier	The MOH (NZHIS) Legacy agency code)
Organization.Slices for identifier.identifier:legacyOrgId.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:legacyOrgId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:legacyOrgId.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:legacyOrgId.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-agency-id (no extensions allowed)
Organization.Slices for identifier.identifier:legacyOrgId.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:legacyOrgId.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:nzbn	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	The New Zealand Business Number
Organization.Slices for identifier.identifier:nzbn.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:nzbn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:nzbn.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
Organization.Slices for identifier.identifier:nzbn.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-nzbn (no extensions allowed)
Organization.Slices for identifier.identifier:nzbn.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:nzbn.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:dormant	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	Identifiers which have been deprecated
Organization.Slices for identifier.identifier:dormant.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:dormant.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:dormant.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old (no extensions allowed)
Organization.Slices for identifier.identifier:dormant.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-organisation-id (no extensions allowed)
Organization.Slices for identifier.identifier:dormant.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:dormant.assigner	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	Organization that issued id (may be just text)
Organization.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether the organization's record is still in active use
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: Organisation Type (required)
Organization.name	Σ This element is included in summaries. C	0..1	string	Name used for the organization
Organization.alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
Organization.alias.id		0..1	string	xml:id (or equivalent in JSON)
Organization.alias.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Organization.alias.Slices for extension.extension: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
Organization.alias.Slices for extension.extension:alias-type.id		0..1	string	Unique id for inter-element referencing
Organization.alias.Slices for extension.extension:alias-type.extension		0..0		Extension Slice: Unordered, Open by value:url
Organization.alias.Slices for extension.extension:alias-type.url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/alias-type"
Organization.alias.Slices for extension.extension:alias-type.Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
Organization.alias.Slices for extension.extension:alias-type.Slices for value[x]				Content/Rules for all slices
Organization.alias.Slices for extension.extension:alias-type.Slices for value[x].value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: HPI Alias Type (Organization) (preferred)
Organization.alias.value		0..1	string	Primitive value for string Max Length:1048576
Organization.telecom	C	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
Organization.telecom.id		0..1	string	Unique id for inter-element referencing
Organization.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.telecom.system	Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Organization.telecom.value	Σ This element is included in summaries.	0..1	string	The actual contact point details
Organization.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required)
Organization.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Organization.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Organization.partOf	Σ This element is included in summaries.	0..1	Reference(HPI Organization)	The organization of which this organization forms a part
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Organization.identifier.​use	Base	required	IdentifierUse	📦1.0	HIP FHIR Common Terminology Guide v1.9
Organization.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Organization.identifier:orgId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:legacyOrgId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:nzbn.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:dormant.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.type	Base	required	Organisation Type	📦1.2	HIP FHIR Common Terminology Guide v1.9
Organization.alias.extension:alias-type.​value[x]:valueCodeableConcept	Base	preferred	HPI Alias Type (Organization)	📦1.0	HIP FHIR Common Terminology Guide v1.9
Organization.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Organization.telecom.​use	Base	required	Use values for a ContactPoint	📦1.0	HIP FHIR Common Terminology Guide v1.9
Organization.contact.​purpose	Base	extensible	Contact entity type	📦4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

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:

• HPI Organization (http://hl7.org.nz/fhir/StructureDefinition/HPIOrganization)
• Common NZ Address datatype (http://hl7.org.nz/fhir/StructureDefinition/NzAddress)

Slices

This structure defines the following Slices:

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