HL7® FHIR® New Zealand Base Implementation Guide
1.2.0 - CI Build

HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This is not an authorized publication; it is the continuous build for version 1.2.0). 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.2.0
Draft as of 2022-08-11 Realm: New Zealand flag Computable Name: NzHealthcareService

HealthcareService resource for use in NZ

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from HealthcareService

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... dhb 0..1CodeableConceptDistrict 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

... funded-programme 0..1(Complex)Funded Healthcare Programme
URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... dhb 0..1CodeableConceptDistrict 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


... funded-programme 0..1(Complex)Funded Healthcare Programme
URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifiers for this item
... active ?!Σ0..1booleanWhether this HealthcareService record is in active use
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... category Σ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).


... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.


... location Σ0..*Reference(Location)Location(s) where service may be provided
... name Σ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom 0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(Location)Location(s) service is intended for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.


... eligibility 0..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

This structure is derived from HealthcareService

Differential View

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... dhb 0..1CodeableConceptDistrict 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

... funded-programme 0..1(Complex)Funded Healthcare Programme
URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... dhb 0..1CodeableConceptDistrict 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


... funded-programme 0..1(Complex)Funded Healthcare Programme
URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifiers for this item
... active ?!Σ0..1booleanWhether this HealthcareService record is in active use
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... category Σ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).


... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.


... location Σ0..*Reference(Location)Location(s) where service may be provided
... name Σ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom 0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(Location)Location(s) service is intended for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.


... eligibility 0..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication 0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.


... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
HealthcareService.languagepreferredCommonLanguages
Max Binding: AllLanguages
HealthcareService.categoryexampleServiceCategory
HealthcareService.typeexampleServiceType
HealthcareService.specialtypreferredPracticeSettingCodeValueSet
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
HealthcareService.characteristicexample
HealthcareService.communicationpreferredCommonLanguages
Max Binding: AllLanguages
HealthcareService.referralMethodexampleReferralMethod
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek