CanShare models
0.1.0 - ci-build

CanShare models, published by David hay. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/davidhay25/models/ and changes regularly. See the Directory of published versions

Logical Model: HealthcareFacility_cs - Detailed Descriptions

Draft as of 2024-03-04

Definitions for the HealthcareFacility-cs logical model.

Guidance on how to interpret the contents of this table can be found here

0. HealthcareFacility-cs
Definition

A facility at which healthcare is provided.

ShortHealthcare facility
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HealthcareFacility-cs.NZBN
Definition

NZBN will in future be the master data source for most organisation

ShortNZBN will in future be the master data source for most organisation
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. HealthcareFacility-cs.Id
Definition

The identifier of the healthcare organisation.

ShortThe identifier of the healthcare organisation.
Control1..1
TypeIdentifier
6. HealthcareFacility-cs.OrganisationTypeCode
Definition

A code that describes the broad type of organisation in the context of the health system

ShortA code that describes the broad type of organisation in the context of the health system
Control1..1
TypeCodeableConcept
8. HealthcareFacility-cs.LegalEntityType
Definition

A code indicating the organisation’s classification in terms of the Act or Regulation under which the organisation has been legally constituted

ShortA code indicating the organisation’s classification in terms of the Act or Regulation under which the organisation has been legally constituted
Control0..1
TypeCodeableConcept
10. HealthcareFacility-cs.EstablishmentDate
Definition

The date on which the organisation was legally established to commence business operation

ShortThe date on which the organisation was legally established to commence business operation
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. HealthcareFacility-cs.DisestablishmentDate
Definition

The date on which the organisation ceased business operation

ShortThe date on which the organisation ceased business operation
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. HealthcareFacility-cs.DisestablishmentReasonCode
Definition

The reason the organisation ceased business operation

ShortThe reason the organisation ceased business operation
Control0..1
TypeCodeableConcept
16. HealthcareFacility-cs.LegalEntityIdentification
Definition

The legal system identifier by which the organisation is known and registered

ShortThe legal system identifier by which the organisation is known and registered
Control0..1
TypeIdentifier
18. HealthcareFacility-cs.Name
Definition

Details about the name of the organisation

ShortDetails about the name of the organisation
Control0..*
TypeBackboneElement
20. HealthcareFacility-cs.Name.OrganisationName
Definition

The name by which the organisation is known

ShortThe name by which the organisation is known
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. HealthcareFacility-cs.Name.NameProtectedFlag
Definition

This indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users

ShortThis indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. HealthcareFacility-cs.Name.EffectiveDateRange
Definition

The organisation name effective date from and/or to

ShortThe organisation name effective date from and/or to
Control0..1
TypePeriod
26. HealthcareFacility-cs.Name.NameType
Definition

A classification of the organisation name

ShortA classification of the organisation name
Control0..1
TypeCodeableConcept
28. HealthcareFacility-cs.Address
Definition

The physical location of the healthcare facility.

ShortThe physical location of the healthcare facility.
Control0..*
TypeBackboneElement
30. HealthcareFacility-cs.Address.Type
Definition

The type of address, e.g. residential (physical), mailing (postal)

ShortThe type of address, e.g. residential (physical), mailing (postal)
Control0..1
TypeCodeableConcept
32. HealthcareFacility-cs.Address.BuildingName
Definition

The name of the building or institution.

ShortThe name of the building or institution.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. HealthcareFacility-cs.Address.StreetAddress1
Definition

The floor, unit and/or street address details.

ShortThe floor, unit and/or street address details.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. HealthcareFacility-cs.Address.StreetAddress2
Definition

Other geographic information related to the address

ShortOther geographic information related to the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. HealthcareFacility-cs.Address.Suburb
Definition

The name of the suburb or district within a city/town.

ShortThe name of the suburb or district within a city/town.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. HealthcareFacility-cs.Address.City
Definition

HealthcareFacility.Address.City

ShortHealthcareFacility.Address.City
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. HealthcareFacility-cs.Address.Postcode
Definition

The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.

ShortThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. HealthcareFacility-cs.Address.CountryCode
Definition

The two character ISO code that forms part of the address.

