Name Flags Card. Type Description & Constraints doco
. . 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

doco Documentation for this format
<status value="active" /> <date value="2022-04-12T04:02:48+00:00" /> <publisher value="Ministry of Health" /> <contact> <name value="Ministry of Health" /> <telecom> <system value="email" /> <value value="mailto:integration@health.govt.nz" /> </telecom> </contact> <description value="An actual physical location. Represented by a Location model in FHIR" /> <fhirVersion value="4.0.1" /> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <kind value="logical" /> <abstract value="false" /> <type value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element" /> <derivation value="specialization" /> <snapshot> <element id="FacilityModel"> <path value="FacilityModel" /> <short value="A facility involved in healthcare" /> <definition value="An actual physical location. Represented by a Location model in FHIR" /> <min value="0" /> <max value="*" /> <base> <path value="Element" /> <min value="0" /> <max value="*" /> </base> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="FacilityModel.id"> <path value="FacilityModel.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="FacilityModel.extension"> <path value="FacilityModel.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional content defined by implementations" /> <definition value="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." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="FacilityModel.name"> <path value="FacilityModel.name" /> <short value="The name of the facility" /> <definition value="The name of the facility" /> <min value="1" /> <max value="1" /> <base> <path value="FacilityModel.name" /> <min value="1" /> <max value="1" /> </base> <type> <code value="string" /> </type> </element> <element id="FacilityModel.description"> <path value="FacilityModel.description" /> <short value="A longer description of the facility" /> <definition value="A longer description of the facility" /> <min value="0" /> <max value="1" /> <base> <path value="FacilityModel.description" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> </element> <element id="FacilityModel.alias"> <path value="FacilityModel.alias" /> <short value="Other names by which this facility is known" /> <definition value="Other names by which this facility is known" /> <min value="0" /> <max value="*" /> <base> <path value="FacilityModel.alias" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> </element> <element id="FacilityModel.alias.name"> <path value="FacilityModel.alias.name" /> <short value="The alternative name" /> <definition value="The alternative name" /> <min value="1" /> <max value="1" /> <base> <path value="FacilityModel.alias.name" /> <min value="1" /> <max value="1" /> </base> <type> <code value="string" /> </type> </element> <element id="FacilityModel.alias.type"> <path value="FacilityModel.alias.type" /> <short value="The type of alias - eg locally used name" /> <definition value="The type of alias - eg locally used name" /> <min value="0" /> <max value="1" /> <base> <path value="FacilityModel.alias.type" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://nzhts.digital.health.nz/fhir/ValueSet/alias-type-code" /> </binding> </element> <element id="FacilityModel.hpiFacilityId"> <path value="FacilityModel.hpiFacilityId" /> <short value="The identifier assigned by the HPI to this facility" /> <definition value="The identifier assigned by the HPI to this facility" /> <min value="1" /> <max value="1" /> <base> <path value="FacilityModel.hpiFacilityId" /> <min value="1" /> <max value="1" /> </base> <type> <code value="Identifier" /> </type> </element> <element id="FacilityModel.dormantFacilityId"> <path value="FacilityModel.dormantFacilityId" /> <short value="Previously assigned identifiers, no longer used" /> <definition value="Previously assigned identifiers, no longer used" /> <min value="0" /> <max value="*" /> <base> <path value="FacilityModel.dormantFacilityId" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Identifier" /> </type> </element> <element id="FacilityModel.otherIdentifiers"> <path value="FacilityModel.otherIdentifiers" /> <short value="Other identifiers that may have been assigned" /> <definition value="Other identifiers that may have been assigned" /> <min value="0" /> <max value="*" /> <base> <path value="FacilityModel.otherIdentifiers" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Identifier" /> </type> </element> <element id="FacilityModel.status"> <path value="FacilityModel.status" /> <short value="The current status of this facility" /> <definition value="The current status of this facility" /> <min value="1" /> <max value="1" /> <base> <path value="FacilityModel.status" /> <min value="1" /> <max value="1" /> </base> <type> <code value="code" /> </type> </element> <element id="FacilityModel.typeOfFunction"> <path value="FacilityModel.typeOfFunction" /> <short value="The kinds of function that can be performed at this facility" /> <definition value="The kinds of function that can be performed at this facility" /> <min value="0" /> <max value="1" /> <base> <path value="FacilityModel.typeOfFunction" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> </element> <element id="FacilityModel.contactDetails"> <path value="FacilityModel.contactDetails" /> <short value="How to contact the facility (by a human)" /> <definition value="How to contact the facility (by a human)" /> <min value="0" /> <max value="*" /> <base> <path value="FacilityModel.contactDetails" /> <min value="0" /> <max value="*" /> </base> <type> <code value="ContactPoint" /> </type> </element> <element id="FacilityModel.electronicContactDetails"> <path value="FacilityModel.electronicContactDetails" /> <short value="Technical contacts" /> <definition value="Technical contacts" /> <min value="0" /> <max value="*" /> <base> <path value="FacilityModel.electronicContactDetails" /> <min value="0" /> <max value="*" /> </base> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/EndpointModel" /> </type> </element> <element id="FacilityModel.address"> <path value="FacilityModel.address" /> <short value="Where the facility is located" /> <definition value="Where the facility is located" /> <min value="0" /> <max value="1" /> <base> <path value="FacilityModel.address" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Address" /> </type> </element> <element id="FacilityModel.managingOrganization"> <path value="FacilityModel.managingOrganization" /> <short value="The organization responsible for this facility" /> <definition value="The organization responsible for this facility" /> <min value="0" /> <max value="1" /> <base> <path value="FacilityModel.managingOrganization" /> <min value="0" /> <max value="1" /> </base> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel" /> </type> </element> <element id="FacilityModel.partOf"> <path value="FacilityModel.partOf" /> <short value="If this facility is part of a larger one (eg a ward in a hospital" /> <definition value="If this facility is part of a larger one (eg a ward in a hospital" /> <min value="0" /> <max value="1" /> <base> <path value="FacilityModel.partOf" /> <min value="0" /> <max value="1" /> </base> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel" /> </type> </element> <element id="FacilityModel.established"> <path value="FacilityModel.established" /> <short value="The period over which the facility has been / is in operation" /> <definition value="The period over which the facility has been / is in operation" /> <min value="0" /> <max value="1" /> <base> <path value="FacilityModel.established" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Period" /> </type> </element> <element id="FacilityModel.dhb"> <path value="FacilityModel.dhb" /> <short value="The DHB whose catchment area this facility is in" /> <definition value="The DHB whose catchment area this facility is in" /> <min value="0" /> <max value="1" /> <base> <path value="FacilityModel.dhb" /> <min value="0" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code" /> </binding> </element> <element id="FacilityModel.geocode"> <path value="FacilityModel.geocode" /> <short value="The geocode for this facility. Uses the NZ datum (reference point)" /> <definition value="The geocode for this facility. Uses the NZ datum (reference point)" /> <min value="0" /> <max value="1" /> <base> <path value="FacilityModel.geocode" /> <min value="0" /> <max value="1" /> </base> <type> <code value="BackboneElement" /> </type> </element> <element id="FacilityModel.geocode.latitude"> <path value="FacilityModel.geocode.latitude" /> <short value="Latitude" /> <definition value="Latitude" /> <min value="0" /> <max value="1" /> <base> <path value="FacilityModel.geocode.latitude" /> <min value="0" /> <max value="1" /> </base> <type> <code value="decimal" /> </type> </element> <element id="FacilityModel.geocode.longitude"> <path value="FacilityModel.geocode.longitude" /> <short value="Longitude" /> <definition value="Longitude" /> <min value="0" /> <max value="1" /> <base> <path value="FacilityModel.geocode.longitude" /> <min value="0" /> <max value="1" /> </base> <type> <code value="decimal" /> </type> </element> </snapshot> <differential> <element id="FacilityModel"> <path value="FacilityModel" /> <short value="A facility involved in healthcare" /> <definition value="An actual physical location. Represented by a Location model in FHIR" /> </element> <element id="FacilityModel.name"> <path value="FacilityModel.name" /> <short value="The name of the facility" /> <definition value="The name of the facility" /> <min value="1" /> <max value="1" /> <type> <code value="string" /> </type> </element> <element id="FacilityModel.description"> <path value="FacilityModel.description" /> <short value="A longer description of the facility" /> <definition value="A longer description of the facility" /> <min value="0" /> <max value="1" /> <type> <code value="string" /> </type> </element> <element id="FacilityModel.alias"> <path value="FacilityModel.alias" /> <short value="Other names by which this facility is known" /> <definition value="Other names by which this facility is known" /> <min value="0" /> <max value="*" /> <type> <code value="BackboneElement" /> </type> </element> <element id="FacilityModel.alias.name"> <path value="FacilityModel.alias.name" /> <short value="The alternative name" /> <definition value="The alternative name" /> <min value="1" /> <max value="1" /> <type> <code value="string" /> </type> </element> <element id="FacilityModel.alias.type"> <path value="FacilityModel.alias.type" /> <short value="The type of alias - eg locally used name" /> <definition value="The type of alias - eg locally used name" /> <min value="0" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://nzhts.digital.health.nz/fhir/ValueSet/alias-type-code" /> </binding> </element> <element id="FacilityModel.hpiFacilityId"> <path value="FacilityModel.hpiFacilityId" /> <short value="The identifier assigned by the HPI to this facility" /> <definition value="The identifier assigned by the HPI to this facility" /> <min value="1" /> <max value="1" /> <type> <code value="Identifier" /> </type> </element> <element id="FacilityModel.dormantFacilityId"> <path value="FacilityModel.dormantFacilityId" /> <short value="Previously assigned identifiers, no longer used" /> <definition value="Previously assigned identifiers, no longer used" /> <min value="0" /> <max value="*" /> <type> <code value="Identifier" /> </type> </element> <element id="FacilityModel.otherIdentifiers"> <path value="FacilityModel.otherIdentifiers" /> <short value="Other identifiers that may have been assigned" /> <definition value="Other identifiers that may have been assigned" /> <min value="0" /> <max value="*" /> <type> <code value="Identifier" /> </type> </element> <element id="FacilityModel.status"> <path value="FacilityModel.status" /> <short value="The current status of this facility" /> <definition value="The current status of this facility" /> <min value="1" /> <max value="1" /> <type> <code value="code" /> </type> </element> <element id="FacilityModel.typeOfFunction"> <path value="FacilityModel.typeOfFunction" /> <short value="The kinds of function that can be performed at this facility" /> <definition value="The kinds of function that can be performed at this facility" /> <min value="0" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> </element> <element id="FacilityModel.contactDetails"> <path value="FacilityModel.contactDetails" /> <short value="How to contact the facility (by a human)" /> <definition value="How to contact the facility (by a human)" /> <min value="0" /> <max value="*" /> <type> <code value="ContactPoint" /> </type> </element> <element id="FacilityModel.electronicContactDetails"> <path value="FacilityModel.electronicContactDetails" /> <short value="Technical contacts" /> <definition value="Technical contacts" /> <min value="0" /> <max value="*" /> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/EndpointModel" /> </type> </element> <element id="FacilityModel.address"> <path value="FacilityModel.address" /> <short value="Where the facility is located" /> <definition value="Where the facility is located" /> <min value="0" /> <max value="1" /> <type> <code value="Address" /> </type> </element> <element id="FacilityModel.managingOrganization"> <path value="FacilityModel.managingOrganization" /> <short value="The organization responsible for this facility" /> <definition value="The organization responsible for this facility" /> <min value="0" /> <max value="1" /> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/OrganizationModel" /> </type> </element> <element id="FacilityModel.partOf"> <path value="FacilityModel.partOf" /> <short value="If this facility is part of a larger one (eg a ward in a hospital" /> <definition value="If this facility is part of a larger one (eg a ward in a hospital" /> <min value="0" /> <max value="1" /> <type> <code value="http://hl7.org.nz/fhir/ig/hpi/StructureDefinition/FacilityModel" /> </type> </element> <element id="FacilityModel.established"> <path value="FacilityModel.established" /> <short value="The period over which the facility has been / is in operation" /> <definition value="The period over which the facility has been / is in operation" /> <min value="0" /> <max value="1" /> <type> <code value="Period" /> </type> </element> <element id="FacilityModel.dhb"> <path value="FacilityModel.dhb" /> <short value="The DHB whose catchment area this facility is in" /> <definition value="The DHB whose catchment area this facility is in" /> <min value="0" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="required" /> <valueSet value="https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code" /> </binding> </element> <element id="FacilityModel.geocode"> <path value="FacilityModel.geocode" /> <short value="The geocode for this facility. Uses the NZ datum (reference point)" /> <definition value="The geocode for this facility. Uses the NZ datum (reference point)" /> <min value="0" /> <max value="1" /> <type> <code value="BackboneElement" /> </type> </element> <element id="FacilityModel.geocode.latitude"> <path value="FacilityModel.geocode.latitude" /> <short value="Latitude" /> <definition value="Latitude" /> <min value="0" /> <max value="1" /> <type> <code value="decimal" /> </type> </element> <element id="FacilityModel.geocode.longitude"> <path value="FacilityModel.geocode.longitude" /> <short value="Longitude" /> <definition value="Longitude" /> <min value="0" /> <max value="1" /> <type> <code value="decimal" /> </type> </element> </differential> </StructureDefinition>