Status: Active: Approved (STU)

Introduction

This profile sets minimum expectations for the HealthcareService resource.

The HealthcareService resource is used to describe a single healthcare service or category of services that are provided by an organization at a location. The location of the services could be virtual, as with telemedicine services.

The HealthcareService resource can be used with the Schedule resource to define actual availability of the service.

Mandatory fields

The following mandatory fields are defined:

1. Active - Essential if not active. Good practice to always populate anyway.

2. Type - The type of service that may be delivered or performed (ideally this would be an identifiable service - which is at a location, rather than the location itself). We pre-adopt the UKCore value set (based on SNOMED refset 1127531000000102: Services Simple Reference Set) - for consistency with the Encounter, and because it is more relevant than the default FHIR example and also covers social care.

3. Name - The name of the Healthcare Serivice as presented to a consumer while searching.

Must Support fields

In addition the following fields are “Must Support” - ie they must be populated if relevant and known.

1. Specialty - further information which may be useful about the type of specialty required. Knowing the Service Type is probably sufficient for a shared care record, with the Specialty being more relevant to resourcing the correct staff member in a scheduling system. However obviously useful additional information if available. We replace the default FHIR valueset with the list of SDS Job Roles - which appears to be more complete and relevant to the UK, and which offers better coverage of Social Care.

2. Telecom - List of contacts related to this specific healthcare service, If this is empty, then refer to the location’s contacts. Eg phone and/or email details. Useful for getting in contact for further information

3. Appointment Required - Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

4. Coverage Area - The location(s) that this service is available to (not where the service is provided).

5. Available Time - A collection of times that the Service Site is available. More detailed availability information may be provided in associated Schedule/Slot resources.

6. Availability Exceptions - A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times.

Optional fields

Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Points of note include:

• Provided By - Organization that provides this service. Note: this will often be the same as the provenance of the message, but not necessarily if external locations are being referenced

• Category - A general description under broad categorisation of the types of services that is to be performed during this appointment.

• Location - the location provides essential information about where the service will take place. Exactly what is appropriate here will depend on the care setting:
  • For a hospital information should be provided down to the “clinic” level. Thus making it easir to find, as well as potentially giving some insight into the type of treatment being provided.
  • For other (smaller) locations then the “site” level may be sufficient
  • Other types of care (eg community, emergency) may take place at home or in a vehicle

• comment - Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.

• Program - Programs that this service is applicable to. Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program etc. that this service applies to.

• Characteristic - Collection of characteristics such things as ‘is wheelchair accessible’. we have pre-adopted R5 serviceMode valueset as preferred binding.

• Referral Method - The methods of referral can be used when referring to a specific HealthcareService resource

Discouraged or Removed fields

• extraDetails - REMOVED. Extra details about the service that can’t be placed in the other fields.

• Photo - REMOVED. Not relevant here, and adds size and complexity to the content.

• Service Provision Code - DISCOURAGED. The code(s) that detail the conditions under which the healthcare service is available/offered.

• Eligibility - REMOVED. Does this service have specific eligibility requirements that need to be met in order to use the service.

• Eligibility Note - REMOVED. Describes the eligibility conditions for the service. Inline with R4 we have also removed this element.

• Communication - DISCOURAGED. Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. Not relevant to current use-cases within the Shared care record.

• notAvailable - DISCOURAGED. The HealthcareService is not available during this period of time due to the provided reason..

• Endpoint - REMOVED. Technical endpoints are captured elsewhere (ie via the Participant Registry)

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

This structure is derived from CareConnect-HealthcareService-1

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	CareConnect-HealthcareService-1	The details of a healthcare service available at a location
id	S	0..1	id	Logical id of this artifact
meta
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
program		0..1	CodeableConcept	Programs that this service is applicable to (pre-adopted from R4) URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4HealthcareServiceProgram Binding: Interweave R4 Healthcare Service Program (preferred)
active	S	1..1	boolean	Whether this healthcareservice is in active use
category		0..1	CodeableConcept	Broad category of service being performed or delivered Binding: Service category (preferred)
type	S	1..*	CodeableConcept	Type of service that may be delivered or performed Binding: Interweave UkCore Care Setting Type (preferred)
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
specialty		0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Care Connect SDS Job Role Name (preferred)
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
name	S	1..1	string	Description of service as presented to a consumer while searching
extraDetails		0..0
photo		0..0
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
coverageArea	S	0..*	Reference(Location)	Location(s) service is inteded for/available to
eligibility		0..0
eligibilityNote		0..0
programName		0..0
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding: InterweaveCodesCharacteristicServiceMode (preferred)
referralMethod		0..*	CodeableConcept	Ways that the service accepts referrals Binding: Care Connect Referral Request Method (preferred)
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	S	0..*	BackboneElement	Times the Service Site is available
notAvailable		0..*	BackboneElement	DISCOURAGED - Not available during this time due to provided reason
endpoint		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
HealthcareService.category	preferred	ServiceCategory
HealthcareService.type	preferred	Interweave UkCore Care Setting Type
HealthcareService.specialty	preferred	Care Connect SDS Job Role Name
HealthcareService.characteristic	preferred	InterweaveCodesCharacteristicServiceMode
HealthcareService.referralMethod	preferred	Care Connect Referral Request Method

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	CareConnect-HealthcareService-1	The details of a healthcare service available at a location
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
program		0..1	CodeableConcept	Programs that this service is applicable to (pre-adopted from R4) URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4HealthcareServiceProgram Binding: Interweave R4 Healthcare Service Program (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..1	Identifier	External identifiers for this item
active	?!SΣ	1..1	boolean	Whether this healthcareservice is in active use
category	Σ	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: Service category (preferred)
type	SΣ	1..*	CodeableConcept	Type of service that may be delivered or performed Binding: Interweave UkCore Care Setting Type (preferred)
specialty	Σ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Care Connect SDS Job Role Name (preferred)
name	SΣ	1..1	string	Description of service as presented to a consumer while searching
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
coverageArea	S	0..*	Reference(Location)	Location(s) service is inteded for/available to
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding: InterweaveCodesCharacteristicServiceMode (preferred)
referralMethod		0..*	CodeableConcept	Ways that the service accepts referrals Binding: Care Connect Referral Request Method (preferred)
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	S	0..*	BackboneElement	Times the Service Site is available
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
notAvailable		0..*	BackboneElement	DISCOURAGED - Not available during this time due to provided reason
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
description		1..1	string	Reason presented to the user explaining why time not available
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
HealthcareService.meta.security	extensible	All Security Labels
HealthcareService.meta.tag	example	Common Tags
HealthcareService.meta.tag:Source	example	Common Tags
HealthcareService.meta.tag:Provenance	example	Common Tags
HealthcareService.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.category	preferred	ServiceCategory
HealthcareService.type	preferred	Interweave UkCore Care Setting Type
HealthcareService.specialty	preferred	Care Connect SDS Job Role Name
HealthcareService.characteristic	preferred	InterweaveCodesCharacteristicServiceMode
HealthcareService.referralMethod	preferred	Care Connect Referral Request Method

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	HealthcareService	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	CareConnect-HealthcareService-1	The details of a healthcare service available at a location
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
program		0..1	CodeableConcept	Programs that this service is applicable to (pre-adopted from R4) URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4HealthcareServiceProgram Binding: Interweave R4 Healthcare Service Program (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..1	Identifier	External identifiers for this item
active	?!SΣ	1..1	boolean	Whether this healthcareservice is in active use
providedBy	Σ	0..1	Reference(Organization)	Organization that provides this service
category	Σ	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: Service category (preferred)
type	SΣ	1..*	CodeableConcept	Type of service that may be delivered or performed Binding: Interweave UkCore Care Setting Type (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
specialty	Σ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Care Connect SDS Job Role Name (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
location	Σ	0..*	Reference(Location)	Location(s) where service may be provided
name	SΣ	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
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
coverageArea	S	0..*	Reference(Location)	Location(s) service is inteded 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.
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding: InterweaveCodesCharacteristicServiceMode (preferred)
referralMethod		0..*	CodeableConcept	Ways that the service accepts referrals Binding: Care Connect Referral Request Method (preferred)
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	S	0..*	BackboneElement	Times the Service Site is available
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
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	DISCOURAGED - Not available during this time due to provided reason
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not availablefrom this date
availabilityExceptions		0..1	string	Description of availability exceptions
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
HealthcareService.meta.security	extensible	All Security Labels
HealthcareService.meta.tag	example	Common Tags
HealthcareService.meta.tag:Source	example	Common Tags
HealthcareService.meta.tag:Provenance	example	Common Tags
HealthcareService.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.category	preferred	ServiceCategory
HealthcareService.type	preferred	Interweave UkCore Care Setting Type
HealthcareService.specialty	preferred	Care Connect SDS Job Role Name
HealthcareService.serviceProvisionCode	example	ServiceProvisionConditions
HealthcareService.characteristic	preferred	InterweaveCodesCharacteristicServiceMode
HealthcareService.referralMethod	preferred	Care Connect Referral Request Method
HealthcareService.availableTime.daysOfWeek	required	DaysOfWeek

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from CareConnect-HealthcareService-1

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	CareConnect-HealthcareService-1	The details of a healthcare service available at a location
id	S	0..1	id	Logical id of this artifact
meta
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
program		0..1	CodeableConcept	Programs that this service is applicable to (pre-adopted from R4) URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4HealthcareServiceProgram Binding: Interweave R4 Healthcare Service Program (preferred)
active	S	1..1	boolean	Whether this healthcareservice is in active use
category		0..1	CodeableConcept	Broad category of service being performed or delivered Binding: Service category (preferred)
type	S	1..*	CodeableConcept	Type of service that may be delivered or performed Binding: Interweave UkCore Care Setting Type (preferred)
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
specialty		0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Care Connect SDS Job Role Name (preferred)
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
name	S	1..1	string	Description of service as presented to a consumer while searching
extraDetails		0..0
photo		0..0
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
coverageArea	S	0..*	Reference(Location)	Location(s) service is inteded for/available to
eligibility		0..0
eligibilityNote		0..0
programName		0..0
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding: InterweaveCodesCharacteristicServiceMode (preferred)
referralMethod		0..*	CodeableConcept	Ways that the service accepts referrals Binding: Care Connect Referral Request Method (preferred)
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	S	0..*	BackboneElement	Times the Service Site is available
notAvailable		0..*	BackboneElement	DISCOURAGED - Not available during this time due to provided reason
endpoint		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
HealthcareService.category	preferred	ServiceCategory
HealthcareService.type	preferred	Interweave UkCore Care Setting Type
HealthcareService.specialty	preferred	Care Connect SDS Job Role Name
HealthcareService.characteristic	preferred	InterweaveCodesCharacteristicServiceMode
HealthcareService.referralMethod	preferred	Care Connect Referral Request Method

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	CareConnect-HealthcareService-1	The details of a healthcare service available at a location
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
program		0..1	CodeableConcept	Programs that this service is applicable to (pre-adopted from R4) URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4HealthcareServiceProgram Binding: Interweave R4 Healthcare Service Program (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..1	Identifier	External identifiers for this item
active	?!SΣ	1..1	boolean	Whether this healthcareservice is in active use
category	Σ	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: Service category (preferred)
type	SΣ	1..*	CodeableConcept	Type of service that may be delivered or performed Binding: Interweave UkCore Care Setting Type (preferred)
specialty	Σ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Care Connect SDS Job Role Name (preferred)
name	SΣ	1..1	string	Description of service as presented to a consumer while searching
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
coverageArea	S	0..*	Reference(Location)	Location(s) service is inteded for/available to
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding: InterweaveCodesCharacteristicServiceMode (preferred)
referralMethod		0..*	CodeableConcept	Ways that the service accepts referrals Binding: Care Connect Referral Request Method (preferred)
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	S	0..*	BackboneElement	Times the Service Site is available
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
notAvailable		0..*	BackboneElement	DISCOURAGED - Not available during this time due to provided reason
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
description		1..1	string	Reason presented to the user explaining why time not available
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
HealthcareService.meta.security	extensible	All Security Labels
HealthcareService.meta.tag	example	Common Tags
HealthcareService.meta.tag:Source	example	Common Tags
HealthcareService.meta.tag:Provenance	example	Common Tags
HealthcareService.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.category	preferred	ServiceCategory
HealthcareService.type	preferred	Interweave UkCore Care Setting Type
HealthcareService.specialty	preferred	Care Connect SDS Job Role Name
HealthcareService.characteristic	preferred	InterweaveCodesCharacteristicServiceMode
HealthcareService.referralMethod	preferred	Care Connect Referral Request Method

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	HealthcareService	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	CareConnect-HealthcareService-1	The details of a healthcare service available at a location
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
program		0..1	CodeableConcept	Programs that this service is applicable to (pre-adopted from R4) URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4HealthcareServiceProgram Binding: Interweave R4 Healthcare Service Program (preferred)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..1	Identifier	External identifiers for this item
active	?!SΣ	1..1	boolean	Whether this healthcareservice is in active use
providedBy	Σ	0..1	Reference(Organization)	Organization that provides this service
category	Σ	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: Service category (preferred)
type	SΣ	1..*	CodeableConcept	Type of service that may be delivered or performed Binding: Interweave UkCore Care Setting Type (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
specialty	Σ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Care Connect SDS Job Role Name (preferred)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
location	Σ	0..*	Reference(Location)	Location(s) where service may be provided
name	SΣ	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
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
coverageArea	S	0..*	Reference(Location)	Location(s) service is inteded 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.
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding: InterweaveCodesCharacteristicServiceMode (preferred)
referralMethod		0..*	CodeableConcept	Ways that the service accepts referrals Binding: Care Connect Referral Request Method (preferred)
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	S	0..*	BackboneElement	Times the Service Site is available
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
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	DISCOURAGED - Not available during this time due to provided reason
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not availablefrom this date
availabilityExceptions		0..1	string	Description of availability exceptions
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
HealthcareService.meta.security	extensible	All Security Labels
HealthcareService.meta.tag	example	Common Tags
HealthcareService.meta.tag:Source	example	Common Tags
HealthcareService.meta.tag:Provenance	example	Common Tags
HealthcareService.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.category	preferred	ServiceCategory
HealthcareService.type	preferred	Interweave UkCore Care Setting Type
HealthcareService.specialty	preferred	Care Connect SDS Job Role Name
HealthcareService.serviceProvisionCode	example	ServiceProvisionConditions
HealthcareService.characteristic	preferred	InterweaveCodesCharacteristicServiceMode
HealthcareService.referralMethod	preferred	Care Connect Referral Request Method
HealthcareService.availableTime.daysOfWeek	required	DaysOfWeek

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from CareConnect-HealthcareService-1

Summary

Mandatory: 3 elements (12 nested mandatory elements)
Must-Support: 17 elements
Fixed Value: 2 elements
Prohibited: 6 elements

Extensions

This structure refers to these extensions:

• https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-R4HealthcareServiceProgram

Slices

This structure defines the following Slices:

• The element HealthcareService.meta.tag is sliced based on the value of value:system