Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: DHO Location Profile

This profile derives from the Location Resource with localisations using international and NZ standards including the FHIR NZ Base IG, for use in the Dunedin Hospital Outpatients context.

This profile is used to represent outpatient locations for Dunedin Hospital Outpatients.

Usages:

• Refer to this Profile: DHO Location Profile and DHO Service Request Profile
• Examples for this Profile: Dunstan Outreach Clinic, Community Health Centre, John Doe's Residence, Dunedin Hospital Outpatients Clinic 1... Show 4 more, New Dunedin Hospital Outpatients, DHO Outreach Clinic, Carey Carrington's Residence and Otago Corrections Facility

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
Location	C	0..*	NzLocation	Details and position information for a physical place Constraints: dho-location-internal-requirements
Location.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
Location.Slices for extension				Content/Rules for all slices
Location.Slices for extension.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
Location.Slices for extension.extension:established		0..1	Period	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established
Location.Slices for extension.extension:funded-programme		0..1	(Complex)	Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
Location.Slices for extension.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
Location.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Location.Slices for extension.extension:outreach	S This element must be supported.	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)
Location.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Location.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	External (provider) and Health NZ location identifiers
Location.identifier.use	?! This element is a modifier element. S This element must be supported. Σ 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 .
Location.identifier.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Location.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Location.status	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	Name of the location as used by humans
Location.type	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Type of function performed Binding: Allowed relationship types for DHOLocation (required)
Location.Slices for telecom	S This element must be supported.	0..*	NzContactPoint	Contact details of the location Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for telecom.telecom:Public	S This element must be supported.	0..*	ContactPoint	Public contact details
Location.Slices for telecom.telecom:Public.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
Location.Slices for telecom.telecom:Clinical	S This element must be supported.	0..*	ContactPoint	Clinical/professional contact
Location.Slices for telecom.telecom:Clinical.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
Location.Slices for telecom.telecom:Technical	S This element must be supported.	0..*	ContactPoint	Technical or routing contact
Location.Slices for telecom.telecom:Technical.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: temp
Location.address	S This element must be supported.	1..1	NzAddress	Physical location
Location.physicalType	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Physical form of the location Binding: Allowed physical types for DHOLocation (required)
Location.managingOrganization	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Organization resource for use in NZ)	Organization responsible for provisioning and upkeep
Location.partOf		0..1	Reference(DHO Location Profile)	Another Location this one is physically a part of
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Location.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Location.status	Base	required	LocationStatus	📍4.0.1	FHIR Std.
Location.type	Base	required	Allowed relationship types for DHOLocation	📦0.4.7	This IG
Location.telecom:Public.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Location.telecom:Clinical.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Location.telecom:Technical.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Location.physicalType	Base	required	Allowed physical types for DHOLocation	📦0.4.7	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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())

