Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/NationalHealthCareService | Version: 0.0.1 | |||
| Draft as of 2026-10-13 | Computable Name: NationalHealthCareService | |||
A HealthcareService Resource used to record the details of the service
A HealthcareService Resource used to record the details of the service
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
  identifier |
1..1 | Identifier | External identifiers for this item | |
 use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
 value |
1..1 | string | The value that is unique Example General: 123456 | |
| active |
1..1 | boolean | Whether this HealthcareService record is in active use | |
| name |
1..1 | string | Description of service as presented to a consumer while searching | |
| telecom |
1..* | ContactPoint | Contacts related to the healthcare service | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |
 meta |
||||
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| contained |
0..0 | Contained, inline Resources | ||
| identifier |
1..1 | Identifier | External identifiers for this item | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| active |
1..1 | boolean | Whether this HealthcareService record is in active use | |
| name |
1..1 | string | Description of service as presented to a consumer while searching | |
| telecom |
1..* | ContactPoint | Contacts related to the healthcare service | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..1 | Identifier | External identifiers for this item | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
 assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| active |
1..1 | boolean | Whether this HealthcareService record is in active use | |||||
| providedBy |
0..1 | Reference(Organization) | Organization that provides this service | |||||
| category |
0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | |||||
| type |
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). | |||||
| specialty |
0..* | CodeableConcept | Specialties 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 |
1..1 | string | Description of service as presented to a consumer while searching | |||||
| comment |
0..1 | string | Additional description and/or any specific issues not covered elsewhere | |||||
| extraDetails |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo |
0..1 | Attachment | Facilitates quick identification of the service | |||||
| telecom |
1..* | ContactPoint | Contacts related to the healthcare service | |||||
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
| 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. | |||||
| eligibility |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available. | |||||
| comment |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
| characteristic |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
| communication |
0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
| 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. | |||||
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| HealthcareService.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| HealthcareService.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier.type | Base | extensible | IdentifierType | 📍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. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from HealthcareService
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
1..1 | Identifier | External identifiers for this item | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| active |
1..1 | boolean | Whether this HealthcareService record is in active use | |
| name |
1..1 | string | Description of service as presented to a consumer while searching | |
| telecom |
1..* | ContactPoint | Contacts related to the healthcare service | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |
| meta |
||||
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| contained |
0..0 | Contained, inline Resources | ||
| identifier |
1..1 | Identifier | External identifiers for this item | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| active |
1..1 | boolean | Whether this HealthcareService record is in active use | |
| name |
1..1 | string | Description of service as presented to a consumer while searching | |
| telecom |
1..* | ContactPoint | Contacts related to the healthcare service | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..1 | Identifier | External identifiers for this item | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| active |
1..1 | boolean | Whether this HealthcareService record is in active use | |||||
| providedBy |
0..1 | Reference(Organization) | Organization that provides this service | |||||
| category |
0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | |||||
| type |
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). | |||||
| specialty |
0..* | CodeableConcept | Specialties 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 |
1..1 | string | Description of service as presented to a consumer while searching | |||||
| comment |
0..1 | string | Additional description and/or any specific issues not covered elsewhere | |||||
| extraDetails |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo |
0..1 | Attachment | Facilitates quick identification of the service | |||||
| telecom |
1..* | ContactPoint | Contacts related to the healthcare service | |||||
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
| 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. | |||||
| eligibility |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available. | |||||
| comment |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
| characteristic |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
| communication |
0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
| 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. | |||||
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| HealthcareService.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| HealthcareService.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| HealthcareService.identifier.type | Base | extensible | IdentifierType | 📍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. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from HealthcareService
Other representations of profile: CSV, Excel, Schematron