ShortThe two character ISO code that forms part of the address.
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. HealthcareFacility-cs.Address.AddressProtectedFlag
Definition

This indicator denotes that the person’s address information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s address information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. HealthcareFacility-cs.Address.EffectiveDateRange
Definition

Address effective date effective from and/or to

ShortAddress effective date effective from and/or to
Control0..1
TypePeriod
50. HealthcareFacility-cs.Address.Qualifier
Definition

Address qualifier eg: legal vs service

ShortAddress qualifier eg: legal vs service
Control0..1
TypeCodeableConcept
52. HealthcareFacility-cs.ContactInformation
Definition

The methods of electronic communication to be used to contact a facility.

ShortThe methods of electronic communication to be used to contact a facility.
Control0..*
TypeBackboneElement
54. HealthcareFacility-cs.ContactInformation.ContactUsage
Definition

The classification that specifies the way in which the contact medium is intended to be used

ShortThe classification that specifies the way in which the contact medium is intended to be used
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
TypeCodeableConcept
56. HealthcareFacility-cs.ContactInformation.ContactType
Definition

The code representing the type of electronic contact medium to be used

ShortThe code representing the type of electronic contact medium to be used
Control0..1
TypeCodeableConcept
58. HealthcareFacility-cs.ContactInformation.ContactDetail
Definition

The contact details may comprise an electronic address or a number

ShortThe contact details may comprise an electronic address or a number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
60. HealthcareFacility-cs.ContactInformation.ContactProtectedFlag
Definition

This indicates that the contact information is confidential

ShortThis indicates that the contact information is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
62. HealthcareFacility-cs.ContactInformation.ContactDetailsPeriod
Definition

Date contact details effective from and/or to

ShortDate contact details effective from and/or to
Control0..1
TypePeriod
64. HealthcareFacility-cs.ContactInformation.PerferredContactFlag
Definition

This flag denotes that the contact details provided are the person’s preference

ShortThis flag denotes that the contact details provided are the person’s preference
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
66. HealthcareFacility-cs.DataSupplier
Definition

The identity of the third party that supplied the data to set up the HPI facility

ShortThe identity of the third party that supplied the data to set up the HPI facility
Control0..1
TypeBackboneElement
68. HealthcareFacility-cs.DataSupplier.DataSupplierTypeCode
Definition

A code to identify the type of organisation that made the initial request to add a facility to the health provider identity (HPI)

ShortA code to identify the type of organisation that made the initial request to add a facility to the health provider identity (HPI)
Control0..1
TypeCodeableConcept
70. HealthcareFacility-cs.DataSupplier.SupplierIdentifier
Definition

The HPI identifier of the organisation that supplied the facility information

ShortThe HPI identifier of the organisation that supplied the facility information
Control0..1
TypeIdentifier

Guidance on how to interpret the contents of this table can be found here

0. HealthcareFacility-cs
Definition

A facility at which healthcare is provided.

ShortHealthcare facility
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HealthcareFacility-cs.NZBN
Definition

NZBN will in future be the master data source for most organisation

ShortNZBN will in future be the master data source for most organisation
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. HealthcareFacility-cs.Id
Definition

The identifier of the healthcare organisation.

ShortThe identifier of the healthcare organisation.
Control1..1
TypeIdentifier
6. HealthcareFacility-cs.OrganisationTypeCode
Definition

A code that describes the broad type of organisation in the context of the health system

ShortA code that describes the broad type of organisation in the context of the health system
Control1..1
TypeCodeableConcept
8. HealthcareFacility-cs.LegalEntityType
Definition

A code indicating the organisation’s classification in terms of the Act or Regulation under which the organisation has been legally constituted

ShortA code indicating the organisation’s classification in terms of the Act or Regulation under which the organisation has been legally constituted
Control0..1
TypeCodeableConcept
10. HealthcareFacility-cs.EstablishmentDate
Definition

The date on which the organisation was legally established to commence business operation

ShortThe date on which the organisation was legally established to commence business operation
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. HealthcareFacility-cs.DisestablishmentDate
Definition

The date on which the organisation ceased business operation

ShortThe date on which the organisation ceased business operation
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. HealthcareFacility-cs.DisestablishmentReasonCode
Definition

