FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.8 Resource HealthcareService - Content

Patient Administration icon Work GroupMaturity Level: 4 Trial UseSecurity Category: Business Compartments: No defined compartments

The details of a healthcare service available at a location.

8.8.1 Scope and Usage

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.

Common examples of HealthcareServices resources are:

  • Allied Health
  • Clinical Neuropsychologist
  • Podiatry Service
  • Smallville Hospital Emergency Services
  • Respite care provided at a nursing home or hostel
  • 24hr crisis telephone counseling service
  • Information, advice and/or referral services; Disability, Telecommunications
  • Rural TeleHealth Services
  • Hospital in the home
  • Yellow Cabs
  • Pharmacy
  • Active Rehab
  • Social Support
  • Drug and/or alcohol counseling
  • Day Programs, Adult Training & Support Services
  • Consulting psychologists and/or psychology services
  • Group Hydrotherapy
  • Little River Home Maintenance
  • CT Head Scan w/o Contrast
  • CT Head Scan with Contrast
  • CT Head+Chest Scan with Contrast

HealthcareService resources do not represent Computer related Services (not SOA)

Example uses of HealthcareService resources are:

  • National Services Directory - Consumer Focus
  • National Services Directory - Practitioner Referrals Searching
  • Organization's Client Portal - to locate services / book appointments
  • Address book of services for Referrals
    including references to Questionnaires for assessments that are required as part of the referral
  • Health Network internal directory Used for tracking available services offered internally, and also those offered by business partners.
    This information may also include costing information.
  • Catalog of schedulable services or activities

8.8.2 Boundaries and Relationships

The HealthcareService resource can be used with the Schedule resource to define actual availability of the service. This would be done by using the Schedule's Actor property.

When creating an Appointment, the HealthcareService is to be assigned to one of the participants.
It is up to the scheduling system to determine if the service is available and can be accepted.

The HealthcareService resource is used with the following resources:

  • Organization: The organization provides the services, the healthcareservice describes the services
  • ServiceRequest: This is a subject specific request for a specific service, it may be to a specific healthcare service, and/or simply a coded service value. The granularity included in the request codes may be finer than defined in the healthcare service.
  • OrganizationAffiliation: Might constrain a list of healthcare services that are available between 2 organizations
  • Location: Specifies the place where the service(s) are offered/available within.

8.8.3 References to this Resource

8.8.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService TU DomainResource The details of a healthcare service available at a location

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier External identifiers for this item

... active ?!Σ 0..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: Service Category (Example)

... type Σ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: Service Type (Example)

... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: Practice Setting Code Value Set (Preferred)

... location Σ 0..* Reference(Location) Location(s) where service may be provided

... name Σ 0..1 string Description of service as presented to a consumer while searching
... comment Σ 0..1 markdown 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
... contact 0..* ExtendedContactDetail Official contact details for the HealthcareService

... coverageArea 0..* Reference(Location) Location(s) service is intended for/available to

... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: Service Provision Conditions (Example)

... eligibility C 0..* BackboneElement Specific eligibility requirements required to use the service
+ Rule: To use an eligibility value a code must also be provided to determine the type of eligibility the value applies to.

.... code C 0..1 CodeableConcept Coded value for the eligibility
Binding: Eligibility Characteristics (Example)
.... value[x] C 0..1 Value associated with the eligibility code
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference()
.... comment 0..1 markdown Describes the eligibility conditions for the service
.... period 0..1 markdown The period this eligibility rule applies
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (Example)

... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: Service Mode (Example)

... communication 0..* CodeableConcept The language that this service is offered in
Binding: All Languages (Required)
Additional BindingsPurpose
Common Languages Starter Set


... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: Referral Method (Example)

... referralRequired 0..1 boolean A referral is required for access to this service
... appointmentRequired 0..1 boolean An appointment is required for access to this service
... availability 0..1 Availability Times the healthcare service is available (including exceptions)
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service


doco Documentation for this format icon

See the Extensions for this resource

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

8.8.4.1 Terminology Bindings

Path ValueSet Type Documentation
HealthcareService.category ServiceCategory Example

This value set defines an example set of codes that can be used to classify groupings of service-types/specialties.
HealthcareService.type ServiceType Example

This value set defines an example set of codes of service-types.
HealthcareService.specialty PracticeSettingCodeValueSet Preferred

This is the code representing the clinical specialty of the clinician or provider who interacted with, treated, or provided a service to/for the patient. The value set used for clinical specialty has been limited by HITSP to the value set reproduced from HITSP C80 Table 2-149 Clinical Specialty Value Set Definition.
HealthcareService.serviceProvisionCode ServiceProvisionConditions Example

The code(s) that detail the conditions under which the healthcare service is available/offered.
HealthcareService.eligibility.code Eligibility (a valid code from Eligibility Characteristics) Example

Example set of HealthcareService eligibility codes
HealthcareService.program Program Example

This value set defines an example set of codes that could be can be used to classify groupings of service-types/specialties.
HealthcareService.characteristic ServiceMode Example

An example set of Service Modes that could be applicable to use to characterize HealthcareServices or PractitionerRoles while searching
HealthcareService.communication AllLanguages (a valid code from Tags for the Identification of Languages icon) Required

This value set includes all possible codes from BCP-47 (see http://tools.ietf.org/html/bcp47)
  Common Languages starter
HealthcareService.referralMethod ReferralMethod Example

The methods of referral can be used when referring to a specific HealthcareService resource.

8.8.4.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img hcs-1Rule HealthcareService.eligibilityTo use an eligibility value a code must also be provided to determine the type of eligibility the value applies to.value.exists() implies code.exists()

8.8.5 Notes:

  • The HealthcareService could be mapped to components of the IHE Care Services Directory, and/or the OMG ServD standards

8.8.5.1 Single or Multiple Locations

When deciding to whether to use multiple locations on a single HealthcareService, or create multiple HealthcareService resources for each location on each you should consider:

  • are availability hours different? (hours of operation on location - and why they can be different) - e.g. some services are only available for restricted hours
  • are contact details different? (special contact number for service, not a location based number)
  • are endpoint details different?
  • are there different characteristics at different locations? (e.g. wheelchair accessible)
  • are the coverageAreas the different?
  • how is all this data managed - and does it cause resources to need to be split/merged when things change (and what impact does that have downstream - i.e. replicated directories)

Any/all of these factors could require constraining the use down to a single location on the resource and create separate HealthcareService resources covering the details of the referenced Location.

In a case where all this data is the same across all locations, then a single HealthcareService resource instance can be used with all the locations listed on it.

Note that if the contact/availability/endpoint details of the HealthcareService are the same as the Location, then these may be omitted from the HealthcareService and use the Location (thus reducing administrative burden)

8.8.6 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
active token The Healthcare Service is currently marked as active HealthcareService.active
characteristic token One of the HealthcareService's characteristics HealthcareService.characteristic
communication token Languages that are available at this service HealthcareService.communication
coverage-area reference Location(s) service is intended for/available to HealthcareService.coverageArea
(Location)
eligibility token One of the HealthcareService's eligibility requirements HealthcareService.eligibility.code
endpoint reference Technical endpoints providing access to electronic services operated for the healthcare service HealthcareService.endpoint
(Endpoint)
identifier token External identifiers for this item HealthcareService.identifier
location reference The location of the Healthcare Service HealthcareService.location
(Location)
name string A portion of the Healthcare service name HealthcareService.name
offered-in reference The service within which this service is offered HealthcareService.offeredIn
(HealthcareService)
organization reference The organization that provides this Healthcare Service HealthcareService.providedBy
(Organization)
program token One of the Programs supported by this HealthcareService HealthcareService.program
service-category token Service Category of the Healthcare Service HealthcareService.category
service-type token The type of service provided by this healthcare service HealthcareService.type
specialty token The specialty of the service provided by this healthcare service HealthcareService.specialty