This structure is derived from NzLocation

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
Location.meta
Location.meta.source		1..1	uri	HPI Facility ID from where the record is sourced
Location.meta.Slices for tag		1..*	Coding	Correlation-id where the record is sourced 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
Location.meta.Slices for tag.tag:correlationId		1..1	Coding	Tags applied to this resource
Location.meta.Slices for tag.tag:correlationId.system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
Location.meta.Slices for tag.tag:correlationId.code		1..1	code	Symbol in syntax defined by the system
Location.Slices for extension				Content/Rules for all slices
Location.Slices for extension.extension:outreach	S This element must be supported.	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)
Location.identifier	S This element must be supported.	1..*	Identifier	External (provider) and Health NZ location identifiers
Location.identifier.id		0..0		Unique id for inter-element referencing
Location.identifier.use	S This element must be supported.	0..1	code	usual | official | temp | secondary | old (If known)
Location.identifier.system	S This element must be supported.	0..1	uri	The namespace for the identifier value
Location.identifier.value	S This element must be supported.	1..1	string	The value that is unique
Location.identifier.period		0..0		Time period when id is/was valid for use
Location.name	S This element must be supported.	1..1	string	Name of the location as used by humans
Location.type	S This element must be supported.	0..*	CodeableConcept	Type of function performed Binding: Allowed relationship types for DHOLocation (required)
Location.Slices for telecom	S This element must be supported.	0..*	NzContactPoint	Contact details of the location Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for telecom.telecom:Public	S This element must be supported.	0..*	ContactPoint	Public contact details
Location.Slices for telecom.telecom:Public.use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: work
Location.Slices for telecom.telecom:Clinical	S This element must be supported.	0..*	ContactPoint	Clinical/professional contact
Location.Slices for telecom.telecom:Clinical.use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: work
Location.Slices for telecom.telecom:Technical	S This element must be supported.	0..*	ContactPoint	Technical or routing contact
Location.Slices for telecom.telecom:Technical.use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: temp
Location.address	S This element must be supported.	1..1	NzAddress	Physical location
Location.physicalType	S This element must be supported.	0..1	CodeableConcept	Physical form of the location Binding: Allowed physical types for DHOLocation (required)
Location.managingOrganization	S This element must be supported.	1..1	Reference(Organization resource for use in NZ)	Organization responsible for provisioning and upkeep
Location.partOf		0..1	Reference(DHO Location Profile)	Another Location this one is physically a part of
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Location.type	Base	required	Allowed relationship types for DHOLocation	📦0.4.7	This IG
Location.physicalType	Base	required	Allowed physical types for DHOLocation	📦0.4.7	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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
Location.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Location.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Location.meta.id		0..1	string	Unique id for inter-element referencing
Location.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Location.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Location.meta.source	Σ This element is included in summaries.	1..1	uri	HPI Facility ID from where the record is sourced
Location.meta.profile	Σ This element is included in summaries.	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
Location.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Location.meta.Slices for tag	Σ This element is included in summaries.	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". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.meta.Slices for tag.tag:correlationId	Σ This element is included in summaries.	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".
Location.meta.Slices for tag.tag:correlationId.id		0..1	string	Unique id for inter-element referencing
Location.meta.Slices for tag.tag:correlationId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.meta.Slices for tag.tag:correlationId.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
Location.meta.Slices for tag.tag:correlationId.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Location.meta.Slices for tag.tag:correlationId.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Location.meta.Slices for tag.tag:correlationId.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Location.meta.Slices for tag.tag:correlationId.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Location.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
Location.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Location.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
Location.contained		0..*	Resource	Contained, inline Resources
Location.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Location.Slices for extension.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
Location.Slices for extension.extension:established		0..1	Period	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established
Location.Slices for extension.extension:funded-programme		0..1	(Complex)	Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
Location.Slices for extension.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
Location.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Location.Slices for extension.extension:outreach	S This element must be supported.	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)
Location.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Location.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	External (provider) and Health NZ location identifiers
Location.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.identifier.use	?! This element is a modifier element. S This element must be supported. Σ 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 .
Location.identifier.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.
Location.identifier.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Location.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Location.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Location.status	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.operationalStatus	Σ This element is included in summaries.	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).
Location.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	Name of the location as used by humans
Location.alias		0..*	string	A list of alternate names that the location is known as, or was known as, in the past
Location.alias.id		0..1	string	xml:id (or equivalent in JSON)
Location.alias.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Location.alias.Slices for extension.extension:alias-type		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: Alias types (preferred)
Location.alias.value		0..1	string	Primitive value for string Max Length:1048576
Location.description	Σ This element is included in summaries.	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
Location.mode	Σ This element is included in summaries.	0..1	code	instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
Location.type	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Type of function performed Binding: Allowed relationship types for DHOLocation (required)
Location.Slices for telecom	S This element must be supported.	0..*	NzContactPoint	Contact details of the location Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for telecom.telecom:Public	S This element must be supported.	0..*	ContactPoint	Public contact details
Location.Slices for telecom.telecom:Public.id		0..1	string	Unique id for inter-element referencing
Location.Slices for telecom.telecom:Public.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.Slices for telecom.telecom:Public.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.
Location.Slices for telecom.telecom:Public.value	Σ This element is included in summaries.	0..1	string	The actual contact point details
Location.Slices for telecom.telecom:Public.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
Location.Slices for telecom.telecom:Public.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Location.Slices for telecom.telecom:Public.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Location.Slices for telecom.telecom:Clinical	S This element must be supported.	0..*	ContactPoint	Clinical/professional contact
Location.Slices for telecom.telecom:Clinical.id		0..1	string	Unique id for inter-element referencing
Location.Slices for telecom.telecom:Clinical.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.Slices for telecom.telecom:Clinical.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.
Location.Slices for telecom.telecom:Clinical.value	Σ This element is included in summaries.	0..1	string	The actual contact point details
Location.Slices for telecom.telecom:Clinical.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
Location.Slices for telecom.telecom:Clinical.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Location.Slices for telecom.telecom:Clinical.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Location.Slices for telecom.telecom:Technical	S This element must be supported.	0..*	ContactPoint	Technical or routing contact
Location.Slices for telecom.telecom:Technical.id		0..1	string	Unique id for inter-element referencing
Location.Slices for telecom.telecom:Technical.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.Slices for telecom.telecom:Technical.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.
Location.Slices for telecom.telecom:Technical.value	Σ This element is included in summaries.	0..1	string	The actual contact point details
Location.Slices for telecom.telecom:Technical.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: temp
Location.Slices for telecom.telecom:Technical.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Location.Slices for telecom.telecom:Technical.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Location.address	S This element must be supported.	1..1	NzAddress	Physical location
Location.physicalType	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Physical form of the location Binding: Allowed physical types for DHOLocation (required)
Location.position		0..1	BackboneElement	The absolute geographic location
Location.position.id		0..1	string	Unique id for inter-element referencing
Location.position.extension		0..*	Extension	Additional content defined by implementations
Location.position.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Location.position.longitude		1..1	decimal	Longitude with WGS84 datum
Location.position.latitude		1..1	decimal	Latitude with WGS84 datum
Location.position.altitude		0..1	decimal	Altitude with WGS84 datum
Location.managingOrganization	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Organization resource for use in NZ)	Organization responsible for provisioning and upkeep
Location.partOf		0..1	Reference(DHO Location Profile)	Another Location this one is physically a part of
Location.hoursOfOperation		0..*	BackboneElement	What days/times during a week is this location usually open
Location.hoursOfOperation.id		0..1	string	Unique id for inter-element referencing
Location.hoursOfOperation.extension		0..*	Extension	Additional content defined by implementations
Location.hoursOfOperation.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Location.hoursOfOperation.daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
Location.hoursOfOperation.allDay		0..1	boolean	The Location is open all day
Location.hoursOfOperation.openingTime		0..1	time	Time that the Location opens
Location.hoursOfOperation.closingTime		0..1	time	Time that the Location closes
Location.availabilityExceptions		0..1	string	Description of availability exceptions
Location.endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Location.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Location.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Location.meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
Location.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Location.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Location.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Location.status	Base	required	LocationStatus	📍4.0.1	FHIR Std.
Location.operationalStatus	Base	preferred	hl7VS-bedStatus	📦2.0.0	THO v6.5
Location.mode	Base	required	LocationMode	📍4.0.1	FHIR Std.
Location.type	Base	required	Allowed relationship types for DHOLocation	📦0.4.7	This IG
Location.telecom:Public.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Location.telecom:Public.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Location.telecom:Clinical.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Location.telecom:Clinical.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Location.telecom:Technical.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Location.telecom:Technical.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Location.physicalType	Base	required	Allowed physical types for DHOLocation	📦0.4.7	This IG
Location.hoursOfOperation.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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())

This structure is derived from NzLocation

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

Key Elements View

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
Location.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
Location.Slices for extension				Content/Rules for all slices
Location.Slices for extension.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
Location.Slices for extension.extension:established		0..1	Period	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established
Location.Slices for extension.extension:funded-programme		0..1	(Complex)	Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
Location.Slices for extension.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
Location.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Location.Slices for extension.extension:outreach	S This element must be supported.	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)
Location.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Location.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	External (provider) and Health NZ location identifiers
Location.identifier.use	?! This element is a modifier element. S This element must be supported. Σ 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 .
Location.identifier.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Location.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Location.status	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	Name of the location as used by humans
Location.type	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Type of function performed Binding: Allowed relationship types for DHOLocation (required)
Location.Slices for telecom	S This element must be supported.	0..*	NzContactPoint	Contact details of the location Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for telecom.telecom:Public	S This element must be supported.	0..*	ContactPoint	Public contact details
Location.Slices for telecom.telecom:Public.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
Location.Slices for telecom.telecom:Clinical	S This element must be supported.	0..*	ContactPoint	Clinical/professional contact
Location.Slices for telecom.telecom:Clinical.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
Location.Slices for telecom.telecom:Technical	S This element must be supported.	0..*	ContactPoint	Technical or routing contact
Location.Slices for telecom.telecom:Technical.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: temp
Location.address	S This element must be supported.	1..1	NzAddress	Physical location
Location.physicalType	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Physical form of the location Binding: Allowed physical types for DHOLocation (required)
Location.managingOrganization	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Organization resource for use in NZ)	Organization responsible for provisioning and upkeep
Location.partOf		0..1	Reference(DHO Location Profile)	Another Location this one is physically a part of
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Location.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Location.status	Base	required	LocationStatus	📍4.0.1	FHIR Std.
Location.type	Base	required	Allowed relationship types for DHOLocation	📦0.4.7	This IG
Location.telecom:Public.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Location.telecom:Clinical.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Location.telecom:Technical.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Location.physicalType	Base	required	Allowed physical types for DHOLocation	📦0.4.7	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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())

Differential View