The reason the organisation ceased business operation

ShortThe reason the organisation ceased business operation
Control0..1
TypeCodeableConcept
16. HealthcareFacility-cs.LegalEntityIdentification
Definition

The legal system identifier by which the organisation is known and registered

ShortThe legal system identifier by which the organisation is known and registered
Control0..1
TypeIdentifier
18. HealthcareFacility-cs.Name
Definition

Details about the name of the organisation

ShortDetails about the name of the organisation
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. HealthcareFacility-cs.Name.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
22. HealthcareFacility-cs.Name.OrganisationName
Definition

The name by which the organisation is known

ShortThe name by which the organisation is known
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. HealthcareFacility-cs.Name.NameProtectedFlag
Definition

This indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users

ShortThis indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. HealthcareFacility-cs.Name.EffectiveDateRange
Definition

The organisation name effective date from and/or to

ShortThe organisation name effective date from and/or to
Control0..1
TypePeriod
28. HealthcareFacility-cs.Name.NameType
Definition

A classification of the organisation name

ShortA classification of the organisation name
Control0..1
TypeCodeableConcept
30. HealthcareFacility-cs.Address
Definition

The physical location of the healthcare facility.

ShortThe physical location of the healthcare facility.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. HealthcareFacility-cs.Address.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
34. HealthcareFacility-cs.Address.Type
Definition

The type of address, e.g. residential (physical), mailing (postal)

ShortThe type of address, e.g. residential (physical), mailing (postal)
Control0..1
TypeCodeableConcept
36. HealthcareFacility-cs.Address.BuildingName
Definition

The name of the building or institution.

ShortThe name of the building or institution.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. HealthcareFacility-cs.Address.StreetAddress1
Definition

The floor, unit and/or street address details.

ShortThe floor, unit and/or street address details.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. HealthcareFacility-cs.Address.StreetAddress2
Definition

Other geographic information related to the address

ShortOther geographic information related to the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. HealthcareFacility-cs.Address.Suburb
Definition

The name of the suburb or district within a city/town.

ShortThe name of the suburb or district within a city/town.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. HealthcareFacility-cs.Address.City
Definition

HealthcareFacility.Address.City

ShortHealthcareFacility.Address.City
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. HealthcareFacility-cs.Address.Postcode
Definition

The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.

ShortThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. HealthcareFacility-cs.Address.CountryCode
Definition

The two character ISO code that forms part of the address.

ShortThe two character ISO code that forms part of the address.
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
50. HealthcareFacility-cs.Address.AddressProtectedFlag
Definition

This indicator denotes that the person’s address information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s address information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. HealthcareFacility-cs.Address.EffectiveDateRange
Definition

Address effective date effective from and/or to

ShortAddress effective date effective from and/or to
Control0..1
TypePeriod
54. HealthcareFacility-cs.Address.Qualifier
Definition

Address qualifier eg: legal vs service

ShortAddress qualifier eg: legal vs service
Control0..1
TypeCodeableConcept
56. HealthcareFacility-cs.ContactInformation
Definition

The methods of electronic communication to be used to contact a facility.

ShortThe methods of electronic communication to be used to contact a facility.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. HealthcareFacility-cs.ContactInformation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
60. HealthcareFacility-cs.ContactInformation.ContactUsage
Definition

The classification that specifies the way in which the contact medium is intended to be used

ShortThe classification that specifies the way in which the contact medium is intended to be used
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
TypeCodeableConcept
62. HealthcareFacility-cs.ContactInformation.ContactType
Definition

The code representing the type of electronic contact medium to be used

ShortThe code representing the type of electronic contact medium to be used
Control0..1
TypeCodeableConcept
64. HealthcareFacility-cs.ContactInformation.ContactDetail
Definition

The contact details may comprise an electronic address or a number

ShortThe contact details may comprise an electronic address or a number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
66. HealthcareFacility-cs.ContactInformation.ContactProtectedFlag
Definition

This indicates that the contact information is confidential

ShortThis indicates that the contact information is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
68. HealthcareFacility-cs.ContactInformation.ContactDetailsPeriod
Definition

Date contact details effective from and/or to

ShortDate contact details effective from and/or to
Control0..1
TypePeriod
70. HealthcareFacility-cs.ContactInformation.PerferredContactFlag
Definition

This flag denotes that the contact details provided are the person’s preference

ShortThis flag denotes that the contact details provided are the person’s preference
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
72. HealthcareFacility-cs.DataSupplier
Definition

The identity of the third party that supplied the data to set up the HPI facility

ShortThe identity of the third party that supplied the data to set up the HPI facility
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. HealthcareFacility-cs.DataSupplier.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
76. HealthcareFacility-cs.DataSupplier.DataSupplierTypeCode
Definition

A code to identify the type of organisation that made the initial request to add a facility to the health provider identity (HPI)

ShortA code to identify the type of organisation that made the initial request to add a facility to the health provider identity (HPI)
Control0..1
TypeCodeableConcept
78. HealthcareFacility-cs.DataSupplier.SupplierIdentifier
Definition

The HPI identifier of the organisation that supplied the facility information

ShortThe HPI identifier of the organisation that supplied the facility information
Control0..1
TypeIdentifier

Guidance on how to interpret the contents of this table can be found here

0. HealthcareFacility-cs
Definition

A facility at which healthcare is provided.

ShortHealthcare facility
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HealthcareFacility-cs.NZBN
Definition

NZBN will in future be the master data source for most organisation

ShortNZBN will in future be the master data source for most organisation
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. HealthcareFacility-cs.Id
Definition

The identifier of the healthcare organisation.

ShortThe identifier of the healthcare organisation.
Control1..1
TypeIdentifier
6. HealthcareFacility-cs.OrganisationTypeCode
Definition

A code that describes the broad type of organisation in the context of the health system

ShortA code that describes the broad type of organisation in the context of the health system
Control1..1
TypeCodeableConcept
8. HealthcareFacility-cs.LegalEntityType
Definition

A code indicating the organisation’s classification in terms of the Act or Regulation under which the organisation has been legally constituted

ShortA code indicating the organisation’s classification in terms of the Act or Regulation under which the organisation has been legally constituted
Control0..1
TypeCodeableConcept
10. HealthcareFacility-cs.EstablishmentDate
Definition

The date on which the organisation was legally established to commence business operation

ShortThe date on which the organisation was legally established to commence business operation
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. HealthcareFacility-cs.DisestablishmentDate
Definition

The date on which the organisation ceased business operation

ShortThe date on which the organisation ceased business operation
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. HealthcareFacility-cs.DisestablishmentReasonCode
Definition

The reason the organisation ceased business operation

ShortThe reason the organisation ceased business operation
Control0..1
TypeCodeableConcept
16. HealthcareFacility-cs.LegalEntityIdentification
Definition

The legal system identifier by which the organisation is known and registered

ShortThe legal system identifier by which the organisation is known and registered
Control0..1
TypeIdentifier
18. HealthcareFacility-cs.Name
Definition

Details about the name of the organisation

ShortDetails about the name of the organisation
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. HealthcareFacility-cs.Name.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
22. HealthcareFacility-cs.Name.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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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 HealthcareFacility-cs.Name.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
24. HealthcareFacility-cs.Name.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
26. HealthcareFacility-cs.Name.OrganisationName
Definition

The name by which the organisation is known

ShortThe name by which the organisation is known
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. HealthcareFacility-cs.Name.NameProtectedFlag
Definition

This indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users

ShortThis indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. HealthcareFacility-cs.Name.EffectiveDateRange
Definition

The organisation name effective date from and/or to

ShortThe organisation name effective date from and/or to
Control0..1
TypePeriod
32. HealthcareFacility-cs.Name.NameType
Definition

A classification of the organisation name

ShortA classification of the organisation name
Control0..1
TypeCodeableConcept
34. HealthcareFacility-cs.Address
Definition

The physical location of the healthcare facility.

ShortThe physical location of the healthcare facility.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. HealthcareFacility-cs.Address.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
38. HealthcareFacility-cs.Address.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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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 HealthcareFacility-cs.Address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
40. HealthcareFacility-cs.Address.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
42. HealthcareFacility-cs.Address.Type
Definition

The type of address, e.g. residential (physical), mailing (postal)

