Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location	C	0..*	NzLocation	Details and position information for a physical place Constraints: dho-location-internal-requirements
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:established		0..1	Period	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established
extension:funded-programme		0..1	(Complex)	Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:outreach	S	0..1	CodeableConcept	DHO Outreach vs Fixed site URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOOutreach Binding: Allowed outreach types for DHOLocation (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	External (provider) and Health NZ location identifiers
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
status	?!Σ	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
name	SΣ	1..1	string	Name of the location as used by humans
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: Allowed relationship types for DHOLocation (required)
Slices for telecom	S	0..*	NzContactPoint	Contact details of the location Slice: Unordered, Open by value:use
telecom:Public	S	0..*	ContactPoint	Public contact details
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
telecom:Clinical	S	0..*	ContactPoint	Clinical/professional contact
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
telecom:Technical	S	0..*	ContactPoint	Technical or routing contact
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: temp
address	S	1..1	NzAddress	Physical location
physicalType	SΣ	0..1	CodeableConcept	Physical form of the location Binding: Allowed physical types for DHOLocation (required)
managingOrganization	SΣ	1..1	Reference(Organization resource for use in NZ)	Organization responsible for provisioning and upkeep
partOf		0..1	Reference(DHO Location Profile)	Another Location this one is physically a part of
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Location.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 From the FHIR Standard
Location.type	required	DHOLocationRelationshipVS(a valid code from DHO Location Relationship) https://fhir-ig.digital.health.nz/shared-care/ValueSet/DHOLocationRelationshipVS From this IG
Location.telecom:Public.use	required	Pattern Value: work http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Location.telecom:Clinical.use	required	Pattern Value: work http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Location.telecom:Technical.use	required	Pattern Value: temp http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Location.physicalType	required	DHOLocationPhysicalTypeVS(a valid code from DHO Location Physical Type) https://fhir-ig.digital.health.nz/shared-care/ValueSet/DHOLocationPhysicalTypeVS From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dho-location-internal-requirements	error	Location	When type is 'internal', require an identifier with system 'https://standards.digital.health.nz/ns/dho-area-code', partOf.display, and partOf.identifier. : type.coding.where(code = 'internal').exists() implies (identifier.where(system = 'https://standards.digital.health.nz/ns/dho-area-code').exists() and partOf.exists() and partOf.display.exists() and partOf.identifier.exists())
dom-2	error	Location	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Location	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Location	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Location	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Location	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location	C	0..*	NzLocation	Details and position information for a physical place Constraints: dho-location-internal-requirements
meta
source		1..1	uri	HPI Facility ID from where the record is sourced
Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
Slices for extension				Content/Rules for all slices
extension:outreach	S	0..1	CodeableConcept	DHO Outreach vs Fixed site URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOOutreach Binding: Allowed outreach types for DHOLocation (required)
identifier	S	1..*	Identifier	External (provider) and Health NZ location identifiers
id		0..0
use	S	0..1	code	usual | official | temp | secondary | old (If known)
system	S	0..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
period		0..0
name	S	1..1	string	Name of the location as used by humans
type	S	0..*	CodeableConcept	Type of function performed Binding: Allowed relationship types for DHOLocation (required)
Slices for telecom	S	0..*	NzContactPoint	Contact details of the location Slice: Unordered, Open by value:use
telecom:Public	S	0..*	ContactPoint	Public contact details
use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: work
telecom:Clinical	S	0..*	ContactPoint	Clinical/professional contact
use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: work
telecom:Technical	S	0..*	ContactPoint	Technical or routing contact
use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: temp
address	S	1..1	NzAddress	Physical location
physicalType	S	0..1	CodeableConcept	Physical form of the location Binding: Allowed physical types for DHOLocation (required)
managingOrganization	S	1..1	Reference(Organization resource for use in NZ)	Organization responsible for provisioning and upkeep
partOf		0..1	Reference(DHO Location Profile)	Another Location this one is physically a part of
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Location.type	required	DHOLocationRelationshipVS(a valid code from DHO Location Relationship) https://fhir-ig.digital.health.nz/shared-care/ValueSet/DHOLocationRelationshipVS From this IG
Location.physicalType	required	DHOLocationPhysicalTypeVS(a valid code from DHO Location Physical Type) https://fhir-ig.digital.health.nz/shared-care/ValueSet/DHOLocationPhysicalTypeVS From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dho-location-internal-requirements	error	Location	When type is 'internal', require an identifier with system 'https://standards.digital.health.nz/ns/dho-area-code', partOf.display, and partOf.identifier. : type.coding.where(code = 'internal').exists() implies (identifier.where(system = 'https://standards.digital.health.nz/ns/dho-area-code').exists() and partOf.exists() and partOf.display.exists() and partOf.identifier.exists())

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location	C	0..*	NzLocation	Details and position information for a physical place Constraints: dho-location-internal-requirements
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	1..1	uri	HPI Facility ID from where the record is sourced
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
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): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:established		0..1	Period	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established
extension:funded-programme		0..1	(Complex)	Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:outreach	S	0..1	CodeableConcept	DHO Outreach vs Fixed site URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOOutreach Binding: Allowed outreach types for DHOLocation (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	External (provider) and Health NZ location identifiers
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!Σ	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
operationalStatus	Σ	0..1	Coding	The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).
name	SΣ	1..1	string	Name of the location as used by humans
alias		0..*	string	A list of alternate names that the location 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
extension:alias-type		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: Alias types (preferred)
value		0..1	string	Primitive value for string Max Length:1048576
description	Σ	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
mode	Σ	0..1	code	instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: Allowed relationship types for DHOLocation (required)
Slices for telecom	S	0..*	NzContactPoint	Contact details of the location Slice: Unordered, Open by value:use
telecom:Public	S	0..*	ContactPoint	Public contact details
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
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
telecom:Clinical	S	0..*	ContactPoint	Clinical/professional contact
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
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
telecom:Technical	S	0..*	ContactPoint	Technical or routing contact
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: temp
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
address	S	1..1	NzAddress	Physical location
physicalType	SΣ	0..1	CodeableConcept	Physical form of the location Binding: Allowed physical types for DHOLocation (required)
position		0..1	BackboneElement	The absolute geographic location
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
longitude		1..1	decimal	Longitude with WGS84 datum
latitude		1..1	decimal	Latitude with WGS84 datum
altitude		0..1	decimal	Altitude with WGS84 datum
managingOrganization	SΣ	1..1	Reference(Organization resource for use in NZ)	Organization responsible for provisioning and upkeep
partOf		0..1	Reference(DHO Location Profile)	Another Location this one is physically a part of
hoursOfOperation		0..*	BackboneElement	What days/times during a week is this location usually open
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	The Location is open all day
openingTime		0..1	time	Time that the Location opens
closingTime		0..1	time	Time that the Location closes
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Location.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Location.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Location.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Location.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Location.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Location.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 From the FHIR Standard
Location.operationalStatus	preferred	Hl7VSBedStatus http://terminology.hl7.org/ValueSet/v2-0116
Location.mode	required	LocationMode http://hl7.org/fhir/ValueSet/location-mode|4.0.1 From the FHIR Standard
Location.type	required	DHOLocationRelationshipVS(a valid code from DHO Location Relationship) https://fhir-ig.digital.health.nz/shared-care/ValueSet/DHOLocationRelationshipVS From this IG
Location.telecom:Public.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Location.telecom:Public.use	required	Pattern Value: work http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Location.telecom:Clinical.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Location.telecom:Clinical.use	required	Pattern Value: work http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Location.telecom:Technical.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Location.telecom:Technical.use	required	Pattern Value: temp http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Location.physicalType	required	DHOLocationPhysicalTypeVS(a valid code from DHO Location Physical Type) https://fhir-ig.digital.health.nz/shared-care/ValueSet/DHOLocationPhysicalTypeVS From this IG
Location.hoursOfOperation.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dho-location-internal-requirements	error	Location	When type is 'internal', require an identifier with system 'https://standards.digital.health.nz/ns/dho-area-code', partOf.display, and partOf.identifier. : type.coding.where(code = 'internal').exists() implies (identifier.where(system = 'https://standards.digital.health.nz/ns/dho-area-code').exists() and partOf.exists() and partOf.display.exists() and partOf.identifier.exists())
dom-2	error	Location	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Location	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Location	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Location	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Location	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Summary

