Northern Region Implementation Guide
0.4.6 - CI Build

Northern Region Implementation Guide, published by healthAlliance. This guide is not an authorized publication; it is the continuous build for version 0.4.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/northernRegion/ and changes regularly. See the Directory of published versions

Resource Profile: Northern Region Location profile

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NorthernRegionLocation Version: 0.4.6
Active as of 2024-01-24 Realm: New Zealand flag Computable Name: NorthernRegionLocation

Represents Location data exposed through the Northern Region APIs.

Usage:

Formal Views of Profile Content

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

This structure is derived from Location

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... Slices for identifier 0..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:HpifacId S0..1IdentifierThe current Facility id for this location
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
.... identifier:MOHFacId S0..1IdentifierThe MOH (NZHIS) Legacy facility code)
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/legacy-tbd-id
... status 0..0
... operationalStatus 0..0
... address 0..1NzAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... physicalType 0..0
... position 0..0
... managingOrganization 0..0
... hoursOfOperation 0..0
... availabilityExceptions 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:HpifacId SΣ0..1IdentifierThe current Facility id for this location
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
.... identifier:MOHFacId SΣ0..1IdentifierThe MOH (NZHIS) Legacy facility code)
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/legacy-tbd-id

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.identifier:HpifacId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:MOHFacId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:HpifacId SΣ0..1IdentifierThe current Facility id for this location
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:MOHFacId SΣ0..1IdentifierThe MOH (NZHIS) Legacy facility code)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/legacy-tbd-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type Σ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom 0..*ContactPointContact details of the location
... address 0..1NzAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.identifier:HpifacId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:HpifacId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.identifier:MOHFacId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:MOHFacId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

This structure is derived from Location

Summary

Mandatory: 0 element (4 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 4 elements
Prohibited: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Location

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... Slices for identifier 0..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:HpifacId S0..1IdentifierThe current Facility id for this location
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
.... identifier:MOHFacId S0..1IdentifierThe MOH (NZHIS) Legacy facility code)
..... use 1..1codeusual | official | temp | secondary | old (If known)
Fixed Value: official
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/legacy-tbd-id
... status 0..0
... operationalStatus 0..0
... address 0..1NzAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... physicalType 0..0
... position 0..0
... managingOrganization 0..0
... hoursOfOperation 0..0
... availabilityExceptions 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:HpifacId SΣ0..1IdentifierThe current Facility id for this location
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
.... identifier:MOHFacId SΣ0..1IdentifierThe MOH (NZHIS) Legacy facility code)
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/legacy-tbd-id

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.identifier:HpifacId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:MOHFacId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:HpifacId SΣ0..1IdentifierThe current Facility id for this location
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:MOHFacId SΣ0..1IdentifierThe MOH (NZHIS) Legacy facility code)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Fixed Value: official
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/legacy-tbd-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type Σ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom 0..*ContactPointContact details of the location
... address 0..1NzAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.identifier:HpifacId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:HpifacId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.identifier:MOHFacId.userequiredFixed Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:MOHFacId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

This structure is derived from Location

Summary

Mandatory: 0 element (4 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 4 elements
Prohibited: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron