Northern Region Implementation Guide
0.2.0 - CI Build

Northern Region Implementation Guide, published by healthAlliance. This is not an authorized publication; it is the continuous build for version 0.2.0). 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: NrLocation

Represents Location data exposed through the Northern Region APIs. The profile extends the NZ Base profile

The official URL for this profile is:

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

Formal Views of Profile Content

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

This structure is derived from CommonLocation

Summary

Prohibited: 13 elements

This structure is derived from CommonLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*CommonLocationDetails and position information for a physical place
... status 0..0
... operationalStatus 0..0
... alias 0..0
... mode 0..0
... type 0..0
... address 0..0
... physicalType 0..0
... position 0..0
... managingOrganization 0..0
... partOf 0..0
... hoursOfOperation 0..0
... availabilityExceptions 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*CommonLocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:HpifacId SΣI0..1IdentifierThe current Facility id for this location
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:dormantHpiFacId SΣI0..*IdentifierOld facility id's that have been deprecated
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: old
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:MOHFacId SΣI0..1IdentifierThe MOH (NZHIS) Legacy facility code)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/legacy-tbd-id
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... name ΣI0..1stringName of the location as used by humans
... telecom I0..*ContactPointContact details of the location
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*CommonLocationDetails and position information for a physical place
... identifier:HpifacId ΣI0..1IdentifierThe current Facility id for this location
... identifier:dormantHpiFacId ΣI0..*IdentifierOld facility id's that have been deprecated
... identifier:MOHFacId ΣI0..1IdentifierThe MOH (NZHIS) Legacy facility code)

doco Documentation for this format

This structure is derived from CommonLocation

Summary

Prohibited: 13 elements

Differential View

This structure is derived from CommonLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*CommonLocationDetails and position information for a physical place
... status 0..0
... operationalStatus 0..0
... alias 0..0
... mode 0..0
... type 0..0
... address 0..0
... physicalType 0..0
... position 0..0
... managingOrganization 0..0
... partOf 0..0
... hoursOfOperation 0..0
... availabilityExceptions 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*CommonLocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Unique code or number identifying the location to its users
Slice: Unordered, Open by value:use, value:system
.... identifier:HpifacId SΣI0..1IdentifierThe current Facility id for this location
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:dormantHpiFacId SΣI0..*IdentifierOld facility id's that have been deprecated
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: old
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:MOHFacId SΣI0..1IdentifierThe MOH (NZHIS) Legacy facility code)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/legacy-tbd-id
..... value ΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... name ΣI0..1stringName of the location as used by humans
... telecom I0..*ContactPointContact details of the location
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Location.languagepreferredCommonLanguages
Max Binding: AllLanguages
Location.identifier:HpifacId.userequiredFixed Value: official
Location.identifier:HpifacId.typeextensibleIdentifier Type Codes
Location.identifier:dormantHpiFacId.userequiredFixed Value: old
Location.identifier:dormantHpiFacId.typeextensibleIdentifier Type Codes
Location.identifier:MOHFacId.userequiredFixed Value: official
Location.identifier:MOHFacId.typeextensibleIdentifier Type Codes
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

Constraints

IdPathDetailsRequirements