HL7® FHIR® New Zealand Base Implementation Guide
3.2.0-ci-build - 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.2.0-ci-build 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

Resource Profile: HealthcareService resource for use in NZ

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzHealthcareService Version: 1.0.0
Draft as of 2026-10-15 Computable Name: NzHealthcareService

HealthcareService resource for use in NZ

Usages:

  • This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
HealthcareService.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
HealthcareService.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HealthcareService.Slices for extension.extension:dhb 0..1 CodeableConcept District Health Board linked to a NZ Healthcare Service, Location or Patient
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
HealthcareService.Slices for extension.extension:funded-programme 0..* (Complex) Funded Healthcare Programme
URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
HealthcareService.Slices for extension.extension:pho 0..1 CodeableConcept Primary Healthcare Organisation
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
HealthcareService.Slices for extension.extension:messaging-address 0..* (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
HealthcareService.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
HealthcareService.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this HealthcareService record is in active use

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraints    Filter: doco
HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
HealthcareService.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HealthcareService.Slices for extension.extension:dhb 0..1 CodeableConcept District Health Board linked to a NZ Healthcare Service, Location or Patient
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
HealthcareService.Slices for extension.extension:funded-programme 0..* (Complex) Funded Healthcare Programme
URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
HealthcareService.Slices for extension.extension:pho 0..1 CodeableConcept Primary Healthcare Organisation
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
HealthcareService.Slices for extension.extension:messaging-address 0..* (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
HealthcareService.id This element is included in summaries. 0..1 id Logical id of this artifact
HealthcareService.meta This element is included in summaries. 0..1 Meta Metadata about the resource
HealthcareService.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
HealthcareService.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
HealthcareService.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
HealthcareService.contained 0..* Resource Contained, inline Resources
HealthcareService.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HealthcareService.Slices for extension.extension:dhb 0..1 CodeableConcept District Health Board linked to a NZ Healthcare Service, Location or Patient
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
HealthcareService.Slices for extension.extension:funded-programme 0..* (Complex) Funded Healthcare Programme
URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
HealthcareService.Slices for extension.extension:pho 0..1 CodeableConcept Primary Healthcare Organisation
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
HealthcareService.Slices for extension.extension:messaging-address 0..* (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
HealthcareService.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
HealthcareService.identifier This element is included in summaries. 0..* Identifier External identifiers for this item
HealthcareService.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this HealthcareService record is in active use
HealthcareService.providedBy This element is included in summaries. 0..1 Reference(Organization) Organization that provides this service
HealthcareService.category This element is included in summaries. 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.
HealthcareService.type This element is included in summaries. 0..* CodeableConcept Type of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).
HealthcareService.specialty This element is included in summaries. 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.
HealthcareService.location This element is included in summaries. 0..* Reference(Location) Location(s) where service may be provided
HealthcareService.name This element is included in summaries. 0..1 string Description of service as presented to a consumer while searching
HealthcareService.comment This element is included in summaries. 0..1 string Additional description and/or any specific issues not covered elsewhere
HealthcareService.extraDetails 0..1 markdown Extra details about the service that can't be placed in the other fields
HealthcareService.photo This element is included in summaries. 0..1 Attachment Facilitates quick identification of the service
HealthcareService.telecom 0..* ContactPoint Contacts related to the healthcare service
HealthcareService.coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
HealthcareService.serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
HealthcareService.eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
HealthcareService.eligibility.id 0..1 string Unique id for inter-element referencing
HealthcareService.eligibility.extension 0..* Extension Additional content defined by implementations
HealthcareService.eligibility.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.eligibility.code 0..1 CodeableConcept Coded value for the eligibility
Binding Description: (example): Coded values underwhich a specific service is made available.
HealthcareService.eligibility.comment 0..1 markdown Describes the eligibility conditions for the service
HealthcareService.program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.
HealthcareService.characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
HealthcareService.communication 0..* CodeableConcept The language that this service is offered in
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

HealthcareService.referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.
HealthcareService.appointmentRequired 0..1 boolean If an appointment is required for access to this service
HealthcareService.availableTime 0..* BackboneElement Times the Service Site is available
HealthcareService.availableTime.id 0..1 string Unique id for inter-element referencing
HealthcareService.availableTime.extension 0..* Extension Additional content defined by implementations
HealthcareService.availableTime.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.availableTime.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
HealthcareService.availableTime.allDay 0..1 boolean Always available? e.g. 24 hour service
HealthcareService.availableTime.availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
HealthcareService.availableTime.availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
HealthcareService.notAvailable 0..* BackboneElement Not available during this time due to provided reason
HealthcareService.notAvailable.id 0..1 string Unique id for inter-element referencing
HealthcareService.notAvailable.extension 0..* Extension Additional content defined by implementations
HealthcareService.notAvailable.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.notAvailable.description 1..1 string Reason presented to the user explaining why time not available
HealthcareService.notAvailable.during 0..1 Period Service not available from this date
HealthcareService.availabilityExceptions 0..1 string Description of availability exceptions
HealthcareService.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.language Base preferred Common Languages 📍4.0.1 FHIR Std.
HealthcareService.category Base example Service category 📍4.0.1 FHIR Std.
HealthcareService.type Base example Service type 📍4.0.1 FHIR Std.
HealthcareService.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
HealthcareService.serviceProvisionCode Base example ServiceProvisionConditions 📍4.0.1 FHIR Std.
HealthcareService.eligibility.​code Base example Not State Unknown
HealthcareService.program Base example Program 📍4.0.1 FHIR Std.
HealthcareService.characteristic Base example Not State Unknown
HealthcareService.communication Base preferred Common Languages 📍4.0.1 FHIR Std.
HealthcareService.referralMethod Base example ReferralMethod 📍4.0.1 FHIR Std.
HealthcareService.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
HealthcareService.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
HealthcareService.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HealthcareService.Slices for extension.extension:dhb 0..1 CodeableConcept District Health Board linked to a NZ Healthcare Service, Location or Patient
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
HealthcareService.Slices for extension.extension:funded-programme 0..* (Complex) Funded Healthcare Programme
URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
HealthcareService.Slices for extension.extension:pho 0..1 CodeableConcept Primary Healthcare Organisation
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
HealthcareService.Slices for extension.extension:messaging-address 0..* (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
HealthcareService.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
HealthcareService.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this HealthcareService record is in active use

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraints    Filter: doco
HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
HealthcareService.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HealthcareService.Slices for extension.extension:dhb 0..1 CodeableConcept District Health Board linked to a NZ Healthcare Service, Location or Patient
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
HealthcareService.Slices for extension.extension:funded-programme 0..* (Complex) Funded Healthcare Programme
URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
HealthcareService.Slices for extension.extension:pho 0..1 CodeableConcept Primary Healthcare Organisation
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
HealthcareService.Slices for extension.extension:messaging-address 0..* (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
HealthcareService.id This element is included in summaries. 0..1 id Logical id of this artifact
HealthcareService.meta This element is included in summaries. 0..1 Meta Metadata about the resource
HealthcareService.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
HealthcareService.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
HealthcareService.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
HealthcareService.contained 0..* Resource Contained, inline Resources
HealthcareService.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HealthcareService.Slices for extension.extension:dhb 0..1 CodeableConcept District Health Board linked to a NZ Healthcare Service, Location or Patient
URL: http://hl7.org.nz/fhir/StructureDefinition/dhb
Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
HealthcareService.Slices for extension.extension:funded-programme 0..* (Complex) Funded Healthcare Programme
URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
HealthcareService.Slices for extension.extension:pho 0..1 CodeableConcept Primary Healthcare Organisation
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
HealthcareService.Slices for extension.extension:messaging-address 0..* (Complex) Messaging Address
URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
HealthcareService.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
HealthcareService.identifier This element is included in summaries. 0..* Identifier External identifiers for this item
HealthcareService.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this HealthcareService record is in active use
HealthcareService.providedBy This element is included in summaries. 0..1 Reference(Organization) Organization that provides this service
HealthcareService.category This element is included in summaries. 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.
HealthcareService.type This element is included in summaries. 0..* CodeableConcept Type of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).
HealthcareService.specialty This element is included in summaries. 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.
HealthcareService.location This element is included in summaries. 0..* Reference(Location) Location(s) where service may be provided
HealthcareService.name This element is included in summaries. 0..1 string Description of service as presented to a consumer while searching
HealthcareService.comment This element is included in summaries. 0..1 string Additional description and/or any specific issues not covered elsewhere
HealthcareService.extraDetails 0..1 markdown Extra details about the service that can't be placed in the other fields
HealthcareService.photo This element is included in summaries. 0..1 Attachment Facilitates quick identification of the service
HealthcareService.telecom 0..* ContactPoint Contacts related to the healthcare service
HealthcareService.coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
HealthcareService.serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
HealthcareService.eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
HealthcareService.eligibility.id 0..1 string Unique id for inter-element referencing
HealthcareService.eligibility.extension 0..* Extension Additional content defined by implementations
HealthcareService.eligibility.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.eligibility.code 0..1 CodeableConcept Coded value for the eligibility
Binding Description: (example): Coded values underwhich a specific service is made available.
HealthcareService.eligibility.comment 0..1 markdown Describes the eligibility conditions for the service
HealthcareService.program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.
HealthcareService.characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
HealthcareService.communication 0..* CodeableConcept The language that this service is offered in
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

HealthcareService.referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.
HealthcareService.appointmentRequired 0..1 boolean If an appointment is required for access to this service
HealthcareService.availableTime 0..* BackboneElement Times the Service Site is available
HealthcareService.availableTime.id 0..1 string Unique id for inter-element referencing
HealthcareService.availableTime.extension 0..* Extension Additional content defined by implementations
HealthcareService.availableTime.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.availableTime.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
HealthcareService.availableTime.allDay 0..1 boolean Always available? e.g. 24 hour service
HealthcareService.availableTime.availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
HealthcareService.availableTime.availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
HealthcareService.notAvailable 0..* BackboneElement Not available during this time due to provided reason
HealthcareService.notAvailable.id 0..1 string Unique id for inter-element referencing
HealthcareService.notAvailable.extension 0..* Extension Additional content defined by implementations
HealthcareService.notAvailable.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.notAvailable.description 1..1 string Reason presented to the user explaining why time not available
HealthcareService.notAvailable.during 0..1 Period Service not available from this date
HealthcareService.availabilityExceptions 0..1 string Description of availability exceptions
HealthcareService.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.language Base preferred Common Languages 📍4.0.1 FHIR Std.
HealthcareService.category Base example Service category 📍4.0.1 FHIR Std.
HealthcareService.type Base example Service type 📍4.0.1 FHIR Std.
HealthcareService.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
HealthcareService.serviceProvisionCode Base example ServiceProvisionConditions 📍4.0.1 FHIR Std.
HealthcareService.eligibility.​code Base example Not State Unknown
HealthcareService.program Base example Program 📍4.0.1 FHIR Std.
HealthcareService.characteristic Base example Not State Unknown
HealthcareService.communication Base preferred Common Languages 📍4.0.1 FHIR Std.
HealthcareService.referralMethod Base example ReferralMethod 📍4.0.1 FHIR Std.
HealthcareService.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

 

Other representations of profile: CSV, Excel, Schematron