HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions
| Active as of 2020-07-31 | Maturity Level: 3 |
Definitions for the dhb extension.
Guidance on how to interpret the contents of this table can be found here
| 0. Extension | |
| Definition | District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address). |
| Short | District Health Board linked to a NZ Healthcare Service, Location or Patient |
| 2. Extension.extension | |
| Control | 0..0 |
| 4. Extension.url | |
| Fixed Value | http://hl7.org.nz/fhir/StructureDefinition/dhb |
| 6. Extension.value[x] | |
| Definition | NZ District Health Boards as defined in the NZ Health Provider Index Listing published by the NZ Ministry of Health each month. |
| Short | NZ District Health Boards |
| Binding | Unless not suitable, these codes SHALL be taken from District Health Board Identifer (extensible to https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code)NZ HPI-ORG Values for DHBs |
| Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Requirements | The NzDHB ValueSet should be used as this provides the correct NZ HPI-ORG ID for each of the 20 District Health Boards.The binding strength is extensible as this is the most suitable option for a Codeable Concept data type. |
| Label | DHB Code |
| Example | <br/><b>Waikato DHB</b>:{ "coding" : [{ "system" : "https://standards.digital.health.nz/ns/dhb-code", "version" : "1.0", "code" : "G00027-C", "display" : "Waikato District Health Board" }] } |
Guidance on how to interpret the contents of this table can be found here
| 0. Extension | |
| Definition | District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address). Optional Extension Element - found in all resources. |
| Short | District Health Board linked to a NZ Healthcare Service, Location or PatientOptional Extensions Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| 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())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 2. Extension.extension | |
| Definition | An Extension 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 | ExtensionAdditional 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..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 Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://hl7.org.nz/fhir/StructureDefinition/dhb |
| 6. Extension.value[x] | |
| Definition | NZ District Health Boards as defined in the NZ Health Provider Index Listing published by the NZ Ministry of Health each month. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Short | NZ District Health BoardsValue of extension |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see District Health Board Identifer (extensible to https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code)NZ HPI-ORG Values for DHBs |
| Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Requirements | The NzDHB ValueSet should be used as this provides the correct NZ HPI-ORG ID for each of the 20 District Health Boards.The binding strength is extensible as this is the most suitable option for a Codeable Concept data type. |
| Label | DHB Code |
| Example | <br/><b>Waikato DHB</b>:{ "coding" : [{ "system" : "https://standards.digital.health.nz/ns/dhb-code", "version" : "1.0", "code" : "G00027-C", "display" : "Waikato District Health Board" }] } |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
| 0. Extension | |
| Definition | District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address). |
| Short | District Health Board linked to a NZ Healthcare Service, Location or Patient |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| 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()) |
| 2. Extension.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 |
| 4. Extension.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| 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 Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Fixed Value | http://hl7.org.nz/fhir/StructureDefinition/dhb |
| 8. Extension.value[x] | |
| Definition | NZ District Health Boards as defined in the NZ Health Provider Index Listing published by the NZ Ministry of Health each month. |
| Short | NZ District Health Boards |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from District Health Board Identifer (extensible to https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code)NZ HPI-ORG Values for DHBs |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Summary | false |
| Requirements | The NzDHB ValueSet should be used as this provides the correct NZ HPI-ORG ID for each of the 20 District Health Boards.The binding strength is extensible as this is the most suitable option for a Codeable Concept data type. |
| Label | DHB Code |
| Example | <br/><b>Waikato DHB</b>:{ "coding" : [{ "system" : "https://standards.digital.health.nz/ns/dhb-code", "version" : "1.0", "code" : "G00027-C", "display" : "Waikato District Health Board" }] } |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |