New Zealand HPI Implementation Guide
1.5.0 - Release

New Zealand HPI Implementation Guide - Local Development build (v1.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: HpiLocation - Detailed Descriptions

Active as of 2024-10-25

Definitions for the HpiLocation resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Location
2. Location.extension:dhb
Slice Namedhb
ShortThe identifier for the DHB that is associated with this location
4. Location.extension:established
Slice Nameestablished
ShortThe date when this location first became available for use
6. Location.extension:funded-programme
Slice Namefunded-programme
Control0..0
8. Location.extension:pho
Slice Namepho
Control0..0
10. Location.extension:messaging-address
Slice Namemessaging-address
Control0..1
TypeExtension(Messaging Address) (Complex Extension)
12. Location.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..?
SlicingThis element introduces a set of slices on Location.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ use
  • value @ system
  • 14. Location.identifier.use
    Shortofficial | old
    BindingThe codes SHALL be taken from IdentifierUse
    (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code)
    16. Location.identifier.type
    Control0..0
    18. Location.identifier.period
    Control0..0
    20. Location.identifier:facId
    Slice NamefacId
    ShortThe current Facility id for this location
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..1
    Must Supporttrue
    22. Location.identifier:facId.use
    Shortfixed to official
    Control1..?
    Fixed Valueofficial
    24. Location.identifier:facId.system
    Control1..?
    Fixed Valuehttps://standards.digital.health.nz/ns/hpi-facility-id
    26. Location.identifier:facId.assigner
    TypeReference(HPI Organization)
    28. Location.identifier:dormant
    Slice Namedormant
    ShortOld facility id's that have been deprecated
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    Must Supporttrue
    30. Location.identifier:dormant.use
    Shortfixed to old
    Control1..?
    Fixed Valueold
    32. Location.identifier:dormant.system
    Control1..?
    Fixed Valuehttps://standards.digital.health.nz/ns/hpi-facility-id
    34. Location.identifier:dormant.assigner
    TypeReference(HPI Organization)
    36. Location.identifier:legacyFacId
    Slice NamelegacyFacId
    ShortThe MOH (NZHIS) Legacy facility code)
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    38. Location.identifier:legacyFacId.use
    Shortfixed to official
    Control1..?
    Fixed Valueofficial
    40. Location.identifier:legacyFacId.system
    Control1..?
    Fixed Valuehttps://standards.digital.health.nz/ns/nzhis-facility-id
    42. Location.identifier:legacyFacId.assigner
    TypeReference(HPI Organization)
    44. Location.status
    Shortactive | inactive
    BindingThe codes SHALL be taken from HPI Location Status
    (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-status-code)
    46. Location.operationalStatus
    Control0..0
    48. Location.alias
    50. Location.alias.extension:alias-type
    Slice Namealias-type
    ShortThe type of alias this is - eg its Maori name
    52. Location.alias.extension:alias-type.value[x]:valueCodeableConcept
    Slice NamevalueCodeableConcept
    BindingThe codes SHOULD be taken from HPI Alias Type (Location)
    (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/location-alias-type-code)
    TypeCodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    54. Location.mode
    Control0..0
    56. Location.type
    BindingThe codes SHALL be taken from HPI Location Type
    (required to https://nzhts.digital.health.nz/fhir/ValueSet/location-type-code)
    58. Location.telecom
    60. Location.telecom.use
    Shortwork | temp - purpose of this contact point
    BindingThe codes SHALL be taken from Use values for a ContactPoint
    (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code)
    62. Location.address
    TypeAddress(Common NZ Address datatype)
    64. Location.address.use
    Shortwork | old - purpose of this address
    BindingThe codes SHALL be taken from Address Use for Location
    (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code)
    66. Location.address.country
    BindingThe codes SHALL be taken from ISO 3166-1:2013 (2-alpha country code)
    (required to https://nzhts.digital.health.nz/fhir/ValueSet/country-code)
    68. Location.physicalType
    Control0..0
    70. Location.position
    Control0..0
    72. Location.managingOrganization
    TypeReference(HPI Organization)
    74. Location.partOf
    TypeReference(HPI Location)
    76. Location.hoursOfOperation
    Control0..0
    78. Location.availabilityExceptions
    Control0..0
    80. Location.endpoint
    Control0..0

    Guidance on how to interpret the contents of this table can be found here

    0. Location
    Definition

    Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

    ShortDetails and position information for a physical place
    Control0..*
    Is Modifierfalse
    Summaryfalse
    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
    dom-6: A resource should have narrative for robust management (text.`div`.exists())
    2. Location.implicitRules
    Definition

    A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

    ShortA set of rules under which this content was created
    Comments

    Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

    Control0..1
    Typeuri
    Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    4. Location.extension:dhb
    Slice Namedhb
    Definition

    District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address).

    ShortThe identifier for the DHB that is associated with this location
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(District Health Board linked to a NZ Healthcare Service, Location or Patient) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    6. Location.extension:established
    Slice Nameestablished
    Definition

    The period over which the location or Organization is open

    ShortThe date when this location first became available for use
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Established) (Extension Type: Period)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Location.extension:funded-programme
    Slice Namefunded-programme
    Definition

    Funded NZ Healthcare Programmes

    ShortFunded Healthcare Programme
    Control0..0
    This element is affected by the following invariants: ele-1
    TypeExtension(Funded Healthcare Programme) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Location.extension:pho
    Slice Namepho
    Definition

    Primary Healthcare Organisation associated with a General Practice linked to a NZ Healthcare Service, Location (Facility) or Patient (GP).

    ShortPrimary Healthcare Organisation
    Control0..0
    This element is affected by the following invariants: ele-1
    TypeExtension(Primary Healthcare Organisation) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Location.extension:messaging-address
    Slice Namemessaging-address
    Definition

    The address to where electronic communications might be sent. For historical reasons, there is an overlap with edi-address.

    ShortMessaging Address
    Control0..1
    TypeExtension(Messaging Address) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. Location.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. Location.identifier
    Definition

    Unique code or number identifying the location to its users.

    ShortUnique code or number identifying the location to its users
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control10..*
    TypeIdentifier
    Is Modifierfalse
    Summarytrue
    Requirements

    Organization label locations in registries, need to keep track of those.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Location.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ use
    • value @ system
    • 18. Location.identifier.use
      Definition

      The purpose of this identifier.

      Shortofficial | oldusual | official | temp | secondary | old (If known)
      Comments

      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

      Control0..1
      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
      (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code)
      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Location.identifier.type
      Definition

      A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

      ShortDescription of identifier
      Comments

      This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

      Control0..01
      BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
      (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

      A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Requirements

      Allows users to make use of identifiers when the identifier system is not known.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. Location.identifier.period
      Definition

      Time period during which identifier is/was valid for use.

      ShortTime period when id is/was valid for use
      Control0..01
      TypePeriod
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. Location.identifier:facId
      Slice NamefacId
      Definition

      Unique code or number identifying the location to its users.

      ShortThe current Facility id for this locationUnique code or number identifying the location to its users
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control10..1*
      TypeIdentifier
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Organization label locations in registries, need to keep track of those.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. Location.identifier:facId.use
      Definition

      The purpose of this identifier.

      Shortfixed to officialusual | official | temp | secondary | old (If known)
      Comments

      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

      Control10..1
      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

      Identifies the purpose for this identifier, if known .

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

      Fixed Valueofficial
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. Location.identifier:facId.system
      Definition

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

      ShortThe namespace for the identifier value
      Comments

      Identifier.system is always case sensitive.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

      Fixed Valuehttps://standards.digital.health.nz/ns/hpi-facility-id
      Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. Location.identifier:facId.assigner
      Definition

      Organization that issued/manages the identifier.

      ShortOrganization that issued id (may be just text)
      Comments

      The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

      Control0..1
      TypeReference(HPI Organization, Organization)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. Location.identifier:dormant
      Slice Namedormant
      Definition

      Unique code or number identifying the location to its users.

      ShortOld facility id's that have been deprecatedUnique code or number identifying the location to its users
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Organization label locations in registries, need to keep track of those.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      34. Location.identifier:dormant.use
      Definition

      The purpose of this identifier.

      Shortfixed to oldusual | official | temp | secondary | old (If known)
      Comments

      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

      Control10..1
      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

      Identifies the purpose for this identifier, if known .

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

      Fixed Valueold
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. Location.identifier:dormant.system
      Definition

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

      ShortThe namespace for the identifier value
      Comments

      Identifier.system is always case sensitive.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

      Fixed Valuehttps://standards.digital.health.nz/ns/hpi-facility-id
      Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. Location.identifier:dormant.assigner
      Definition

      Organization that issued/manages the identifier.

      ShortOrganization that issued id (may be just text)
      Comments

      The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

      Control0..1
      TypeReference(HPI Organization, Organization)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      40. Location.identifier:legacyFacId
      Slice NamelegacyFacId
      Definition

      Unique code or number identifying the location to its users.

      ShortThe MOH (NZHIS) Legacy facility code)Unique code or number identifying the location to its users
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1*
      TypeIdentifier
      Is Modifierfalse
      Summarytrue
      Requirements

      Organization label locations in registries, need to keep track of those.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      42. Location.identifier:legacyFacId.use
      Definition

      The purpose of this identifier.

      Shortfixed to officialusual | official | temp | secondary | old (If known)
      Comments

      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

      Control10..1
      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

      Identifies the purpose for this identifier, if known .

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

      Fixed Valueofficial
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. Location.identifier:legacyFacId.system
      Definition

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

      ShortThe namespace for the identifier value
      Comments

      Identifier.system is always case sensitive.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

      Fixed Valuehttps://standards.digital.health.nz/ns/nzhis-facility-id
      Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      46. Location.identifier:legacyFacId.assigner
      Definition

      Organization that issued/manages the identifier.

      ShortOrganization that issued id (may be just text)
      Comments

      The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

      Control0..1
      TypeReference(HPI Organization, Organization)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      48. Location.status
      Definition

      The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

      Shortactive | inactiveactive | suspended | inactive
      Control0..1
      BindingThe codes SHALL be taken from HPI Location Statushttp://hl7.org/fhir/ValueSet/location-status|4.0.1
      (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-status-code)
      Typecode
      Is Modifiertrue because This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      50. Location.operationalStatus
      Definition

      The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.

      ShortThe operational status of the location (typically only for a bed/room)
      Control0..01
      BindingThe codes SHOULD be taken from hl7VS-bedStatushttp://terminology.hl7.org/ValueSet/v2-0116
      (preferred to http://terminology.hl7.org/ValueSet/v2-0116)

      The operational status if the location (where typically a bed/room).

      TypeCoding
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      52. Location.mode
      Definition

      Indicates whether a resource instance represents a specific location or a class of locations.

      Shortinstance | kind
      Comments

      This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.

      Control0..01
      BindingThe codes SHALL be taken from LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1
      (required to http://hl7.org/fhir/ValueSet/location-mode|4.0.1)

      Indicates whether a resource instance represents a specific location or a class of locations.

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      54. Location.type
      Definition

      Indicates the type of function performed at the location.

      ShortType of function performed
      Control0..*
      BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from HPI Location Typehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
      (required to https://nzhts.digital.health.nz/fhir/ValueSet/location-type-code)
      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      56. Location.address
      Definition

      An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.


      Physical location.

      ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)Physical location
      Comments

      Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).


      Additional addresses should be recorded using another instance of the Location resource, or via the Organization.

      Control0..1
      This element is affected by the following invariants: ele-1
      TypeAddress(Common NZ Address datatype)
      Is Modifierfalse
      Requirements

      If locations can be visited, we need to keep track of their address.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      58. Location.address.extension:nz-geocode
      Slice Namenz-geocode
      Definition

      New Zealand Geocode. This uses a different datum from that defined in the HL7 FHIR specification for a Geocode.

      ShortA geocode using the NZ specific datum (reference point)
      Control0..1
      TypeExtension(NZ Geocode) (Complex Extension)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      60. Location.address.extension:suburb
      Slice Namesuburb
      Definition

      Suburb element of a NZ Address.

      ShortThe suburb part of the address
      Control0..1
      TypeExtension(NZ Suburb) (Extension Type: string)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      62. Location.address.extension:building-name
      Slice Namebuilding-name
      Definition

      The name of a building cited in an address.

      ShortThe name of the building
      Control0..1
      TypeExtension(Building Name) (Extension Type: string)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      64. Location.address.extension:domicile-code
      Slice Namedomicile-code
      Definition

      NZ Domicile Code. Derived from a patient's primary physical, home address.

      ShortThe domicile code associated with this address
      Control0..1
      TypeExtension(NZ Domicile Code) (Extension Type: CodeableConcept)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      66. Location.address.use
      Definition

      The purpose of this address.

      Shortwork | old - purpose of this addresshome | work | temp | old | billing - purpose of this address
      Comments

      Applications can assume that an address is current unless it explicitly says that it is temporary or old.

      Control0..1
      BindingThe codes SHALL be taken from Address Use for Locationhttp://hl7.org/fhir/ValueSet/address-use|4.0.1
      (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code)
      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows an appropriate address to be chosen from a list of many.

      Example<br/><b>General</b>:home
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      68. Location.address.country
      Definition

      Country - a nation as commonly understood or generally accepted.

      ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
      Comments

      ISO 3166 3 letter codes can be used in place of a human readable country name.

      Control0..1
      BindingThe codes SHALL be taken from For codes, see ISO 3166-1:2013 (2-alpha country code)
      (required to https://nzhts.digital.health.nz/fhir/ValueSet/country-code)
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      70. Location.physicalType
      Definition

      Physical form of the location, e.g. building, room, vehicle, road.

      ShortPhysical form of the location
      Control0..01
      BindingFor example codes, see LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type
      (example to http://hl7.org/fhir/ValueSet/location-physical-type)

      Physical form of the location.

      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Requirements

      For purposes of showing relevant locations in queries, we need to categorize locations.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      72. Location.position
      Definition

      The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

      ShortThe absolute geographic location
      Control0..01
      TypeBackboneElement
      Is Modifierfalse
      Summaryfalse
      Requirements

      For mobile applications and automated route-finding knowing the exact location of the Location is required.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      77. Location.managingOrganization
      Definition

      The organization responsible for the provisioning and upkeep of the location.

      ShortOrganization responsible for provisioning and upkeep
      Comments

      This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.

      Control0..1
      TypeReference(HPI Organization, Organization)
      Is Modifierfalse
      Summarytrue
      Requirements

      Need to know who manages the location.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      79. Location.partOf
      Definition

      Another Location of which this Location is physically a part of.

      ShortAnother Location this one is physically a part of
      Control0..1
      TypeReference(HPI Location, Location)
      Is Modifierfalse
      Summaryfalse
      Requirements

      For purposes of location, display and identification, knowing which locations are located within other locations is important.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      81. Location.hoursOfOperation
      Definition

      What days/times during a week is this location usually open.

      ShortWhat days/times during a week is this location usually open
      Comments

      This type of information is commonly found published in directories and on websites informing customers when the facility is available.

      Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours.

      Control0..0*
      TypeBackboneElement
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      84. Location.availabilityExceptions
      Definition

      A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.

      ShortDescription of availability exceptions
      Control0..01
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      86. Location.endpoint
      Definition

      Technical endpoints providing access to services operated for the location.

      ShortTechnical endpoints providing access to services operated for the location
      Control0..0*
      TypeReference(Endpoint)
      Is Modifierfalse
      Summaryfalse
      Requirements

      Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be found here

      0. Location
      Definition

      Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

      ShortDetails and position information for a physical place
      Control0..*
      Is Modifierfalse
      Summaryfalse
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      2. Location.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical id of this artifact
      Comments

      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

      Control0..1
      Typeid
      Is Modifierfalse
      Summarytrue
      4. Location.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. Location.implicitRules
      Definition

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

      Control0..1
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. Location.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

      Control0..1
      BindingThe codes SHOULD be taken from CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. Location.text
      Definition

      A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

      ShortText summary of the resource, for human interpretation
      Comments

      Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

      Control0..1
      TypeNarrative
      Is Modifierfalse
      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. Location.contained
      Definition

      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

      ShortContained, inline Resources
      Comments

      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

      Control0..*
      TypeResource
      Is Modifierfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      14. Location.extension
      Definition

      An Extension

      ShortExtension
      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on Location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. Location.extension:dhb
        Slice Namedhb
        Definition

        District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address).

        ShortThe identifier for the DHB that is associated with this location
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(District Health Board linked to a NZ Healthcare Service, Location or Patient) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. Location.extension:established
        Slice Nameestablished
        Definition

        The period over which the location or Organization is open

        ShortThe date when this location first became available for use
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Established) (Extension Type: Period)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        20. Location.extension:funded-programme
        Slice Namefunded-programme
        Definition

        Funded NZ Healthcare Programmes

        ShortFunded Healthcare Programme
        Control0..0
        This element is affected by the following invariants: ele-1
        TypeExtension(Funded Healthcare Programme) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        22. Location.extension:pho
        Slice Namepho
        Definition

        Primary Healthcare Organisation associated with a General Practice linked to a NZ Healthcare Service, Location (Facility) or Patient (GP).

        ShortPrimary Healthcare Organisation
        Control0..0
        This element is affected by the following invariants: ele-1
        TypeExtension(Primary Healthcare Organisation) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        24. Location.extension:messaging-address
        Slice Namemessaging-address
        Definition

        The address to where electronic communications might be sent. For historical reasons, there is an overlap with edi-address.

        ShortMessaging Address
        Control0..1
        TypeExtension(Messaging Address) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        26. Location.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Summaryfalse
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        28. Location.identifier
        Definition

        Unique code or number identifying the location to its users.

        ShortUnique code or number identifying the location to its users
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control1..*
        TypeIdentifier
        Is Modifierfalse
        Summarytrue
        Requirements

        Organization label locations in registries, need to keep track of those.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on Location.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ use
        • value @ system
        • 30. Location.identifier.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          32. Location.identifier.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Location.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 34. Location.identifier.use
            Definition

            The purpose of this identifier.

            Shortofficial | old
            Comments

            Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

            Control0..1
            BindingThe codes SHALL be taken from IdentifierUse
            (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code)
            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            36. Location.identifier.type
            Definition

            A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

            ShortDescription of identifier
            Comments

            This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

            Control0..0
            BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
            (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

            A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Requirements

            Allows users to make use of identifiers when the identifier system is not known.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            38. Location.identifier.system
            Definition

            Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

            ShortThe namespace for the identifier value
            Comments

            Identifier.system is always case sensitive.

            Control0..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

            Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            40. Location.identifier.value
            Definition

            The portion of the identifier typically relevant to the user and which is unique within the context of the system.

            ShortThe value that is unique
            Comments

            If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Example<br/><b>General</b>:123456
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            42. Location.identifier.period
            Definition

            Time period during which identifier is/was valid for use.

            ShortTime period when id is/was valid for use
            Control0..0
            TypePeriod
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            44. Location.identifier.assigner
            Definition

            Organization that issued/manages the identifier.

            ShortOrganization that issued id (may be just text)
            Comments

            The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

            Control0..1
            TypeReference(Organization)
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            46. Location.identifier:facId
            Slice NamefacId
            Definition

            Unique code or number identifying the location to its users.

            ShortThe current Facility id for this location
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control1..1
            TypeIdentifier
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Requirements

            Organization label locations in registries, need to keep track of those.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            48. Location.identifier:facId.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            50. Location.identifier:facId.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on Location.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 52. Location.identifier:facId.use
              Definition

              The purpose of this identifier.

              Shortfixed to official
              Comments

              Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

              Control1..1
              BindingThe codes SHALL be taken from IdentifierUse
              (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

              Identifies the purpose for this identifier, if known .

              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

              Fixed Valueofficial
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              54. Location.identifier:facId.type
              Definition

              A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

              ShortDescription of identifier
              Comments

              This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

              Control0..1
              BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
              (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

              A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

              TypeCodeableConcept
              Is Modifierfalse
              Summarytrue
              Requirements

              Allows users to make use of identifiers when the identifier system is not known.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              56. Location.identifier:facId.system
              Definition

              Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

              ShortThe namespace for the identifier value
              Comments

              Identifier.system is always case sensitive.

              Control1..1
              Typeuri
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

              Fixed Valuehttps://standards.digital.health.nz/ns/hpi-facility-id
              Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              58. Location.identifier:facId.value
              Definition

              The portion of the identifier typically relevant to the user and which is unique within the context of the system.

              ShortThe value that is unique
              Comments

              If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Example<br/><b>General</b>:123456
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              60. Location.identifier:facId.period
              Definition

              Time period during which identifier is/was valid for use.

              ShortTime period when id is/was valid for use
              Control0..1
              TypePeriod
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              62. Location.identifier:facId.assigner
              Definition

              Organization that issued/manages the identifier.

              ShortOrganization that issued id (may be just text)
              Comments

              The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

              Control0..1
              TypeReference(HPI Organization)
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              64. Location.identifier:dormant
              Slice Namedormant
              Definition

              Unique code or number identifying the location to its users.

              ShortOld facility id's that have been deprecated
              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..*
              TypeIdentifier
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Requirements

              Organization label locations in registries, need to keep track of those.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              66. Location.identifier:dormant.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              68. Location.identifier:dormant.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Location.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 70. Location.identifier:dormant.use
                Definition

                The purpose of this identifier.

                Shortfixed to old
                Comments

                Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                Control1..1
                BindingThe codes SHALL be taken from IdentifierUse
                (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                Identifies the purpose for this identifier, if known .

                Typecode
                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                Fixed Valueold
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                72. Location.identifier:dormant.type
                Definition

                A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                ShortDescription of identifier
                Comments

                This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                Control0..1
                BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                TypeCodeableConcept
                Is Modifierfalse
                Summarytrue
                Requirements

                Allows users to make use of identifiers when the identifier system is not known.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                74. Location.identifier:dormant.system
                Definition

                Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                ShortThe namespace for the identifier value
                Comments

                Identifier.system is always case sensitive.

                Control1..1
                Typeuri
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                Fixed Valuehttps://standards.digital.health.nz/ns/hpi-facility-id
                Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                76. Location.identifier:dormant.value
                Definition

                The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                ShortThe value that is unique
                Comments

                If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                Control0..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Example<br/><b>General</b>:123456
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                78. Location.identifier:dormant.period
                Definition

                Time period during which identifier is/was valid for use.

                ShortTime period when id is/was valid for use
                Control0..1
                TypePeriod
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                80. Location.identifier:dormant.assigner
                Definition

                Organization that issued/manages the identifier.

                ShortOrganization that issued id (may be just text)
                Comments

                The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                Control0..1
                TypeReference(HPI Organization)
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                82. Location.identifier:legacyFacId
                Slice NamelegacyFacId
                Definition

                Unique code or number identifying the location to its users.

                ShortThe MOH (NZHIS) Legacy facility code)
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..1
                TypeIdentifier
                Is Modifierfalse
                Summarytrue
                Requirements

                Organization label locations in registries, need to keep track of those.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                84. Location.identifier:legacyFacId.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                86. Location.identifier:legacyFacId.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Location.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 88. Location.identifier:legacyFacId.use
                  Definition

                  The purpose of this identifier.

                  Shortfixed to official
                  Comments

                  Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                  Control1..1
                  BindingThe codes SHALL be taken from IdentifierUse
                  (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                  Identifies the purpose for this identifier, if known .

                  Typecode
                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                  Fixed Valueofficial
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  90. Location.identifier:legacyFacId.type
                  Definition

                  A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                  ShortDescription of identifier
                  Comments

                  This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                  Control0..1
                  BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                  (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                  A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Allows users to make use of identifiers when the identifier system is not known.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  92. Location.identifier:legacyFacId.system
                  Definition

                  Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                  ShortThe namespace for the identifier value
                  Comments

                  Identifier.system is always case sensitive.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                  Fixed Valuehttps://standards.digital.health.nz/ns/nzhis-facility-id
                  Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  94. Location.identifier:legacyFacId.value
                  Definition

                  The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                  ShortThe value that is unique
                  Comments

                  If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Example<br/><b>General</b>:123456
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  96. Location.identifier:legacyFacId.period
                  Definition

                  Time period during which identifier is/was valid for use.

                  ShortTime period when id is/was valid for use
                  Control0..1
                  TypePeriod
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  98. Location.identifier:legacyFacId.assigner
                  Definition

                  Organization that issued/manages the identifier.

                  ShortOrganization that issued id (may be just text)
                  Comments

                  The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                  Control0..1
                  TypeReference(HPI Organization)
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  100. Location.status
                  Definition

                  The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

                  Shortactive | inactive
                  Control0..1
                  BindingThe codes SHALL be taken from HPI Location Status
                  (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-status-code)
                  Typecode
                  Is Modifiertrue because This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  102. Location.operationalStatus
                  Definition

                  The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.

                  ShortThe operational status of the location (typically only for a bed/room)
                  Control0..0
                  BindingThe codes SHOULD be taken from hl7VS-bedStatus
                  (preferred to http://terminology.hl7.org/ValueSet/v2-0116)

                  The operational status if the location (where typically a bed/room).

                  TypeCoding
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  104. Location.name
                  Definition

                  Name of the location as used by humans. Does not need to be unique.

                  ShortName of the location as used by humans
                  Comments

                  If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.

                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  106. Location.alias
                  Definition

                  A list of alternate names that the location is known as, or was known as, in the past.

                  ShortA list of alternate names that the location is known as, or was known as, in the past
                  Comments

                  There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.

                  Control0..*
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Requirements

                  Over time locations and organizations go through many changes and can be known by different names.

                  For searching knowing previous names that the location was known by can be very useful.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  108. Location.alias.id
                  Definition

                  unique id for the element within a resource (for internal references)

                  Shortxml:id (or equivalent in JSON)
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  110. Location.alias.extension
                  Definition

                  An Extension

                  ShortExtension
                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Location.alias.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 112. Location.alias.extension:alias-type
                    Slice Namealias-type
                    Definition

                    Used to indicate what sort of alias is being used in a Location or Organization - eg that it is a legal name.

                    ShortThe type of alias this is - eg its Maori name
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(AliasType) (Extension Type: CodeableConcept)
                    Is Modifierfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    114. Location.alias.extension:alias-type.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    116. Location.alias.extension:alias-type.extension
                    Definition

                    An Extension

                    ShortExtension
                    Control0..0
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Location.alias.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 118. Location.alias.extension:alias-type.url
                      Definition

                      Source of the definition for the extension code - a logical name or a URL.

                      Shortidentifies the meaning of the extension
                      Comments

                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                      Control1..1
                      Typeuri
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/alias-type
                      120. Location.alias.extension:alias-type.value[x]
                      Definition

                      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                      ShortValue of extension
                      Control0..1
                      TypeCodeableConcept
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on Location.alias.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                      • type @ $this
                      • 122. Location.alias.extension:alias-type.value[x]:valueCodeableConcept
                        Slice NamevalueCodeableConcept
                        Definition

                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                        ShortValue of extension
                        Control0..1
                        BindingThe codes SHOULD be taken from HPI Alias Type (Location)
                        (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/location-alias-type-code)
                        TypeCodeableConcept
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        124. Location.alias.value
                        Definition

                        The actual value

                        ShortPrimitive value for string
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        Max Length:1048576
                        126. Location.description
                        Definition

                        Description of the Location, which helps in finding or referencing the place.

                        ShortAdditional details about the location that could be displayed as further information to identify the location beyond its name
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        Humans need additional information to verify a correct location has been identified.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        128. Location.mode
                        Definition

                        Indicates whether a resource instance represents a specific location or a class of locations.

                        Shortinstance | kind
                        Comments

                        This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.

                        Control0..0
                        BindingThe codes SHALL be taken from LocationMode
                        (required to http://hl7.org/fhir/ValueSet/location-mode|4.0.1)

                        Indicates whether a resource instance represents a specific location or a class of locations.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        130. Location.type
                        Definition

                        Indicates the type of function performed at the location.

                        ShortType of function performed
                        Control0..*
                        BindingThe codes SHALL be taken from HPI Location Type
                        (required to https://nzhts.digital.health.nz/fhir/ValueSet/location-type-code)
                        TypeCodeableConcept
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        132. Location.telecom
                        Definition

                        The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

                        ShortContact details of the location
                        Control0..*
                        TypeContactPoint
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        134. Location.telecom.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        136. Location.telecom.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on Location.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 138. Location.telecom.system
                          Definition

                          Telecommunications form for contact point - what communications system is required to make use of the contact.

                          Shortphone | fax | email | pager | url | sms | other
                          Control0..1
                          This element is affected by the following invariants: cpt-2
                          BindingThe codes SHALL be taken from ContactPointSystem
                          (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                          Telecommunications form for contact point.

                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          140. Location.telecom.value
                          Definition

                          The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                          ShortThe actual contact point details
                          Comments

                          Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Need to support legacy numbers that are not in a tightly controlled format.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          142. Location.telecom.use
                          Definition

                          Identifies the purpose for the contact point.

                          Shortwork | temp - purpose of this contact point
                          Comments

                          Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                          Control0..1
                          BindingThe codes SHALL be taken from Use values for a ContactPoint
                          (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code)
                          Typecode
                          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          144. Location.telecom.rank
                          Definition

                          Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                          ShortSpecify preferred order of use (1 = highest)
                          Comments

                          Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                          Control0..1
                          TypepositiveInt
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          146. Location.telecom.period
                          Definition

                          Time period when the contact point was/is in use.

                          ShortTime period when the contact point was/is in use
                          Control0..1
                          TypePeriod
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          148. Location.address
                          Definition

                          An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

                          ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
                          Comments

                          Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

                          Control0..1
                          This element is affected by the following invariants: ele-1
                          TypeAddress(Common NZ Address datatype)
                          Is Modifierfalse
                          Requirements

                          If locations can be visited, we need to keep track of their address.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          150. Location.address.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          152. Location.address.extension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          ShortAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Location.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 154. Location.address.extension:nz-geocode
                            Slice Namenz-geocode
                            Definition

                            New Zealand Geocode. This uses a different datum from that defined in the HL7 FHIR specification for a Geocode.

                            ShortA geocode using the NZ specific datum (reference point)
                            Control0..1
                            TypeExtension(NZ Geocode) (Complex Extension)
                            Is Modifierfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            156. Location.address.extension:suburb
                            Slice Namesuburb
                            Definition

                            Suburb element of a NZ Address.

                            ShortThe suburb part of the address
                            Control0..1
                            TypeExtension(NZ Suburb) (Extension Type: string)
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            158. Location.address.extension:building-name
                            Slice Namebuilding-name
                            Definition

                            The name of a building cited in an address.

                            ShortThe name of the building
                            Control0..1
                            TypeExtension(Building Name) (Extension Type: string)
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            160. Location.address.extension:domicile-code
                            Slice Namedomicile-code
                            Definition

                            NZ Domicile Code. Derived from a patient's primary physical, home address.

                            ShortThe domicile code associated with this address
                            Control0..1
                            TypeExtension(NZ Domicile Code) (Extension Type: CodeableConcept)
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            162. Location.address.use
                            Definition

                            The purpose of this address.

                            Shortwork | old - purpose of this address
                            Comments

                            Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                            Control0..1
                            BindingThe codes SHALL be taken from Address Use for Location
                            (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code)
                            Typecode
                            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Allows an appropriate address to be chosen from a list of many.

                            Example<br/><b>General</b>:home
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            164. Location.address.type
                            Definition

                            Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                            Shortpostal | physical | both
                            Comments

                            The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

                            Control0..1
                            BindingThe codes SHALL be taken from AddressType
                            (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

                            The type of an address (physical / postal).

                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Example<br/><b>General</b>:both
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            166. Location.address.text
                            Definition

                            Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

                            ShortText representation of the address
                            Comments

                            Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            A renderable, unencoded form.

                            Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            168. Location.address.line
                            Definition

                            This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                            ShortStreet name, number, direction & P.O. Box etc.
                            Control0..*
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Example<br/><b>General</b>:137 Nowhere Street
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            170. Location.address.city
                            Definition

                            The name of the city, town, suburb, village or other community or delivery center.

                            ShortName of city, town etc.
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Alternate NamesMunicpality
                            Example<br/><b>General</b>:Erewhon
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            172. Location.address.district
                            Definition

                            The name of the administrative area (county).

                            ShortDistrict name (aka county)
                            Comments

                            District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Alternate NamesCounty
                            Example<br/><b>General</b>:Madison
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            174. Location.address.state
                            Definition

                            Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

                            ShortSub-unit of country (abbreviations ok)
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Alternate NamesProvince, Territory
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            176. Location.address.postalCode
                            Definition

                            A postal code designating a region defined by the postal service.

                            ShortPostal code for area
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Alternate NamesZip
                            Example<br/><b>General</b>:9132
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            178. Location.address.country
                            Definition

                            Country - a nation as commonly understood or generally accepted.

                            ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
                            Comments

                            ISO 3166 3 letter codes can be used in place of a human readable country name.

                            Control0..1
                            BindingThe codes SHALL be taken from ISO 3166-1:2013 (2-alpha country code)
                            (required to https://nzhts.digital.health.nz/fhir/ValueSet/country-code)
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            180. Location.address.period
                            Definition

                            Time period when address was/is in use.

                            ShortTime period when address was/is in use
                            Control0..1
                            TypePeriod
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            Allows addresses to be placed in historical context.

                            Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            182. Location.physicalType
                            Definition

                            Physical form of the location, e.g. building, room, vehicle, road.

                            ShortPhysical form of the location
                            Control0..0
                            BindingFor example codes, see LocationType
                            (example to http://hl7.org/fhir/ValueSet/location-physical-type)

                            Physical form of the location.

                            TypeCodeableConcept
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            For purposes of showing relevant locations in queries, we need to categorize locations.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            184. Location.position
                            Definition

                            The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

                            ShortThe absolute geographic location
                            Control0..0
                            TypeBackboneElement
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

                            For mobile applications and automated route-finding knowing the exact location of the Location is required.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            192. Location.managingOrganization
                            Definition

                            The organization responsible for the provisioning and upkeep of the location.

                            ShortOrganization responsible for provisioning and upkeep
                            Comments

                            This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.

                            Control0..1
                            TypeReference(HPI Organization)
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            Need to know who manages the location.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            194. Location.partOf
                            Definition

                            Another Location of which this Location is physically a part of.

                            ShortAnother Location this one is physically a part of
                            Control0..1
                            TypeReference(HPI Location)
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

                            For purposes of location, display and identification, knowing which locations are located within other locations is important.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            196. Location.hoursOfOperation
                            Definition

                            What days/times during a week is this location usually open.

                            ShortWhat days/times during a week is this location usually open
                            Comments

                            This type of information is commonly found published in directories and on websites informing customers when the facility is available.

                            Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours.

                            Control0..0
                            TypeBackboneElement
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            205. Location.availabilityExceptions
                            Definition

                            A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.

                            ShortDescription of availability exceptions
                            Control0..0
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            207. Location.endpoint
                            Definition

                            Technical endpoints providing access to services operated for the location.

                            ShortTechnical endpoints providing access to services operated for the location
                            Control0..0
                            TypeReference(Endpoint)
                            Is Modifierfalse
                            Summaryfalse
                            Requirements

                            Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))