Mandatory: 5 elements(8 nested mandatory elements)
Must-Support: 14 elements
Fixed: 1 element
Prohibited: 2 elements

Structures

This structure refers to these other structures:

• Common NZ ContactPoint datatype (http://hl7.org.nz/fhir/StructureDefinition/NzContactpoint)
• Common NZ Address datatype (http://hl7.org.nz/fhir/StructureDefinition/NzAddress)
• Organization resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzOrganization)
• DHO Location Profile (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOLocation)

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOOutreach

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Location.meta.tag
• The element 1 is sliced based on the value of Location.telecom

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location	C	0..*	NzLocation	Details and position information for a physical place Constraints: dho-location-internal-requirements
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:established		0..1	Period	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established
extension:funded-programme		0..1	(Complex)	Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:outreach	S	0..1	CodeableConcept	DHO Outreach vs Fixed site URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOOutreach Binding: Allowed outreach types for DHOLocation (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	External (provider) and Health NZ location identifiers
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
status	?!Σ	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
name	SΣ	1..1	string	Name of the location as used by humans
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: Allowed relationship types for DHOLocation (required)
Slices for telecom	S	0..*	NzContactPoint	Contact details of the location Slice: Unordered, Open by value:use
telecom:Public	S	0..*	ContactPoint	Public contact details
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
telecom:Clinical	S	0..*	ContactPoint	Clinical/professional contact
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
telecom:Technical	S	0..*	ContactPoint	Technical or routing contact
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: temp
address	S	1..1	NzAddress	Physical location
physicalType	SΣ	0..1	CodeableConcept	Physical form of the location Binding: Allowed physical types for DHOLocation (required)
managingOrganization	SΣ	1..1	Reference(Organization resource for use in NZ)	Organization responsible for provisioning and upkeep
partOf		0..1	Reference(DHO Location Profile)	Another Location this one is physically a part of
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Location.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 From the FHIR Standard
Location.type	required	DHOLocationRelationshipVS(a valid code from DHO Location Relationship) https://fhir-ig.digital.health.nz/shared-care/ValueSet/DHOLocationRelationshipVS From this IG
Location.telecom:Public.use	required	Pattern Value: work http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Location.telecom:Clinical.use	required	Pattern Value: work http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Location.telecom:Technical.use	required	Pattern Value: temp http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Location.physicalType	required	DHOLocationPhysicalTypeVS(a valid code from DHO Location Physical Type) https://fhir-ig.digital.health.nz/shared-care/ValueSet/DHOLocationPhysicalTypeVS From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dho-location-internal-requirements	error	Location	When type is 'internal', require an identifier with system 'https://standards.digital.health.nz/ns/dho-area-code', partOf.display, and partOf.identifier. : type.coding.where(code = 'internal').exists() implies (identifier.where(system = 'https://standards.digital.health.nz/ns/dho-area-code').exists() and partOf.exists() and partOf.display.exists() and partOf.identifier.exists())
dom-2	error	Location	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Location	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Location	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Location	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Location	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location	C	0..*	NzLocation	Details and position information for a physical place Constraints: dho-location-internal-requirements
meta
source		1..1	uri	HPI Facility ID from where the record is sourced
Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
Slices for extension				Content/Rules for all slices
extension:outreach	S	0..1	CodeableConcept	DHO Outreach vs Fixed site URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOOutreach Binding: Allowed outreach types for DHOLocation (required)
identifier	S	1..*	Identifier	External (provider) and Health NZ location identifiers
id		0..0
use	S	0..1	code	usual | official | temp | secondary | old (If known)
system	S	0..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
period		0..0
name	S	1..1	string	Name of the location as used by humans
type	S	0..*	CodeableConcept	Type of function performed Binding: Allowed relationship types for DHOLocation (required)
Slices for telecom	S	0..*	NzContactPoint	Contact details of the location Slice: Unordered, Open by value:use
telecom:Public	S	0..*	ContactPoint	Public contact details
use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: work
telecom:Clinical	S	0..*	ContactPoint	Clinical/professional contact
use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: work
telecom:Technical	S	0..*	ContactPoint	Technical or routing contact
use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: temp
address	S	1..1	NzAddress	Physical location
physicalType	S	0..1	CodeableConcept	Physical form of the location Binding: Allowed physical types for DHOLocation (required)
managingOrganization	S	1..1	Reference(Organization resource for use in NZ)	Organization responsible for provisioning and upkeep
partOf		0..1	Reference(DHO Location Profile)	Another Location this one is physically a part of
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Location.type	required	DHOLocationRelationshipVS(a valid code from DHO Location Relationship) https://fhir-ig.digital.health.nz/shared-care/ValueSet/DHOLocationRelationshipVS From this IG
Location.physicalType	required	DHOLocationPhysicalTypeVS(a valid code from DHO Location Physical Type) https://fhir-ig.digital.health.nz/shared-care/ValueSet/DHOLocationPhysicalTypeVS From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dho-location-internal-requirements	error	Location	When type is 'internal', require an identifier with system 'https://standards.digital.health.nz/ns/dho-area-code', partOf.display, and partOf.identifier. : type.coding.where(code = 'internal').exists() implies (identifier.where(system = 'https://standards.digital.health.nz/ns/dho-area-code').exists() and partOf.exists() and partOf.display.exists() and partOf.identifier.exists())

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location	C	0..*	NzLocation	Details and position information for a physical place Constraints: dho-location-internal-requirements
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	1..1	uri	HPI Facility ID from where the record is sourced
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
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): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:established		0..1	Period	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established
extension:funded-programme		0..1	(Complex)	Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:outreach	S	0..1	CodeableConcept	DHO Outreach vs Fixed site URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOOutreach Binding: Allowed outreach types for DHOLocation (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	External (provider) and Health NZ location identifiers
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!Σ	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
operationalStatus	Σ	0..1	Coding	The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).
name	SΣ	1..1	string	Name of the location as used by humans
alias		0..*	string	A list of alternate names that the location 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
extension:alias-type		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: Alias types (preferred)
value		0..1	string	Primitive value for string Max Length:1048576
description	Σ	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
mode	Σ	0..1	code	instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
type	SΣ	0..*	CodeableConcept	Type of function performed Binding: Allowed relationship types for DHOLocation (required)
Slices for telecom	S	0..*	NzContactPoint	Contact details of the location Slice: Unordered, Open by value:use
telecom:Public	S	0..*	ContactPoint	Public contact details
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
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
telecom:Clinical	S	0..*	ContactPoint	Clinical/professional contact
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
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
telecom:Technical	S	0..*	ContactPoint	Technical or routing contact
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: temp
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
address	S	1..1	NzAddress	Physical location
physicalType	SΣ	0..1	CodeableConcept	Physical form of the location Binding: Allowed physical types for DHOLocation (required)
position		0..1	BackboneElement	The absolute geographic location
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
longitude		1..1	decimal	Longitude with WGS84 datum
latitude		1..1	decimal	Latitude with WGS84 datum
altitude		0..1	decimal	Altitude with WGS84 datum
managingOrganization	SΣ	1..1	Reference(Organization resource for use in NZ)	Organization responsible for provisioning and upkeep
partOf		0..1	Reference(DHO Location Profile)	Another Location this one is physically a part of
hoursOfOperation		0..*	BackboneElement	What days/times during a week is this location usually open
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	The Location is open all day
openingTime		0..1	time	Time that the Location opens
closingTime		0..1	time	Time that the Location closes
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Location.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Location.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Location.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Location.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Location.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Location.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Location.status	required	LocationStatus http://hl7.org/fhir/ValueSet/location-status|4.0.1 From the FHIR Standard
Location.operationalStatus	preferred	Hl7VSBedStatus http://terminology.hl7.org/ValueSet/v2-0116
Location.mode	required	LocationMode http://hl7.org/fhir/ValueSet/location-mode|4.0.1 From the FHIR Standard
Location.type	required	DHOLocationRelationshipVS(a valid code from DHO Location Relationship) https://fhir-ig.digital.health.nz/shared-care/ValueSet/DHOLocationRelationshipVS From this IG
Location.telecom:Public.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Location.telecom:Public.use	required	Pattern Value: work http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Location.telecom:Clinical.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Location.telecom:Clinical.use	required	Pattern Value: work http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Location.telecom:Technical.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Location.telecom:Technical.use	required	Pattern Value: temp http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Location.physicalType	required	DHOLocationPhysicalTypeVS(a valid code from DHO Location Physical Type) https://fhir-ig.digital.health.nz/shared-care/ValueSet/DHOLocationPhysicalTypeVS From this IG
Location.hoursOfOperation.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dho-location-internal-requirements	error	Location	When type is 'internal', require an identifier with system 'https://standards.digital.health.nz/ns/dho-area-code', partOf.display, and partOf.identifier. : type.coding.where(code = 'internal').exists() implies (identifier.where(system = 'https://standards.digital.health.nz/ns/dho-area-code').exists() and partOf.exists() and partOf.display.exists() and partOf.identifier.exists())
dom-2	error	Location	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Location	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Location	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Location	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Location	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Summary

Mandatory: 5 elements(8 nested mandatory elements)
Must-Support: 14 elements
Fixed: 1 element
Prohibited: 2 elements

Structures

This structure refers to these other structures:

• Common NZ ContactPoint datatype (http://hl7.org.nz/fhir/StructureDefinition/NzContactpoint)
• Common NZ Address datatype (http://hl7.org.nz/fhir/StructureDefinition/NzAddress)
• Organization resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzOrganization)
• DHO Location Profile (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOLocation)

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOOutreach

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Location.meta.tag
• The element 1 is sliced based on the value of Location.telecom