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
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. |
Short | Healthcare facility |
Logical Model | Instances 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 |
Short | NZBN will in future be the master data source for most organisation |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
4. HealthcareFacility-cs.Id | |
Definition | The identifier of the healthcare organisation. |
Short | The identifier of the healthcare organisation. |
Control | 1..1 |
Type | Identifier |
6. HealthcareFacility-cs.OrganisationTypeCode | |
Definition | A code that describes the broad type of organisation in the context of the health system |
Short | A code that describes the broad type of organisation in the context of the health system |
Control | 1..1 |
Type | CodeableConcept |
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 |
Short | A code indicating the organisation’s classification in terms of the Act or Regulation under which the organisation has been legally constituted |
Control | 0..1 |
Type | CodeableConcept |
10. HealthcareFacility-cs.EstablishmentDate | |
Definition | The date on which the organisation was legally established to commence business operation |
Short | The date on which the organisation was legally established to commence business operation |
Control | 0..1 |
Type | date |
Primitive Value | This 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 |
Short | The date on which the organisation ceased business operation |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. HealthcareFacility-cs.DisestablishmentReasonCode | |
Definition | The reason the organisation ceased business operation |
Short | The reason the organisation ceased business operation |
Control | 0..1 |
Type | CodeableConcept |
16. HealthcareFacility-cs.LegalEntityIdentification | |
Definition | The legal system identifier by which the organisation is known and registered |
Short | The legal system identifier by which the organisation is known and registered |
Control | 0..1 |
Type | Identifier |
18. HealthcareFacility-cs.Name | |
Definition | Details about the name of the organisation |
Short | Details about the name of the organisation |
Control | 0..* |
Type | BackboneElement |
20. HealthcareFacility-cs.Name.OrganisationName | |
Definition | The name by which the organisation is known |
Short | The name by which the organisation is known |
Control | 1..1 |
Type | string |
Primitive Value | This 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 |
Short | This indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users |
Control | 0..1 |
Type | code |
Primitive Value | This 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 |
Short | The organisation name effective date from and/or to |
Control | 0..1 |
Type | Period |
26. HealthcareFacility-cs.Name.NameType | |
Definition | A classification of the organisation name |
Short | A classification of the organisation name |
Control | 0..1 |
Type | CodeableConcept |
28. HealthcareFacility-cs.Address | |
Definition | The physical location of the healthcare facility. |
Short | The physical location of the healthcare facility. |
Control | 0..* |
Type | BackboneElement |
30. HealthcareFacility-cs.Address.Type | |
Definition | The type of address, e.g. residential (physical), mailing (postal) |
Short | The type of address, e.g. residential (physical), mailing (postal) |
Control | 0..1 |
Type | CodeableConcept |
32. HealthcareFacility-cs.Address.BuildingName | |
Definition | The name of the building or institution. |
Short | The name of the building or institution. |
Control | 0..1 |
Type | string |
Primitive Value | This 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. |
Short | The floor, unit and/or street address details. |
Control | 0..1 |
Type | string |
Primitive Value | This 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 |
Short | Other geographic information related to the address |
Control | 0..1 |
Type | string |
Primitive Value | This 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. |
Short | The name of the suburb or district within a city/town. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
40. HealthcareFacility-cs.Address.City | |
Definition | HealthcareFacility.Address.City |
Short | HealthcareFacility.Address.City |
Control | 0..1 |
Type | string |
Primitive Value | This 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. |
Short | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. |
Control | 0..1 |
Type | string |
Primitive Value | This 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. |
Short | The two character ISO code that forms part of the address. |
Control | 0..1 |
Type | code |
Primitive Value | This 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’ |
Short | This indicator denotes that the person’s address information is to be held ‘in confidence’ |
Control | 0..1 |
Type | boolean |
Primitive Value | This 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 |
Short | Address effective date effective from and/or to |
Control | 0..1 |
Type | Period |
50. HealthcareFacility-cs.Address.Qualifier | |
Definition | Address qualifier eg: legal vs service |
Short | Address qualifier eg: legal vs service |
Control | 0..1 |
Type | CodeableConcept |
52. HealthcareFacility-cs.ContactInformation | |
Definition | The methods of electronic communication to be used to contact a facility. |
Short | The methods of electronic communication to be used to contact a facility. |
Control | 0..* |
Type | BackboneElement |
54. HealthcareFacility-cs.ContactInformation.ContactUsage | |
Definition | The classification that specifies the way in which the contact medium is intended to be used |
Short | The classification that specifies the way in which the contact medium is intended to be used |
Control | 0..1 |
Binding | The 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 ) |
Type | CodeableConcept |
56. HealthcareFacility-cs.ContactInformation.ContactType | |
Definition | The code representing the type of electronic contact medium to be used |
Short | The code representing the type of electronic contact medium to be used |
Control | 0..1 |
Type | CodeableConcept |
58. HealthcareFacility-cs.ContactInformation.ContactDetail | |
Definition | The contact details may comprise an electronic address or a number |
Short | The contact details may comprise an electronic address or a number |
Control | 0..1 |
Type | string |
Primitive Value | This 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 |
Short | This indicates that the contact information is confidential |
Control | 0..1 |
Type | boolean |
Primitive Value | This 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 |
Short | Date contact details effective from and/or to |
Control | 0..1 |
Type | Period |
64. HealthcareFacility-cs.ContactInformation.PerferredContactFlag | |
Definition | This flag denotes that the contact details provided are the person’s preference |
Short | This flag denotes that the contact details provided are the person’s preference |
Control | 0..1 |
Type | boolean |
Primitive Value | This 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 |
Short | The identity of the third party that supplied the data to set up the HPI facility |
Control | 0..1 |
Type | BackboneElement |
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) |
Short | A code to identify the type of organisation that made the initial request to add a facility to the health provider identity (HPI) |
Control | 0..1 |
Type | CodeableConcept |
70. HealthcareFacility-cs.DataSupplier.SupplierIdentifier | |
Definition | The HPI identifier of the organisation that supplied the facility information |
Short | The HPI identifier of the organisation that supplied the facility information |
Control | 0..1 |
Type | Identifier |
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. |
Short | Healthcare facility |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances 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 |
Short | NZBN will in future be the master data source for most organisation |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
4. HealthcareFacility-cs.Id | |
Definition | The identifier of the healthcare organisation. |
Short | The identifier of the healthcare organisation. |
Control | 1..1 |
Type | Identifier |
6. HealthcareFacility-cs.OrganisationTypeCode | |
Definition | A code that describes the broad type of organisation in the context of the health system |
Short | A code that describes the broad type of organisation in the context of the health system |
Control | 1..1 |
Type | CodeableConcept |
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 |
Short | A code indicating the organisation’s classification in terms of the Act or Regulation under which the organisation has been legally constituted |
Control | 0..1 |
Type | CodeableConcept |
10. HealthcareFacility-cs.EstablishmentDate | |
Definition | The date on which the organisation was legally established to commence business operation |
Short | The date on which the organisation was legally established to commence business operation |
Control | 0..1 |
Type | date |
Primitive Value | This 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 |
Short | The date on which the organisation ceased business operation |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. HealthcareFacility-cs.DisestablishmentReasonCode | |
Definition | The reason the organisation ceased business operation |
Short | The reason the organisation ceased business operation |
Control | 0..1 |
Type | CodeableConcept |
16. HealthcareFacility-cs.LegalEntityIdentification | |
Definition | The legal system identifier by which the organisation is known and registered |
Short | The legal system identifier by which the organisation is known and registered |
Control | 0..1 |
Type | Identifier |
18. HealthcareFacility-cs.Name | |
Definition | Details about the name of the organisation |
Short | Details about the name of the organisation |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | 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()) |
22. HealthcareFacility-cs.Name.OrganisationName | |
Definition | The name by which the organisation is known |
Short | The name by which the organisation is known |
Control | 1..1 |
Type | string |
Primitive Value | This 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 |
Short | This indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users |
Control | 0..1 |
Type | code |
Primitive Value | This 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 |
Short | The organisation name effective date from and/or to |
Control | 0..1 |
Type | Period |
28. HealthcareFacility-cs.Name.NameType | |
Definition | A classification of the organisation name |
Short | A classification of the organisation name |
Control | 0..1 |
Type | CodeableConcept |
30. HealthcareFacility-cs.Address | |
Definition | The physical location of the healthcare facility. |
Short | The physical location of the healthcare facility. |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | 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()) |
34. HealthcareFacility-cs.Address.Type | |
Definition | The type of address, e.g. residential (physical), mailing (postal) |
Short | The type of address, e.g. residential (physical), mailing (postal) |
Control | 0..1 |
Type | CodeableConcept |
36. HealthcareFacility-cs.Address.BuildingName | |
Definition | The name of the building or institution. |
Short | The name of the building or institution. |
Control | 0..1 |
Type | string |
Primitive Value | This 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. |
Short | The floor, unit and/or street address details. |
Control | 0..1 |
Type | string |
Primitive Value | This 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 |
Short | Other geographic information related to the address |
Control | 0..1 |
Type | string |
Primitive Value | This 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. |
Short | The name of the suburb or district within a city/town. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
44. HealthcareFacility-cs.Address.City | |
Definition | HealthcareFacility.Address.City |
Short | HealthcareFacility.Address.City |
Control | 0..1 |
Type | string |
Primitive Value | This 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. |
Short | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. |
Control | 0..1 |
Type | string |
Primitive Value | This 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. |
Short | The two character ISO code that forms part of the address. |
Control | 0..1 |
Type | code |
Primitive Value | This 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’ |
Short | This indicator denotes that the person’s address information is to be held ‘in confidence’ |
Control | 0..1 |
Type | boolean |
Primitive Value | This 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 |
Short | Address effective date effective from and/or to |
Control | 0..1 |
Type | Period |
54. HealthcareFacility-cs.Address.Qualifier | |
Definition | Address qualifier eg: legal vs service |
Short | Address qualifier eg: legal vs service |
Control | 0..1 |
Type | CodeableConcept |
56. HealthcareFacility-cs.ContactInformation | |
Definition | The methods of electronic communication to be used to contact a facility. |
Short | The methods of electronic communication to be used to contact a facility. |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | 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()) |
60. HealthcareFacility-cs.ContactInformation.ContactUsage | |
Definition | The classification that specifies the way in which the contact medium is intended to be used |
Short | The classification that specifies the way in which the contact medium is intended to be used |
Control | 0..1 |
Binding | The 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 ) |
Type | CodeableConcept |
62. HealthcareFacility-cs.ContactInformation.ContactType | |
Definition | The code representing the type of electronic contact medium to be used |
Short | The code representing the type of electronic contact medium to be used |
Control | 0..1 |
Type | CodeableConcept |
64. HealthcareFacility-cs.ContactInformation.ContactDetail | |
Definition | The contact details may comprise an electronic address or a number |
Short | The contact details may comprise an electronic address or a number |
Control | 0..1 |
Type | string |
Primitive Value | This 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 |
Short | This indicates that the contact information is confidential |
Control | 0..1 |
Type | boolean |
Primitive Value | This 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 |
Short | Date contact details effective from and/or to |
Control | 0..1 |
Type | Period |
70. HealthcareFacility-cs.ContactInformation.PerferredContactFlag | |
Definition | This flag denotes that the contact details provided are the person’s preference |
Short | This flag denotes that the contact details provided are the person’s preference |
Control | 0..1 |
Type | boolean |
Primitive Value | This 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 |
Short | The identity of the third party that supplied the data to set up the HPI facility |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | 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()) |
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) |
Short | A code to identify the type of organisation that made the initial request to add a facility to the health provider identity (HPI) |
Control | 0..1 |
Type | CodeableConcept |
78. HealthcareFacility-cs.DataSupplier.SupplierIdentifier | |
Definition | The HPI identifier of the organisation that supplied the facility information |
Short | The HPI identifier of the organisation that supplied the facility information |
Control | 0..1 |
Type | Identifier |
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. |
Short | Healthcare facility |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances 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 |
Short | NZBN will in future be the master data source for most organisation |
Control | 0..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
4. HealthcareFacility-cs.Id | |
Definition | The identifier of the healthcare organisation. |
Short | The identifier of the healthcare organisation. |
Control | 1..1 |
Type | Identifier |
6. HealthcareFacility-cs.OrganisationTypeCode | |
Definition | A code that describes the broad type of organisation in the context of the health system |
Short | A code that describes the broad type of organisation in the context of the health system |
Control | 1..1 |
Type | CodeableConcept |
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 |
Short | A code indicating the organisation’s classification in terms of the Act or Regulation under which the organisation has been legally constituted |
Control | 0..1 |
Type | CodeableConcept |
10. HealthcareFacility-cs.EstablishmentDate | |
Definition | The date on which the organisation was legally established to commence business operation |
Short | The date on which the organisation was legally established to commence business operation |
Control | 0..1 |
Type | date |
Primitive Value | This 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 |
Short | The date on which the organisation ceased business operation |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. HealthcareFacility-cs.DisestablishmentReasonCode | |
Definition | The reason the organisation ceased business operation |
Short | The reason the organisation ceased business operation |
Control | 0..1 |
Type | CodeableConcept |
16. HealthcareFacility-cs.LegalEntityIdentification | |
Definition | The legal system identifier by which the organisation is known and registered |
Short | The legal system identifier by which the organisation is known and registered |
Control | 0..1 |
Type | Identifier |
18. HealthcareFacility-cs.Name | |
Definition | Details about the name of the organisation |
Short | Details about the name of the organisation |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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 HealthcareFacility-cs.Name.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | 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() ) |
26. HealthcareFacility-cs.Name.OrganisationName | |
Definition | The name by which the organisation is known |
Short | The name by which the organisation is known |
Control | 1..1 |
Type | string |
Primitive Value | This 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 |
Short | This indicates that, at the organisation’s request, the organisation name is confidential and should only be available to authorised users |
Control | 0..1 |
Type | code |
Primitive Value | This 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 |
Short | The organisation name effective date from and/or to |
Control | 0..1 |
Type | Period |
32. HealthcareFacility-cs.Name.NameType | |
Definition | A classification of the organisation name |
Short | A classification of the organisation name |
Control | 0..1 |
Type | CodeableConcept |
34. HealthcareFacility-cs.Address | |
Definition | The physical location of the healthcare facility. |
Short | The physical location of the healthcare facility. |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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 HealthcareFacility-cs.Address.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | 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() ) |
42. HealthcareFacility-cs.Address.Type | |
Definition | The type of address, e.g. residential (physical), mailing (postal) |
Short | The type of address, e.g. residential (physical), mailing (postal) |
Control | 0..1 |
Type | CodeableConcept |
44. HealthcareFacility-cs.Address.BuildingName | |
Definition | The name of the building or institution. |
Short | The name of the building or institution. |
Control | 0..1 |
Type | string |
Primitive Value | This 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. |
Short | The floor, unit and/or street address details. |
Control | 0..1 |
Type | string |
Primitive Value | This 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 |
Short | Other geographic information related to the address |
Control | 0..1 |
Type | string |
Primitive Value | This 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. |
Short | The name of the suburb or district within a city/town. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. HealthcareFacility-cs.Address.City | |
Definition | HealthcareFacility.Address.City |
Short | HealthcareFacility.Address.City |
Control | 0..1 |
Type | string |
Primitive Value | This 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. |
Short | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. |
Control | 0..1 |
Type | string |
Primitive Value | This 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. |
Short | The two character ISO code that forms part of the address. |
Control | 0..1 |
Type | code |
Primitive Value | This 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’ |
Short | This indicator denotes that the person’s address information is to be held ‘in confidence’ |
Control | 0..1 |
Type | boolean |
Primitive Value | This 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 |
Short | Address effective date effective from and/or to |
Control | 0..1 |
Type | Period |
62. HealthcareFacility-cs.Address.Qualifier | |
Definition | Address qualifier eg: legal vs service |
Short | Address qualifier eg: legal vs service |
Control | 0..1 |
Type | CodeableConcept |
64. HealthcareFacility-cs.ContactInformation | |
Definition | The methods of electronic communication to be used to contact a facility. |
Short | The methods of electronic communication to be used to contact a facility. |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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 HealthcareFacility-cs.ContactInformation.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | 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() ) |
72. HealthcareFacility-cs.ContactInformation.ContactUsage | |
Definition | The classification that specifies the way in which the contact medium is intended to be used |
Short | The classification that specifies the way in which the contact medium is intended to be used |
Control | 0..1 |
Binding | The 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 ) |
Type | CodeableConcept |
74. HealthcareFacility-cs.ContactInformation.ContactType | |
Definition | The code representing the type of electronic contact medium to be used |
Short | The code representing the type of electronic contact medium to be used |
Control | 0..1 |
Type | CodeableConcept |
76. HealthcareFacility-cs.ContactInformation.ContactDetail | |
Definition | The contact details may comprise an electronic address or a number |
Short | The contact details may comprise an electronic address or a number |
Control | 0..1 |
Type | string |
Primitive Value | This 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 |
Short | This indicates that the contact information is confidential |
Control | 0..1 |
Type | boolean |
Primitive Value | This 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 |
Short | Date contact details effective from and/or to |
Control | 0..1 |
Type | Period |
82. HealthcareFacility-cs.ContactInformation.PerferredContactFlag | |
Definition | This flag denotes that the contact details provided are the person’s preference |
Short | This flag denotes that the contact details provided are the person’s preference |
Control | 0..1 |
Type | boolean |
Primitive Value | This 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 |
Short | The identity of the third party that supplied the data to set up the HPI facility |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-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. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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 HealthcareFacility-cs.DataSupplier.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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 Names | extensions, user content, modifiers |
Invariants | 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() ) |
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) |
Short | A code to identify the type of organisation that made the initial request to add a facility to the health provider identity (HPI) |
Control | 0..1 |
Type | CodeableConcept |
94. HealthcareFacility-cs.DataSupplier.SupplierIdentifier | |
Definition | The HPI identifier of the organisation that supplied the facility information |
Short | The HPI identifier of the organisation that supplied the facility information |
Control | 0..1 |
Type | Identifier |