Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Record Of all healthcare services

A HealthcareService Resource used to record the details of the service

A HealthcareService Resource used to record the details of the service

Usage:

• Examples for this Resource Profile: National Breast Screening Programme

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	HealthcareService	The details of a healthcare service available at a location dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..1	Identifier	External identifiers for this item ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
active	?!Σ	1..1	boolean	Whether this HealthcareService record is in active use ele-1: All FHIR elements must have a @value or children
name	Σ	1..1	string	Description of service as presented to a consumer while searching ele-1: All FHIR elements must have a @value or children
telecom		1..*	ContactPoint	Contacts related to the healthcare service ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard

This structure is derived from HealthcareService

Name	Flags	Card.	Type	Description & Constraints
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
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
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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 (No ValueSet): (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 (No ValueSet): (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. Additional Bindings Purpose AllLanguages Max Binding
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

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
HealthcareService.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
HealthcareService.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
HealthcareService.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
HealthcareService.category	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
HealthcareService.type	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
HealthcareService.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
HealthcareService.serviceProvisionCode	example	ServiceProvisionConditions http://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard
HealthcareService.eligibility.code	example
HealthcareService.program	example	Program http://hl7.org/fhir/ValueSet/program from the FHIR Standard
HealthcareService.characteristic	example
HealthcareService.communication	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.referralMethod	example	ReferralMethod http://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard
HealthcareService.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

This structure is derived from HealthcareService

Summary

Mandatory: 7 elements(1 nested mandatory element)
Prohibited: 1 element

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	HealthcareService	The details of a healthcare service available at a location dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	Σ	1..1	Identifier	External identifiers for this item ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
active	?!Σ	1..1	boolean	Whether this HealthcareService record is in active use ele-1: All FHIR elements must have a @value or children
name	Σ	1..1	string	Description of service as presented to a consumer while searching ele-1: All FHIR elements must have a @value or children
telecom		1..*	ContactPoint	Contacts related to the healthcare service ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard

Differential View

This structure is derived from HealthcareService

Name	Flags	Card.	Type	Description & Constraints
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
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
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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 (No ValueSet): (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 (No ValueSet): (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. Additional Bindings Purpose AllLanguages Max Binding
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

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
HealthcareService.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
HealthcareService.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
HealthcareService.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
HealthcareService.category	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
HealthcareService.type	example	ServiceType http://hl7.org/fhir/ValueSet/service-type from the FHIR Standard
HealthcareService.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
HealthcareService.serviceProvisionCode	example	ServiceProvisionConditions http://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard
HealthcareService.eligibility.code	example
HealthcareService.program	example	Program http://hl7.org/fhir/ValueSet/program from the FHIR Standard
HealthcareService.characteristic	example
HealthcareService.communication	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.referralMethod	example	ReferralMethod http://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard
HealthcareService.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

This structure is derived from HealthcareService

Summary

Mandatory: 7 elements(1 nested mandatory element)
Prohibited: 1 element

Other representations of profile: CSV, Excel, Schematron