HSAAP Special Authority FHIR Implementation Guide - Local Development build (v0.1.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: SA Organization

The submitting practice or facility. Optional in a submission. Derived from NZ Base NzOrganization (D4).

The legacy Practice Id (ZSS.1) is carried on identifier using the SA Legacy Practice Id naming system. Where both the payload and the authenticated context identify a practice and they disagree, the submission is rejected.

Usages:

• Use this Profile: SA Submission Bundle
• Examples for this Profile: Example Medical Centre

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• 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	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established
Organization.Slices for extension.extension:funded-programme		0..*	(Complex)	Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
Organization.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Organization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.Slices for identifier	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by 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:hpiOrganisation	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:hpiOrganisation.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:hpiOrganisation.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:hpiOrganisation.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:hpiFacility	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:hpiFacility.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:hpiFacility.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-facility-id (no extensions allowed)
Organization.Slices for identifier.identifier:hpiFacility.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:legacyPracticeId	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:legacyPracticeId.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:legacyPracticeId.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/legacy-practice-id (no extensions allowed)
Organization.Slices for identifier.identifier:legacyPracticeId.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
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.name	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Name used for the organization
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier:hpiOrganisation.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:hpiFacility.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:legacyPracticeId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

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 identifier	S This element must be supported.	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by 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:hpiOrganisation	S This element must be supported.	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:hpiOrganisation.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:hpiOrganisation.value		1..1	string	The value that is unique
Organization.Slices for identifier.identifier:hpiFacility	S This element must be supported.	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:hpiFacility.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Organization.Slices for identifier.identifier:hpiFacility.value		1..1	string	The value that is unique
Organization.Slices for identifier.identifier:legacyPracticeId	S This element must be supported.	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:legacyPracticeId.system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/legacy-practice-id (no extensions allowed)
Organization.Slices for identifier.identifier:legacyPracticeId.value		1..1	string	The value that is unique
Organization.name	S This element must be supported.	0..1	string	Name used for the organization
Documentation for this format

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	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established
Organization.Slices for extension.extension:funded-programme		0..*	(Complex)	Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
Organization.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Organization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.Slices for identifier	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by 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:hpiOrganisation	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:hpiOrganisation.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:hpiOrganisation.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:hpiOrganisation.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:hpiOrganisation.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:hpiOrganisation.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:hpiOrganisation.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:hpiOrganisation.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:hpiOrganisation.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:hpiFacility	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:hpiFacility.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:hpiFacility.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:hpiFacility.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:hpiFacility.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:hpiFacility.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-facility-id (no extensions allowed)
Organization.Slices for identifier.identifier:hpiFacility.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:hpiFacility.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:hpiFacility.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:legacyPracticeId	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:legacyPracticeId.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:legacyPracticeId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:legacyPracticeId.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:legacyPracticeId.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:legacyPracticeId.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/legacy-practice-id (no extensions allowed)
Organization.Slices for identifier.identifier:legacyPracticeId.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:legacyPracticeId.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:legacyPracticeId.assigner	Σ This element is included in summaries.	0..1	Reference(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: OrganizationType (example): Used to categorize the organization.
Organization.name	S This element must be supported. Σ 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	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: Alias types (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.address	C	0..*	Address	An address for the organization Constraints: org-2
Organization.partOf	Σ This element is included in summaries.	0..1	Reference(Organization)	The organization of which this organization forms a part
Organization.contact		0..*	BackboneElement	Contact for the organization for a certain purpose
Organization.contact.id		0..1	string	Unique id for inter-element referencing
Organization.contact.extension		0..*	Extension	Additional content defined by implementations
Organization.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
Organization.contact.name		0..1	HumanName	A name associated with the contact
Organization.contact.telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
Organization.contact.address		0..1	Address	Visiting or postal addresses for the contact
Organization.endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
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:hpiOrganisation.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:hpiOrganisation.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Organization.identifier:hpiFacility.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:hpiFacility.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Organization.identifier:legacyPracticeId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:legacyPracticeId.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Organization.type	Base	example	Organization type	📍4.0.1	FHIR Std.
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: 0 element(6 nested mandatory elements)
Must-Support: 5 elements
Fixed: 3 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Organization.identifier

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	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established
Organization.Slices for extension.extension:funded-programme		0..*	(Complex)	Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
Organization.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Organization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.Slices for identifier	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by 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:hpiOrganisation	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:hpiOrganisation.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:hpiOrganisation.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:hpiOrganisation.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:hpiFacility	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:hpiFacility.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:hpiFacility.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-facility-id (no extensions allowed)
Organization.Slices for identifier.identifier:hpiFacility.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:legacyPracticeId	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:legacyPracticeId.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:legacyPracticeId.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/legacy-practice-id (no extensions allowed)
Organization.Slices for identifier.identifier:legacyPracticeId.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
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.name	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Name used for the organization
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier:hpiOrganisation.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:hpiFacility.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:legacyPracticeId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

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 identifier	S This element must be supported.	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by 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:hpiOrganisation	S This element must be supported.	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:hpiOrganisation.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:hpiOrganisation.value		1..1	string	The value that is unique
Organization.Slices for identifier.identifier:hpiFacility	S This element must be supported.	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:hpiFacility.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id (no extensions allowed)
Organization.Slices for identifier.identifier:hpiFacility.value		1..1	string	The value that is unique
Organization.Slices for identifier.identifier:legacyPracticeId	S This element must be supported.	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:legacyPracticeId.system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/legacy-practice-id (no extensions allowed)
Organization.Slices for identifier.identifier:legacyPracticeId.value		1..1	string	The value that is unique
Organization.name	S This element must be supported.	0..1	string	Name used for the organization
Documentation for this format

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	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established
Organization.Slices for extension.extension:funded-programme		0..*	(Complex)	Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
Organization.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Organization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Organization.Slices for identifier	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by 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:hpiOrganisation	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:hpiOrganisation.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:hpiOrganisation.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:hpiOrganisation.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:hpiOrganisation.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:hpiOrganisation.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:hpiOrganisation.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:hpiOrganisation.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:hpiOrganisation.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:hpiFacility	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:hpiFacility.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:hpiFacility.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:hpiFacility.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:hpiFacility.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:hpiFacility.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-facility-id (no extensions allowed)
Organization.Slices for identifier.identifier:hpiFacility.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:hpiFacility.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:hpiFacility.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:legacyPracticeId	S This element must be supported. Σ This element is included in summaries. C	0..1	Identifier	Identifies this organization across multiple systems
Organization.Slices for identifier.identifier:legacyPracticeId.id		0..1	string	Unique id for inter-element referencing
Organization.Slices for identifier.identifier:legacyPracticeId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:legacyPracticeId.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:legacyPracticeId.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:legacyPracticeId.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir-ig.digital.health.nz/special-authority/ns/legacy-practice-id (no extensions allowed)
Organization.Slices for identifier.identifier:legacyPracticeId.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Organization.Slices for identifier.identifier:legacyPracticeId.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.Slices for identifier.identifier:legacyPracticeId.assigner	Σ This element is included in summaries.	0..1	Reference(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: OrganizationType (example): Used to categorize the organization.
Organization.name	S This element must be supported. Σ 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	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: Alias types (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.address	C	0..*	Address	An address for the organization Constraints: org-2
Organization.partOf	Σ This element is included in summaries.	0..1	Reference(Organization)	The organization of which this organization forms a part
Organization.contact		0..*	BackboneElement	Contact for the organization for a certain purpose
Organization.contact.id		0..1	string	Unique id for inter-element referencing
Organization.contact.extension		0..*	Extension	Additional content defined by implementations
Organization.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
Organization.contact.name		0..1	HumanName	A name associated with the contact
Organization.contact.telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
Organization.contact.address		0..1	Address	Visiting or postal addresses for the contact
Organization.endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
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:hpiOrganisation.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:hpiOrganisation.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Organization.identifier:hpiFacility.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:hpiFacility.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Organization.identifier:legacyPracticeId.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:legacyPracticeId.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Organization.type	Base	example	Organization type	📍4.0.1	FHIR Std.
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: 0 element(6 nested mandatory elements)
Must-Support: 5 elements
Fixed: 3 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Organization.identifier

Other representations of profile: CSV, Excel, Schematron