This structure is derived from NzLocation

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
Location.meta
Location.meta.source		1..1	uri	HPI Facility ID from where the record is sourced
Location.meta.Slices for tag		1..*	Coding	Correlation-id where the record is sourced 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
Location.meta.Slices for tag.tag:correlationId		1..1	Coding	Tags applied to this resource
Location.meta.Slices for tag.tag:correlationId.system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
Location.meta.Slices for tag.tag:correlationId.code		1..1	code	Symbol in syntax defined by the system
Location.Slices for extension				Content/Rules for all slices
Location.Slices for extension.extension:outreach	S This element must be supported.	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)
Location.identifier	S This element must be supported.	1..*	Identifier	External (provider) and Health NZ location identifiers
Location.identifier.id		0..0		Unique id for inter-element referencing
Location.identifier.use	S This element must be supported.	0..1	code	usual | official | temp | secondary | old (If known)
Location.identifier.system	S This element must be supported.	0..1	uri	The namespace for the identifier value
Location.identifier.value	S This element must be supported.	1..1	string	The value that is unique
Location.identifier.period		0..0		Time period when id is/was valid for use
Location.name	S This element must be supported.	1..1	string	Name of the location as used by humans
Location.type	S This element must be supported.	0..*	CodeableConcept	Type of function performed Binding: Allowed relationship types for DHOLocation (required)
Location.Slices for telecom	S This element must be supported.	0..*	NzContactPoint	Contact details of the location Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for telecom.telecom:Public	S This element must be supported.	0..*	ContactPoint	Public contact details
Location.Slices for telecom.telecom:Public.use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: work
Location.Slices for telecom.telecom:Clinical	S This element must be supported.	0..*	ContactPoint	Clinical/professional contact
Location.Slices for telecom.telecom:Clinical.use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: work
Location.Slices for telecom.telecom:Technical	S This element must be supported.	0..*	ContactPoint	Technical or routing contact
Location.Slices for telecom.telecom:Technical.use		1..1	code	home | work | temp | old | mobile - purpose of this contact point Required Pattern: temp
Location.address	S This element must be supported.	1..1	NzAddress	Physical location
Location.physicalType	S This element must be supported.	0..1	CodeableConcept	Physical form of the location Binding: Allowed physical types for DHOLocation (required)
Location.managingOrganization	S This element must be supported.	1..1	Reference(Organization resource for use in NZ)	Organization responsible for provisioning and upkeep
Location.partOf		0..1	Reference(DHO Location Profile)	Another Location this one is physically a part of
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Location.type	Base	required	Allowed relationship types for DHOLocation	📦0.4.7	This IG
Location.physicalType	Base	required	Allowed physical types for DHOLocation	📦0.4.7	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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())

Snapshot View

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
Location.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Location.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Location.meta.id		0..1	string	Unique id for inter-element referencing
Location.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Location.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Location.meta.source	Σ This element is included in summaries.	1..1	uri	HPI Facility ID from where the record is sourced
Location.meta.profile	Σ This element is included in summaries.	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
Location.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Location.meta.Slices for tag	Σ This element is included in summaries.	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". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.meta.Slices for tag.tag:correlationId	Σ This element is included in summaries.	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".
Location.meta.Slices for tag.tag:correlationId.id		0..1	string	Unique id for inter-element referencing
Location.meta.Slices for tag.tag:correlationId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.meta.Slices for tag.tag:correlationId.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
Location.meta.Slices for tag.tag:correlationId.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Location.meta.Slices for tag.tag:correlationId.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Location.meta.Slices for tag.tag:correlationId.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Location.meta.Slices for tag.tag:correlationId.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Location.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
Location.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Location.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
Location.contained		0..*	Resource	Contained, inline Resources
Location.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Location.Slices for extension.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
Location.Slices for extension.extension:established		0..1	Period	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/established
Location.Slices for extension.extension:funded-programme		0..1	(Complex)	Funded Healthcare Programme URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
Location.Slices for extension.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
Location.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Location.Slices for extension.extension:outreach	S This element must be supported.	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)
Location.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Location.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	External (provider) and Health NZ location identifiers
Location.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.identifier.use	?! This element is a modifier element. S This element must be supported. Σ 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 .
Location.identifier.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.
Location.identifier.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Location.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Location.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Location.status	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.operationalStatus	Σ This element is included in summaries.	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).
Location.name	S This element must be supported. Σ This element is included in summaries.	1..1	string	Name of the location as used by humans
Location.alias		0..*	string	A list of alternate names that the location is known as, or was known as, in the past
Location.alias.id		0..1	string	xml:id (or equivalent in JSON)
Location.alias.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Location.alias.Slices for extension.extension:alias-type		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: Alias types (preferred)
Location.alias.value		0..1	string	Primitive value for string Max Length:1048576
Location.description	Σ This element is included in summaries.	0..1	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
Location.mode	Σ This element is included in summaries.	0..1	code	instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
Location.type	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Type of function performed Binding: Allowed relationship types for DHOLocation (required)
Location.Slices for telecom	S This element must be supported.	0..*	NzContactPoint	Contact details of the location Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Location.Slices for telecom.telecom:Public	S This element must be supported.	0..*	ContactPoint	Public contact details
Location.Slices for telecom.telecom:Public.id		0..1	string	Unique id for inter-element referencing
Location.Slices for telecom.telecom:Public.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.Slices for telecom.telecom:Public.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.
Location.Slices for telecom.telecom:Public.value	Σ This element is included in summaries.	0..1	string	The actual contact point details
Location.Slices for telecom.telecom:Public.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
Location.Slices for telecom.telecom:Public.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Location.Slices for telecom.telecom:Public.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Location.Slices for telecom.telecom:Clinical	S This element must be supported.	0..*	ContactPoint	Clinical/professional contact
Location.Slices for telecom.telecom:Clinical.id		0..1	string	Unique id for inter-element referencing
Location.Slices for telecom.telecom:Clinical.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.Slices for telecom.telecom:Clinical.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.
Location.Slices for telecom.telecom:Clinical.value	Σ This element is included in summaries.	0..1	string	The actual contact point details
Location.Slices for telecom.telecom:Clinical.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: work
Location.Slices for telecom.telecom:Clinical.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Location.Slices for telecom.telecom:Clinical.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Location.Slices for telecom.telecom:Technical	S This element must be supported.	0..*	ContactPoint	Technical or routing contact
Location.Slices for telecom.telecom:Technical.id		0..1	string	Unique id for inter-element referencing
Location.Slices for telecom.telecom:Technical.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Location.Slices for telecom.telecom:Technical.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.
Location.Slices for telecom.telecom:Technical.value	Σ This element is included in summaries.	0..1	string	The actual contact point details
Location.Slices for telecom.telecom:Technical.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: temp
Location.Slices for telecom.telecom:Technical.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Location.Slices for telecom.telecom:Technical.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Location.address	S This element must be supported.	1..1	NzAddress	Physical location
Location.physicalType	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Physical form of the location Binding: Allowed physical types for DHOLocation (required)
Location.position		0..1	BackboneElement	The absolute geographic location
Location.position.id		0..1	string	Unique id for inter-element referencing
Location.position.extension		0..*	Extension	Additional content defined by implementations
Location.position.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Location.position.longitude		1..1	decimal	Longitude with WGS84 datum
Location.position.latitude		1..1	decimal	Latitude with WGS84 datum
Location.position.altitude		0..1	decimal	Altitude with WGS84 datum
Location.managingOrganization	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Organization resource for use in NZ)	Organization responsible for provisioning and upkeep
Location.partOf		0..1	Reference(DHO Location Profile)	Another Location this one is physically a part of
Location.hoursOfOperation		0..*	BackboneElement	What days/times during a week is this location usually open
Location.hoursOfOperation.id		0..1	string	Unique id for inter-element referencing
Location.hoursOfOperation.extension		0..*	Extension	Additional content defined by implementations
Location.hoursOfOperation.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Location.hoursOfOperation.daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
Location.hoursOfOperation.allDay		0..1	boolean	The Location is open all day
Location.hoursOfOperation.openingTime		0..1	time	Time that the Location opens
Location.hoursOfOperation.closingTime		0..1	time	Time that the Location closes
Location.availabilityExceptions		0..1	string	Description of availability exceptions
Location.endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the location
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Location.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Location.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Location.meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
Location.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Location.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Location.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Location.status	Base	required	LocationStatus	📍4.0.1	FHIR Std.
Location.operationalStatus	Base	preferred	hl7VS-bedStatus	📦2.0.0	THO v6.5
Location.mode	Base	required	LocationMode	📍4.0.1	FHIR Std.
Location.type	Base	required	Allowed relationship types for DHOLocation	📦0.4.7	This IG
Location.telecom:Public.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Location.telecom:Public.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Location.telecom:Clinical.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Location.telecom:Clinical.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Location.telecom:Technical.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Location.telecom:Technical.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Location.physicalType	Base	required	Allowed physical types for DHOLocation	📦0.4.7	This IG
Location.hoursOfOperation.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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())

This structure is derived from NzLocation

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

Other representations of profile: CSV, Excel, Schematron