HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions

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

Resource Profile: Location resource for use in NZ

Usages:

• This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a physical place
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		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
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.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Location.status	Base	required	LocationStatus	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Location

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a physical place
Location.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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.alias
Location.alias.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a physical place
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.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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Location.identifier	Σ This element is included in summaries.	0..*	Identifier	Unique code or number identifying the location to its users
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	Σ This element is included in summaries.	0..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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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	Σ This element is included in summaries.	0..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.telecom		0..*	ContactPoint	Contact details of the location
Location.address		0..1	Address	Physical location
Location.physicalType	Σ This element is included in summaries.	0..1	CodeableConcept	Physical form of the location Binding: LocationType (example): Physical form of the location.
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	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization responsible for provisioning and upkeep
Location.partOf		0..1	Reference(Location)	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.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Location.status	Base	required	LocationStatus	📍4.0.1	FHIR Std.
Location.operationalStatus	Base	preferred	hl7VS-bedStatus	📦3.0.0	THO v7.4
Location.mode	Base	required	LocationMode	📍4.0.1	FHIR Std.
Location.type	Base	extensible	ServiceDeliveryLocationRoleType	📦3.0.0	THO v7.4
Location.physicalType	Base	example	Location type	📍4.0.1	FHIR Std.
Location.hoursOfOperation.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Location

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org.nz/fhir/StructureDefinition/dhb
• http://hl7.org.nz/fhir/StructureDefinition/established
• http://hl7.org.nz/fhir/StructureDefinition/funded-programme
• http://hl7.org.nz/fhir/StructureDefinition/pho
• http://hl7.org.nz/fhir/StructureDefinition/messaging-address
• http://hl7.org.nz/fhir/StructureDefinition/alias-type

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a physical place
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		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
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.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Location.status	Base	required	LocationStatus	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

Differential View

This structure is derived from Location

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a physical place
Location.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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.alias
Location.alias.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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)
Documentation for this format

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Location		0..*	Location	Details and position information for a physical place
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.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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Location.identifier	Σ This element is included in summaries.	0..*	Identifier	Unique code or number identifying the location to its users
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	Σ This element is included in summaries.	0..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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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	Σ This element is included in summaries.	0..*	CodeableConcept	Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
Location.telecom		0..*	ContactPoint	Contact details of the location
Location.address		0..1	Address	Physical location
Location.physicalType	Σ This element is included in summaries.	0..1	CodeableConcept	Physical form of the location Binding: LocationType (example): Physical form of the location.
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	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization responsible for provisioning and upkeep
Location.partOf		0..1	Reference(Location)	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.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Location.status	Base	required	LocationStatus	📍4.0.1	FHIR Std.
Location.operationalStatus	Base	preferred	hl7VS-bedStatus	📦3.0.0	THO v7.4
Location.mode	Base	required	LocationMode	📍4.0.1	FHIR Std.
Location.type	Base	extensible	ServiceDeliveryLocationRoleType	📦3.0.0	THO v7.4
Location.physicalType	Base	example	Location type	📍4.0.1	FHIR Std.
Location.hoursOfOperation.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id

Grade

Path(s)

Description

Expression

This structure is derived from Location

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org.nz/fhir/StructureDefinition/dhb
• http://hl7.org.nz/fhir/StructureDefinition/established
• http://hl7.org.nz/fhir/StructureDefinition/funded-programme
• http://hl7.org.nz/fhir/StructureDefinition/pho
• http://hl7.org.nz/fhir/StructureDefinition/messaging-address
• http://hl7.org.nz/fhir/StructureDefinition/alias-type

Other representations of profile: CSV, Excel, Schematron