ShortThe type of address, e.g. residential (physical), mailing (postal)
Control0..1
TypeCodeableConcept
44. HealthcareFacility-cs.Address.BuildingName
Definition

The name of the building or institution.

ShortThe name of the building or institution.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. HealthcareFacility-cs.Address.StreetAddress1
Definition

The floor, unit and/or street address details.

ShortThe floor, unit and/or street address details.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. HealthcareFacility-cs.Address.StreetAddress2
Definition

Other geographic information related to the address

ShortOther geographic information related to the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
50. HealthcareFacility-cs.Address.Suburb
Definition

The name of the suburb or district within a city/town.

ShortThe name of the suburb or district within a city/town.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. HealthcareFacility-cs.Address.City
Definition

HealthcareFacility.Address.City

ShortHealthcareFacility.Address.City
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. HealthcareFacility-cs.Address.Postcode
Definition

The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.

ShortThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
56. HealthcareFacility-cs.Address.CountryCode
Definition

The two character ISO code that forms part of the address.

ShortThe two character ISO code that forms part of the address.
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
58. HealthcareFacility-cs.Address.AddressProtectedFlag
Definition

This indicator denotes that the person’s address information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s address information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
60. HealthcareFacility-cs.Address.EffectiveDateRange
Definition

Address effective date effective from and/or to

ShortAddress effective date effective from and/or to
Control0..1
TypePeriod
62. HealthcareFacility-cs.Address.Qualifier
Definition

Address qualifier eg: legal vs service

ShortAddress qualifier eg: legal vs service
Control0..1
TypeCodeableConcept
64. HealthcareFacility-cs.ContactInformation
Definition

The methods of electronic communication to be used to contact a facility.

ShortThe methods of electronic communication to be used to contact a facility.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. HealthcareFacility-cs.ContactInformation.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
68. HealthcareFacility-cs.ContactInformation.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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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 HealthcareFacility-cs.ContactInformation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
70. HealthcareFacility-cs.ContactInformation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
72. HealthcareFacility-cs.ContactInformation.ContactUsage
Definition

The classification that specifies the way in which the contact medium is intended to be used

ShortThe classification that specifies the way in which the contact medium is intended to be used
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
TypeCodeableConcept
74. HealthcareFacility-cs.ContactInformation.ContactType
Definition

The code representing the type of electronic contact medium to be used

ShortThe code representing the type of electronic contact medium to be used
Control0..1
TypeCodeableConcept
76. HealthcareFacility-cs.ContactInformation.ContactDetail
Definition

The contact details may comprise an electronic address or a number

ShortThe contact details may comprise an electronic address or a number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
78. HealthcareFacility-cs.ContactInformation.ContactProtectedFlag
Definition

This indicates that the contact information is confidential

ShortThis indicates that the contact information is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
80. HealthcareFacility-cs.ContactInformation.ContactDetailsPeriod
Definition

Date contact details effective from and/or to

ShortDate contact details effective from and/or to
Control0..1
TypePeriod
82. HealthcareFacility-cs.ContactInformation.PerferredContactFlag
Definition

This flag denotes that the contact details provided are the person’s preference

ShortThis flag denotes that the contact details provided are the person’s preference
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
84. HealthcareFacility-cs.DataSupplier
Definition

The identity of the third party that supplied the data to set up the HPI facility

ShortThe identity of the third party that supplied the data to set up the HPI facility
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. HealthcareFacility-cs.DataSupplier.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
88. HealthcareFacility-cs.DataSupplier.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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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 HealthcareFacility-cs.DataSupplier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
90. HealthcareFacility-cs.DataSupplier.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
92. HealthcareFacility-cs.DataSupplier.DataSupplierTypeCode
Definition

A code to identify the type of organisation that made the initial request to add a facility to the health provider identity (HPI)

ShortA code to identify the type of organisation that made the initial request to add a facility to the health provider identity (HPI)
Control0..1
TypeCodeableConcept
94. HealthcareFacility-cs.DataSupplier.SupplierIdentifier
Definition

The HPI identifier of the organisation that supplied the facility information

ShortThe HPI identifier of the organisation that supplied the facility information
Control0..1
TypeIdentifier