HL7.ORG.NZ.FHIR.IG.HPI\HPI Location

New Zealand HPI Implementation Guide
0.9.0 - CI Build

New Zealand HPI Implementation Guide, published by Ministry of Health. This is not an authorized publication; it is the continuous build for version 0.9.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions

Resource Profile: HPI Location

Defining URL:

http://hl7.org.nz/fhir/StructureDefinition/HPILocation

Version:

0.9.0

Name:

HpiLocation

Title:

HPI Location

Status:

Active as of 12/3/21, 2:22 AM

Definition:

A physical location from which health goods and/or services are provided. They are also referred to as an HPI Facility.

Publisher:

Ministry of Health

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org.nz/fhir/StructureDefinition/HPILocation

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from Location

Summary

Mandatory: 4 elements (6 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 6 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

Common NZ Address datatype (http://hl7.org.nz/fhir/StructureDefinition/hpi-nz-address)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element Location.identifier is sliced based on the values of value:use, value:system

This structure is derived from Location

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Details and position information for a physical place
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
established		0..1	Period	The date when this location first became available for use URL: http://hl7.org.nz/fhir/StructureDefinition/established
dhb		0..1	CodeableConcept	The identifier for the DHB that is associated with this location URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Slices for identifier		1..*	Identifier	Unique code or number identifying the location to its users Slice: Unordered, Open by value:use, value:system
identifier:All Slices				Content/Rules for all slices
use		0..1	code	official \| old Binding: IdentifierUse (required)
identifier:facId	S	1..1	Identifier	The current Facility id for this location
use		1..1	code	fixed to official Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
identifier:dormant	S	0..*	Identifier	Old facility id's that have been deprecated
use		1..1	code	fixed to old Fixed Value: old
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
identifier:legacyFacId		0..1	Identifier	The MOH (NZHIS) Legacy facility code)
use		1..1	code	fixed to official Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id
operationalStatus		0..0
alias
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
alias-type		1..1	CodeableConcept	The type of alias this is - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: All the possible alias types (preferred)
valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: HPI Alias Type (Location) (preferred)
mode		0..0
type		0..*	CodeableConcept	Type of function performed Binding: HPI Location Type (required)
telecom
edi-address		0..1	string	EDI Address URL: http://hl7.org.nz/fhir/StructureDefinition/edi-address
use		0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: Use values for a ContactPoint (required)
address		0..1	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
use		0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: Address Use for Location (required)
physicalType		0..0
position		0..0
hoursOfOperation		0..0
availabilityExceptions		0..0
endpoint		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Details and position information for a physical place
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
established		0..1	Period	The date when this location first became available for use URL: http://hl7.org.nz/fhir/StructureDefinition/established
dhb		0..1	CodeableConcept	The identifier for the DHB that is associated with this location URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..*	Identifier	Unique code or number identifying the location to its users Slice: Unordered, Open by value:use, value:system
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	official \| old Binding: IdentifierUse (required)
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	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:facId	SΣ	1..1	Identifier	The current Facility id for this location
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:dormant	SΣ	0..*	Identifier	Old facility id's that have been deprecated
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old
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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:legacyFacId	Σ	0..1	Identifier	The MOH (NZHIS) Legacy facility code)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
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.
name	Σ	0..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		1..*	Extension	Extension Slice: Unordered, Open by value:url
alias-type		1..1	CodeableConcept	The type of alias this is - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: All the possible alias types (preferred)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/alias-type"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: HPI Alias Type (Location) (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
type	Σ	0..*	CodeableConcept	Type of function performed Binding: HPI Location Type (required)
telecom		0..*	ContactPoint	Contact details of the location
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
edi-address		0..1	string	EDI Address URL: http://hl7.org.nz/fhir/StructureDefinition/edi-address
system	ΣI	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	?!Σ	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: Use values for a ContactPoint (required)
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		0..1	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
suburb		0..1	string	The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
domicile-code		0..1	CodeableConcept	The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: domicileCode (preferred)
esam-id		0..1	string	The esam id for this address URL: http://hl7.org.nz/fhir/StructureDefinition/esam-id
use	?!Σ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: Address Use for Location (required) Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
managingOrganization	Σ	0..1	Reference(Organization)	Organization responsible for provisioning and upkeep
partOf		0..1	Reference(Location)	Another Location this one is physically a part of
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Details and position information for a physical place
identifier:facId	Σ	1..1	Identifier	The current Facility id for this location
identifier:dormant	Σ	0..*	Identifier	Old facility id's that have been deprecated
Documentation for this format

This structure is derived from Location

Summary

Mandatory: 4 elements (6 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 6 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

Common NZ Address datatype (http://hl7.org.nz/fhir/StructureDefinition/hpi-nz-address)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element Location.identifier is sliced based on the values of value:use, value:system

Differential View

This structure is derived from Location

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Details and position information for a physical place
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
established		0..1	Period	The date when this location first became available for use URL: http://hl7.org.nz/fhir/StructureDefinition/established
dhb		0..1	CodeableConcept	The identifier for the DHB that is associated with this location URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Slices for identifier		1..*	Identifier	Unique code or number identifying the location to its users Slice: Unordered, Open by value:use, value:system
identifier:All Slices				Content/Rules for all slices
use		0..1	code	official \| old Binding: IdentifierUse (required)
identifier:facId	S	1..1	Identifier	The current Facility id for this location
use		1..1	code	fixed to official Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
identifier:dormant	S	0..*	Identifier	Old facility id's that have been deprecated
use		1..1	code	fixed to old Fixed Value: old
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
identifier:legacyFacId		0..1	Identifier	The MOH (NZHIS) Legacy facility code)
use		1..1	code	fixed to official Fixed Value: official
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id
operationalStatus		0..0
alias
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
alias-type		1..1	CodeableConcept	The type of alias this is - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: All the possible alias types (preferred)
valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: HPI Alias Type (Location) (preferred)
mode		0..0
type		0..*	CodeableConcept	Type of function performed Binding: HPI Location Type (required)
telecom
edi-address		0..1	string	EDI Address URL: http://hl7.org.nz/fhir/StructureDefinition/edi-address
use		0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: Use values for a ContactPoint (required)
address		0..1	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
use		0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: Address Use for Location (required)
physicalType		0..0
position		0..0
hoursOfOperation		0..0
availabilityExceptions		0..0
endpoint		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Location		0..*	Location	Details and position information for a physical place
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
established		0..1	Period	The date when this location first became available for use URL: http://hl7.org.nz/fhir/StructureDefinition/established
dhb		0..1	CodeableConcept	The identifier for the DHB that is associated with this location URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	1..*	Identifier	Unique code or number identifying the location to its users Slice: Unordered, Open by value:use, value:system
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	official \| old Binding: IdentifierUse (required)
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	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:facId	SΣ	1..1	Identifier	The current Facility id for this location
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:dormant	SΣ	0..*	Identifier	Old facility id's that have been deprecated
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	fixed to old Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: old
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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:legacyFacId	Σ	0..1	Identifier	The MOH (NZHIS) Legacy facility code)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	fixed to official Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nzhis-facility-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
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.
name	Σ	0..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		1..*	Extension	Extension Slice: Unordered, Open by value:url
alias-type		1..1	CodeableConcept	The type of alias this is - eg its Maori name URL: http://hl7.org.nz/fhir/StructureDefinition/alias-type Binding: All the possible alias types (preferred)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..0
url		1..1	uri	"http://hl7.org.nz/fhir/StructureDefinition/alias-type"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	Value of extension Binding: HPI Alias Type (Location) (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
type	Σ	0..*	CodeableConcept	Type of function performed Binding: HPI Location Type (required)
telecom		0..*	ContactPoint	Contact details of the location
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
edi-address		0..1	string	EDI Address URL: http://hl7.org.nz/fhir/StructureDefinition/edi-address
system	ΣI	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	?!Σ	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: Use values for a ContactPoint (required)
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		0..1	NzAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
nz-geocode		0..1	(Complex)	A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
suburb		0..1	string	The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
building-name		0..1	string	The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
domicile-code		0..1	CodeableConcept	The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: domicileCode (preferred)
esam-id		0..1	string	The esam id for this address URL: http://hl7.org.nz/fhir/StructureDefinition/esam-id
use	?!Σ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: Address Use for Location (required) Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
managingOrganization	Σ	0..1	Reference(Organization)	Organization responsible for provisioning and upkeep
partOf		0..1	Reference(Location)	Another Location this one is physically a part of
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet / Code
Location.language	preferred	CommonLanguages Max Binding: AllLanguages
Location.identifier.use	required	Hpi_IdentfierUse
Location.identifier.type	extensible	Identifier Type Codes
Location.identifier:facId.use	required	Fixed Value: official
Location.identifier:facId.type	extensible	Identifier Type Codes
Location.identifier:dormant.use	required	Fixed Value: old
Location.identifier:dormant.type	extensible	Identifier Type Codes
Location.identifier:legacyFacId.use	required	Fixed Value: official
Location.identifier:legacyFacId.type	extensible	Identifier Type Codes
Location.status	required	LocationStatus
Location.alias.extension:alias-type.value[x]:valueCodeableConcept	preferred	Hpi_location_alias_type
Location.type	required	Hpi_location_type
Location.telecom.system	required	ContactPointSystem
Location.telecom.use	required	Hpi_ContactPointUse
Location.address.use	required	Hpi_location_address_use
Location.address.type	required	AddressType
Location.hoursOfOperation.daysOfWeek	required	DaysOfWeek

IG © 2020+ Ministry of Health. Package hl7.org.nz.fhir.ig.hpi#0.9.0 based on FHIR 4.0.1. Generated 2021-12-03
Links: Table of Contents | QA Report