New Zealand HPI Implementation Guide
0.2.0 - CI Build

New Zealand HPI Implementation Guide, published by David Hay. 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/hpi/ and changes regularly. See the Directory of published versions

Logical Model: FacilityModel - Detailed Descriptions

Definitions for the FacilityModel logical model.

1. FacilityModel
Definition

An actual physical location. Represented by a Location model in FHIR

Control0..* This element is affected by the following invariants: ele-1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. FacilityModel.id
Definition

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

Control0..1
Typestring
3. FacilityModel.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-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 FacilityModel.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. FacilityModel.name
Definition

The name of the facility

Control1..1
Typestring
5. FacilityModel.description
Definition

A longer description of the facility

Control0..1
Typestring
6. FacilityModel.alias
Definition

Other names by which this facility is known

Control0..*
TypeBackboneElement
7. FacilityModel.alias.name
Definition

The alternative name

Control1..1
Typestring
8. FacilityModel.alias.type
Definition

The type of alias - eg locally used name

Control0..1
BindingThe codes SHALL be taken from All the possible alias types
TypeCodeableConcept
9. FacilityModel.hpiFacilityId
Definition

The identifier assigned by the HPI to this facility

Control1..1
TypeIdentifier
10. FacilityModel.dormantFacilityId
Definition

Previously assigned identifiers, no longer used

Control0..*
TypeIdentifier
11. FacilityModel.otherIdentifiers
Definition

Other identifiers that may have been assigned

Control0..*
TypeIdentifier
12. FacilityModel.status
Definition

The current status of this facility

Control1..1
Typecode
13. FacilityModel.typeOfFunction
Definition

The kinds of function that can be performed at this facility

Control0..1
TypeCodeableConcept
14. FacilityModel.contactDetails
Definition

How to contact the facility (by a human)

Control0..*
TypeContactPoint
15. FacilityModel.electronicContactDetails
Definition

Technical contacts

Control0..*
Typehttp://hl7.org.nz/fhir/ig/hpi/StructureDefinition/EndpointModel
16. FacilityModel.address
Definition

Where the facility is located

Control0..1
TypeAddress
17. FacilityModel.managingOrganization
Definition

The organization responsible for this facility

Control0..1
Typehttp://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel
18. FacilityModel.partOf
Definition

If this facility is part of a larger one (eg a ward in a hospital

Control0..1
Typehttp://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel
19. FacilityModel.established
Definition

The period over which the facility has been / is in operation

Control0..1
TypePeriod
20. FacilityModel.dhb
Definition

The DHB whose catchment area this facility is in

Control0..1
BindingThe codes SHALL be taken from District Health Board Identifer
TypeCodeableConcept
21. FacilityModel.geocode
Definition

The geocode for this facility. Uses the NZ datum (reference point)

Control0..1
TypeBackboneElement
22. FacilityModel.geocode.latitude
Definition

Latitude

Control0..1
Typedecimal
23. FacilityModel.geocode.longitude
Definition

Longitude

Control0..1
Typedecimal