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
Defining URL: | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel |
Version: | 0.9.0 |
Name: | FacilityModel |
Title: | A facility involved in healthcare |
Status: | Active as of 12/3/21, 2:22 AM |
Definition: | An actual physical location. Represented by a Location model in FHIR |
Publisher: | Ministry of Health |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Element
This structure is derived from Element
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FacilityModel | 0..* | Element | A facility involved in healthcare | |
name | 1..1 | string | The name of the facility | |
description | 0..1 | string | A longer description of the facility | |
alias | 0..* | BackboneElement | Other names by which this facility is known | |
name | 1..1 | string | The alternative name | |
type | 0..1 | CodeableConcept | The type of alias - eg locally used name Binding: All the possible alias types (required) | |
hpiFacilityId | 1..1 | Identifier | The identifier assigned by the HPI to this facility | |
dormantFacilityId | 0..* | Identifier | Previously assigned identifiers, no longer used | |
otherIdentifiers | 0..* | Identifier | Other identifiers that may have been assigned | |
status | 1..1 | code | The current status of this facility | |
typeOfFunction | 0..1 | CodeableConcept | The kinds of function that can be performed at this facility | |
contactDetails | 0..* | ContactPoint | How to contact the facility (by a human) | |
electronicContactDetails | 0..* | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/EndpointModel | Technical contacts | |
address | 0..1 | Address | Where the facility is located | |
managingOrganization | 0..1 | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel | The organization responsible for this facility | |
partOf | 0..1 | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel | If this facility is part of a larger one (eg a ward in a hospital | |
established | 0..1 | Period | The period over which the facility has been / is in operation | |
dhb | 0..1 | CodeableConcept | The DHB whose catchment area this facility is in Binding: District Health Board Identifer (required) | |
geocode | 0..1 | BackboneElement | The geocode for this facility. Uses the NZ datum (reference point) | |
latitude | 0..1 | decimal | Latitude | |
longitude | 0..1 | decimal | Longitude | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FacilityModel | 0..* | Element | A facility involved in healthcare | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
name | 1..1 | string | The name of the facility | |
description | 0..1 | string | A longer description of the facility | |
alias | 0..* | BackboneElement | Other names by which this facility is known | |
name | 1..1 | string | The alternative name | |
type | 0..1 | CodeableConcept | The type of alias - eg locally used name Binding: All the possible alias types (required) | |
hpiFacilityId | 1..1 | Identifier | The identifier assigned by the HPI to this facility | |
dormantFacilityId | 0..* | Identifier | Previously assigned identifiers, no longer used | |
otherIdentifiers | 0..* | Identifier | Other identifiers that may have been assigned | |
status | 1..1 | code | The current status of this facility | |
typeOfFunction | 0..1 | CodeableConcept | The kinds of function that can be performed at this facility | |
contactDetails | 0..* | ContactPoint | How to contact the facility (by a human) | |
electronicContactDetails | 0..* | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/EndpointModel | Technical contacts | |
address | 0..1 | Address | Where the facility is located | |
managingOrganization | 0..1 | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel | The organization responsible for this facility | |
partOf | 0..1 | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel | If this facility is part of a larger one (eg a ward in a hospital | |
established | 0..1 | Period | The period over which the facility has been / is in operation | |
dhb | 0..1 | CodeableConcept | The DHB whose catchment area this facility is in Binding: District Health Board Identifer (required) | |
geocode | 0..1 | BackboneElement | The geocode for this facility. Uses the NZ datum (reference point) | |
latitude | 0..1 | decimal | Latitude | |
longitude | 0..1 | decimal | Longitude | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FacilityModel | 0..* | Element | A facility involved in healthcare | |
Documentation for this format |
This structure is derived from Element
Differential View
This structure is derived from Element
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FacilityModel | 0..* | Element | A facility involved in healthcare | |
name | 1..1 | string | The name of the facility | |
description | 0..1 | string | A longer description of the facility | |
alias | 0..* | BackboneElement | Other names by which this facility is known | |
name | 1..1 | string | The alternative name | |
type | 0..1 | CodeableConcept | The type of alias - eg locally used name Binding: All the possible alias types (required) | |
hpiFacilityId | 1..1 | Identifier | The identifier assigned by the HPI to this facility | |
dormantFacilityId | 0..* | Identifier | Previously assigned identifiers, no longer used | |
otherIdentifiers | 0..* | Identifier | Other identifiers that may have been assigned | |
status | 1..1 | code | The current status of this facility | |
typeOfFunction | 0..1 | CodeableConcept | The kinds of function that can be performed at this facility | |
contactDetails | 0..* | ContactPoint | How to contact the facility (by a human) | |
electronicContactDetails | 0..* | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/EndpointModel | Technical contacts | |
address | 0..1 | Address | Where the facility is located | |
managingOrganization | 0..1 | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel | The organization responsible for this facility | |
partOf | 0..1 | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel | If this facility is part of a larger one (eg a ward in a hospital | |
established | 0..1 | Period | The period over which the facility has been / is in operation | |
dhb | 0..1 | CodeableConcept | The DHB whose catchment area this facility is in Binding: District Health Board Identifer (required) | |
geocode | 0..1 | BackboneElement | The geocode for this facility. Uses the NZ datum (reference point) | |
latitude | 0..1 | decimal | Latitude | |
longitude | 0..1 | decimal | Longitude | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FacilityModel | 0..* | Element | A facility involved in healthcare | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
name | 1..1 | string | The name of the facility | |
description | 0..1 | string | A longer description of the facility | |
alias | 0..* | BackboneElement | Other names by which this facility is known | |
name | 1..1 | string | The alternative name | |
type | 0..1 | CodeableConcept | The type of alias - eg locally used name Binding: All the possible alias types (required) | |
hpiFacilityId | 1..1 | Identifier | The identifier assigned by the HPI to this facility | |
dormantFacilityId | 0..* | Identifier | Previously assigned identifiers, no longer used | |
otherIdentifiers | 0..* | Identifier | Other identifiers that may have been assigned | |
status | 1..1 | code | The current status of this facility | |
typeOfFunction | 0..1 | CodeableConcept | The kinds of function that can be performed at this facility | |
contactDetails | 0..* | ContactPoint | How to contact the facility (by a human) | |
electronicContactDetails | 0..* | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/EndpointModel | Technical contacts | |
address | 0..1 | Address | Where the facility is located | |
managingOrganization | 0..1 | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel | The organization responsible for this facility | |
partOf | 0..1 | http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel | If this facility is part of a larger one (eg a ward in a hospital | |
established | 0..1 | Period | The period over which the facility has been / is in operation | |
dhb | 0..1 | CodeableConcept | The DHB whose catchment area this facility is in Binding: District Health Board Identifer (required) | |
geocode | 0..1 | BackboneElement | The geocode for this facility. Uses the NZ datum (reference point) | |
latitude | 0..1 | decimal | Latitude | |
longitude | 0..1 | decimal | Longitude | |
Documentation for this format |
Other representations of profile: CSV, Excel
Path | Conformance | ValueSet |
FacilityModel.alias.type | required | AliasType |
FacilityModel.dhb | required | DHB |