New Zealand HPI Implementation Guide
0.9.0 - CI Build
New Zealand HPI Implementation Guide, published by Ministry of Health. This is not an authorized publication; it is the continuous build for version 0.9.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions
Definitions for the FacilityModel logical model.
1. FacilityModel | |
Definition | An actual physical location. Represented by a Location model in FHIR |
Control | 0..* This element is affected by the following invariants: ele-1 |
Invariants | Defined 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. |
Control | 0..1 |
Type | string |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, 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. |
Invariants | Defined 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()) |
Slicing | This element introduces a set of slices on FacilityModel.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. FacilityModel.name | |
Definition | The name of the facility |
Control | 1..1 |
Type | string |
5. FacilityModel.description | |
Definition | A longer description of the facility |
Control | 0..1 |
Type | string |
6. FacilityModel.alias | |
Definition | Other names by which this facility is known |
Control | 0..* |
Type | BackboneElement |
7. FacilityModel.alias.name | |
Definition | The alternative name |
Control | 1..1 |
Type | string |
8. FacilityModel.alias.type | |
Definition | The type of alias - eg locally used name |
Control | 0..1 |
Binding | The codes SHALL be taken from All the possible alias types |
Type | CodeableConcept |
9. FacilityModel.hpiFacilityId | |
Definition | The identifier assigned by the HPI to this facility |
Control | 1..1 |
Type | Identifier |
10. FacilityModel.dormantFacilityId | |
Definition | Previously assigned identifiers, no longer used |
Control | 0..* |
Type | Identifier |
11. FacilityModel.otherIdentifiers | |
Definition | Other identifiers that may have been assigned |
Control | 0..* |
Type | Identifier |
12. FacilityModel.status | |
Definition | The current status of this facility |
Control | 1..1 |
Type | code |
13. FacilityModel.typeOfFunction | |
Definition | The kinds of function that can be performed at this facility |
Control | 0..1 |
Type | CodeableConcept |
14. FacilityModel.contactDetails | |
Definition | How to contact the facility (by a human) |
Control | 0..* |
Type | ContactPoint |
15. FacilityModel.electronicContactDetails | |
Definition | Technical contacts |
Control | 0..* |
Type | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/EndpointModel |
16. FacilityModel.address | |
Definition | Where the facility is located |
Control | 0..1 |
Type | Address |
17. FacilityModel.managingOrganization | |
Definition | The organization responsible for this facility |
Control | 0..1 |
Type | http://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 |
Control | 0..1 |
Type | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel |
19. FacilityModel.established | |
Definition | The period over which the facility has been / is in operation |
Control | 0..1 |
Type | Period |
20. FacilityModel.dhb | |
Definition | The DHB whose catchment area this facility is in |
Control | 0..1 |
Binding | The codes SHALL be taken from District Health Board Identifer |
Type | CodeableConcept |
21. FacilityModel.geocode | |
Definition | The geocode for this facility. Uses the NZ datum (reference point) |
Control | 0..1 |
Type | BackboneElement |
22. FacilityModel.geocode.latitude | |
Definition | Latitude |
Control | 0..1 |
Type | decimal |
23. FacilityModel.geocode.longitude | |
Definition | Longitude |
Control | 0..1 |
Type | decimal |