This
page
is
part
of
the
FHIR
Specification
(v0.0.82:
(v1.0.2:
DSTU
1).
2).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Patient
Administration
Work
Group
|
Maturity Level : 1 | Compartments : Not linked to any defined compartments |
The
details
of
a
Healthcare
Service
healthcare
service
available
at
a
location.
The
HealthcareService
resource
is
used
to
describe
a
single
healthcare
service
or
category
of
services
that
is
being
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:
HealthcareService resources do not represent Computer related Services (not SOA)
Example uses of HealthcareService resources are:
The
Schedule
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.
This
resource
is
referenced
by
Account
,
Appointment
,
AppointmentResponse
and
,
Practitioner
and
Schedule
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
DomainResource |
The
details
of
a
|
||
|
Σ | 0..* | Identifier |
External
|
|
Σ | 0..1 | Reference ( Organization ) |
Organization
that
provides
this
|
|
Σ | 0..1 | CodeableConcept |
Broad
category
of
service
being
performed
or
|
|
Σ | 0..* |
|
Specific
service
|
|
Σ | 1..1 | CodeableConcept |
Type
of
service
|
|
Σ | 0..* | CodeableConcept |
Specialties
handled
by
the
Service
|
| Σ | 1..1 | Reference ( Location ) | Location where service may be provided |
![]() ![]() |
Σ | 0..1 | string |
Description
of
|
|
Σ | 0..1 | string |
Additional
description
|
|
0..1 | string | Extra details about the service that can't be placed in the other fields | |
|
Σ | 0..1 | Attachment |
Facilitates
quick
identification
of
the
service
|
|
0..* | ContactPoint |
Contacts
related
to
|
|
|
0..* | Reference ( Location ) |
Location(s)
service
is
|
|
| 0..* | CodeableConcept |
Conditions
under
which
service
is
ServiceProvisionConditions ( Example ) |
|
|
0..1 | CodeableConcept |
Specific
eligibility
requirements
|
|
|
0..1 | string | Describes the eligibility conditions for the service | |
|
0..* | string |
Program
Names
that
|
|
|
0..* | CodeableConcept |
Collection
of
|
|
|
0..* | CodeableConcept |
Ways
that
the
service
accepts
referrals
ReferralMethod ( Example ) |
|
|
0..1 | string |
PKI
Public
keys
to
support
secure
|
|
|
0..1 | boolean | If an appointment is required for access to this service | |
|
0..* |
|
Times the Service Site is available | |
|
0..* |
|
mon
|
tue
|
wed
|
thu
|
fri
|
sat
|
sun
DaysOfWeek ( Required ) |
|
|
0..1 | boolean |
Always
available?
|
|
|
0..1 | time |
Opening
time
of
|
|
|
0..1 | time |
Closing
time
of
|
|
|
0..* |
|
Not
available
during
this
|
|
|
1..1 | string |
Reason
presented
to
the
user
|
|
|
0..1 | Period |
Service
|
|
|
0..1 | string |
Description
of
|
|
Documentation
for
this
format
| ||||
UML Diagram
XML Template
<<HealthcareService xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> < The organization that provides this Healthcare Service</providedBy> < The location where this healthcare service may be provided</location> < Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type</serviceCategory> < <</type> < Collection of Specialties handled by the Service Site. This is more of a Medical Term</specialty><identifier><!-- 0..* Identifier External identifiers for this item --></identifier> <providedBy><!-- 0..1 Reference(Organization) Organization that provides this service --></providedBy> <serviceCategory><!-- 0..1 CodeableConcept Broad category of service being performed or delivered --></serviceCategory> <serviceType> <!-- 0..* Specific service delivered or performed --> <type><!-- 1..1 CodeableConcept Type of service delivered or performed --></type> <specialty><!-- 0..* CodeableConcept Specialties handled by the Service Site --></specialty> </serviceType>< Further description of the service as it would be presented to a consumer while searching < Additional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName < < If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list</photo> < List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts</telecom> < The location(s) that this service is available to (not where the service is provided)</coverageArea> < Does this service have specific eligibility requirements that need to be met in order to use the service</eligibility> < < < Collection of Characteristics (attributes)</characteristic> <</referralMethod> < The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available < < <</daysOfWeek> < < The opening time of day. Note: If the AllDay flag is set, then this time is ignored < The closing time of day. Note: If the AllDay flag is set, then this time is ignored<location><!-- 1..1 Reference(Location) Location where service may be provided --></location> <serviceName value="[string]"/><!-- 0..1 Description of service as presented to a consumer while searching --> <comment value="[string]"/><!-- 0..1 Additional description and/or any specific issues not covered elsewhere --> <extraDetails value="[string]"/><!-- 0..1 Extra details about the service that can't be placed in the other fields --> <photo><!-- 0..1 Attachment Facilitates quick identification of the service --></photo> <telecom><!-- 0..* ContactPoint Contacts related to the healthcare service --></telecom> <coverageArea><!-- 0..* Reference(Location) Location(s) service is inteded for/available to --></coverageArea> <serviceProvisionCode><!-- 0..* CodeableConcept Conditions under which service is available/offered --></serviceProvisionCode> <eligibility><!-- 0..1 CodeableConcept Specific eligibility requirements required to use the service --></eligibility> <eligibilityNote value="[string]"/><!-- 0..1 Describes the eligibility conditions for the service --> <programName value="[string]"/><!-- 0..* Program Names that categorize the service --> <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic> <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod> <publicKey value="[string]"/><!-- 0..1 PKI Public keys to support secure communications --> <appointmentRequired value="[boolean]"/><!-- 0..1 If an appointment is required for access to this service --> <availableTime> <!-- 0..* Times the Service Site is available --> <daysOfWeek value="[code]"/><!-- 0..* mon | tue | wed | thu | fri | sat | sun --> <allDay value="[boolean]"/><!-- 0..1 Always available? e.g. 24 hour service --> <availableStartTime value="[time]"/><!-- 0..1 Opening time of day (ignored if allDay = true) --> <availableEndTime value="[time]"/><!-- 0..1 Closing time of day (ignored if allDay = true) --> </availableTime>< < < Service is not available (seasonally or for a public holiday) from this date</during><notAvailable> <!-- 0..* Not available during this time due to provided reason --> <description value="[string]"/><!-- 1..1 Reason presented to the user explaining why time not available --> <during><!-- 0..1 Period Service not availablefrom this date --></during> </notAvailable>< 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 and Not Available Times<availabilityExceptions value="[string]"/><!-- 0..1 Description of availability exceptions --> </HealthcareService>
JSON Template
{
"resourceType" : "",
"resourceType" : "HealthcareService",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
The organization that provides this Healthcare Service
"
The location where this healthcare service may be provided
"
Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type
"
"
"
Collection of Specialties handled by the Service Site. This is more of a Medical Term
"identifier" : [{ Identifier }], // External identifiers for this item
"providedBy" : { Reference(Organization) }, // Organization that provides this service
"serviceCategory" : { CodeableConcept }, // Broad category of service being performed or delivered
"serviceType" : [{ // Specific service delivered or performed
"type" : { CodeableConcept }, // R! Type of service delivered or performed
"specialty" : [{ CodeableConcept }] // Specialties handled by the Service Site
}],
"
Further description of the service as it would be presented to a consumer while searching
"
Additional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName
"
"
If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list
"
List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts
"
The location(s) that this service is available to (not where the service is provided)
"
Does this service have specific eligibility requirements that need to be met in order to use the service
"
"
"
Collection of Characteristics (attributes)
"
"
The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available
"
"
"
"
"
The opening time of day. Note: If the AllDay flag is set, then this time is ignored
"
The closing time of day. Note: If the AllDay flag is set, then this time is ignored
"location" : { Reference(Location) }, // R! Location where service may be provided
"serviceName" : "<string>", // Description of service as presented to a consumer while searching
"comment" : "<string>", // Additional description and/or any specific issues not covered elsewhere
"extraDetails" : "<string>", // Extra details about the service that can't be placed in the other fields
"photo" : { Attachment }, // Facilitates quick identification of the service
"telecom" : [{ ContactPoint }], // Contacts related to the healthcare service
"coverageArea" : [{ Reference(Location) }], // Location(s) service is inteded for/available to
"serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered
"eligibility" : { CodeableConcept }, // Specific eligibility requirements required to use the service
"eligibilityNote" : "<string>", // Describes the eligibility conditions for the service
"programName" : ["<string>"], // Program Names that categorize the service
"characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
"referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
"publicKey" : "<string>", // PKI Public keys to support secure communications
"appointmentRequired" : <boolean>, // If an appointment is required for access to this service
"availableTime" : [{ // Times the Service Site is available
"daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
"allDay" : <boolean>, // Always available? e.g. 24 hour service
"availableStartTime" : "<time>", // Opening time of day (ignored if allDay = true)
"availableEndTime" : "<time>" // Closing time of day (ignored if allDay = true)
}],
"
The HealthcareService is not available during this period of time due to the provided reason
"
"
Service is not available (seasonally or for a public holiday) from this date
"notAvailable" : [{ // Not available during this time due to provided reason
"description" : "<string>", // R! Reason presented to the user explaining why time not available
"during" : { Period } // Service not availablefrom this date
}],
"
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 and Not Available Times
"availabilityExceptions" : "<string>" // Description of availability exceptions
}
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
DomainResource |
The
details
of
a
|
||
|
Σ | 0..* | Identifier |
External
|
|
Σ | 0..1 | Reference ( Organization ) |
Organization
that
provides
this
|
|
Σ | 0..1 | CodeableConcept |
Broad
category
of
service
being
performed
or
|
|
Σ | 0..* |
|
Specific
service
|
|
Σ | 1..1 | CodeableConcept |
Type
of
service
|
|
Σ | 0..* | CodeableConcept |
Specialties
handled
by
the
Service
|
| Σ | 1..1 | Reference ( Location ) | Location where service may be provided |
![]() ![]() |
Σ | 0..1 | string |
Description
of
|
|
Σ | 0..1 | string |
Additional
description
|
|
0..1 | string | Extra details about the service that can't be placed in the other fields | |
|
Σ | 0..1 | Attachment |
Facilitates
quick
identification
of
the
service
|
|
0..* | ContactPoint |
Contacts
related
to
|
|
|
0..* | Reference ( Location ) |
Location(s)
service
is
|
|
| 0..* | CodeableConcept |
Conditions
under
which
service
is
ServiceProvisionConditions ( Example ) |
|
|
0..1 | CodeableConcept |
Specific
eligibility
requirements
|
|
|
0..1 | string | Describes the eligibility conditions for the service | |
|
0..* | string |
Program
Names
that
|
|
|
0..* | CodeableConcept |
Collection
of
|
|
|
0..* | CodeableConcept |
Ways
that
the
service
accepts
referrals
ReferralMethod ( Example ) |
|
|
0..1 | string |
PKI
Public
keys
to
support
secure
|
|
|
0..1 | boolean | If an appointment is required for access to this service | |
|
0..* |
|
Times the Service Site is available | |
|
0..* |
|
mon
|
tue
|
wed
|
thu
|
fri
|
sat
|
sun
DaysOfWeek ( Required ) |
|
|
0..1 | boolean |
Always
available?
|
|
|
0..1 | time |
Opening
time
of
|
|
|
0..1 | time |
Closing
time
of
|
|
|
0..* |
|
Not
available
during
this
|
|
|
1..1 | string |
Reason
presented
to
the
user
|
|
|
0..1 | Period |
Service
|
|
|
0..1 | string |
Description
of
|
|
Documentation
for
this
format
| ||||
XML Template
<<HealthcareService xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> < The organization that provides this Healthcare Service</providedBy> < The location where this healthcare service may be provided</location> < Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type</serviceCategory> < <</type> < Collection of Specialties handled by the Service Site. This is more of a Medical Term</specialty><identifier><!-- 0..* Identifier External identifiers for this item --></identifier> <providedBy><!-- 0..1 Reference(Organization) Organization that provides this service --></providedBy> <serviceCategory><!-- 0..1 CodeableConcept Broad category of service being performed or delivered --></serviceCategory> <serviceType> <!-- 0..* Specific service delivered or performed --> <type><!-- 1..1 CodeableConcept Type of service delivered or performed --></type> <specialty><!-- 0..* CodeableConcept Specialties handled by the Service Site --></specialty> </serviceType>< Further description of the service as it would be presented to a consumer while searching < Additional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName < < If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list</photo> < List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts</telecom> < The location(s) that this service is available to (not where the service is provided)</coverageArea> < Does this service have specific eligibility requirements that need to be met in order to use the service</eligibility> < < < Collection of Characteristics (attributes)</characteristic> <</referralMethod> < The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available < < <</daysOfWeek> < < The opening time of day. Note: If the AllDay flag is set, then this time is ignored < The closing time of day. Note: If the AllDay flag is set, then this time is ignored<location><!-- 1..1 Reference(Location) Location where service may be provided --></location> <serviceName value="[string]"/><!-- 0..1 Description of service as presented to a consumer while searching --> <comment value="[string]"/><!-- 0..1 Additional description and/or any specific issues not covered elsewhere --> <extraDetails value="[string]"/><!-- 0..1 Extra details about the service that can't be placed in the other fields --> <photo><!-- 0..1 Attachment Facilitates quick identification of the service --></photo> <telecom><!-- 0..* ContactPoint Contacts related to the healthcare service --></telecom> <coverageArea><!-- 0..* Reference(Location) Location(s) service is inteded for/available to --></coverageArea> <serviceProvisionCode><!-- 0..* CodeableConcept Conditions under which service is available/offered --></serviceProvisionCode> <eligibility><!-- 0..1 CodeableConcept Specific eligibility requirements required to use the service --></eligibility> <eligibilityNote value="[string]"/><!-- 0..1 Describes the eligibility conditions for the service --> <programName value="[string]"/><!-- 0..* Program Names that categorize the service --> <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic> <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod> <publicKey value="[string]"/><!-- 0..1 PKI Public keys to support secure communications --> <appointmentRequired value="[boolean]"/><!-- 0..1 If an appointment is required for access to this service --> <availableTime> <!-- 0..* Times the Service Site is available --> <daysOfWeek value="[code]"/><!-- 0..* mon | tue | wed | thu | fri | sat | sun --> <allDay value="[boolean]"/><!-- 0..1 Always available? e.g. 24 hour service --> <availableStartTime value="[time]"/><!-- 0..1 Opening time of day (ignored if allDay = true) --> <availableEndTime value="[time]"/><!-- 0..1 Closing time of day (ignored if allDay = true) --> </availableTime>< < < Service is not available (seasonally or for a public holiday) from this date</during><notAvailable> <!-- 0..* Not available during this time due to provided reason --> <description value="[string]"/><!-- 1..1 Reason presented to the user explaining why time not available --> <during><!-- 0..1 Period Service not availablefrom this date --></during> </notAvailable>< 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 and Not Available Times<availabilityExceptions value="[string]"/><!-- 0..1 Description of availability exceptions --> </HealthcareService>
JSON Template
{
"resourceType" : "",
"resourceType" : "HealthcareService",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
The organization that provides this Healthcare Service
"
The location where this healthcare service may be provided
"
Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type
"
"
"
Collection of Specialties handled by the Service Site. This is more of a Medical Term
"identifier" : [{ Identifier }], // External identifiers for this item
"providedBy" : { Reference(Organization) }, // Organization that provides this service
"serviceCategory" : { CodeableConcept }, // Broad category of service being performed or delivered
"serviceType" : [{ // Specific service delivered or performed
"type" : { CodeableConcept }, // R! Type of service delivered or performed
"specialty" : [{ CodeableConcept }] // Specialties handled by the Service Site
}],
"
Further description of the service as it would be presented to a consumer while searching
"
Additional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName
"
"
If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list
"
List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts
"
The location(s) that this service is available to (not where the service is provided)
"
Does this service have specific eligibility requirements that need to be met in order to use the service
"
"
"
Collection of Characteristics (attributes)
"
"
The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available
"
"
"
"
"
The opening time of day. Note: If the AllDay flag is set, then this time is ignored
"
The closing time of day. Note: If the AllDay flag is set, then this time is ignored
"location" : { Reference(Location) }, // R! Location where service may be provided
"serviceName" : "<string>", // Description of service as presented to a consumer while searching
"comment" : "<string>", // Additional description and/or any specific issues not covered elsewhere
"extraDetails" : "<string>", // Extra details about the service that can't be placed in the other fields
"photo" : { Attachment }, // Facilitates quick identification of the service
"telecom" : [{ ContactPoint }], // Contacts related to the healthcare service
"coverageArea" : [{ Reference(Location) }], // Location(s) service is inteded for/available to
"serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered
"eligibility" : { CodeableConcept }, // Specific eligibility requirements required to use the service
"eligibilityNote" : "<string>", // Describes the eligibility conditions for the service
"programName" : ["<string>"], // Program Names that categorize the service
"characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
"referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
"publicKey" : "<string>", // PKI Public keys to support secure communications
"appointmentRequired" : <boolean>, // If an appointment is required for access to this service
"availableTime" : [{ // Times the Service Site is available
"daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
"allDay" : <boolean>, // Always available? e.g. 24 hour service
"availableStartTime" : "<time>", // Opening time of day (ignored if allDay = true)
"availableEndTime" : "<time>" // Closing time of day (ignored if allDay = true)
}],
"
The HealthcareService is not available during this period of time due to the provided reason
"
"
Service is not available (seasonally or for a public holiday) from this date
"notAvailable" : [{ // Not available during this time due to provided reason
"description" : "<string>", // R! Reason presented to the user explaining why time not available
"during" : { Period } // Service not availablefrom this date
}],
"
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 and Not Available Times
"availabilityExceptions" : "<string>" // Description of availability exceptions
}
Alternate definitions: Schema / Schematron , Resource Profile ( XML , JSON ), Questionnaire
| Path | Definition | Type | Reference |
|---|---|---|---|
| HealthcareService.serviceCategory | A category of the service(s) that could be provided. | Unknown | No details provided yet |
| HealthcareService.serviceType.type |
Additional
details
about
where
the
content
was
created
(e.g.
clinical
|
Preferred |
|
| HealthcareService.serviceType.specialty | A specialty that a healthcare service may provide. | Unknown | No details provided yet |
| HealthcareService.serviceProvisionCode | The code(s) that detail the conditions under which the healthcare service is available/offered. | Example | ServiceProvisionConditions |
| HealthcareService.eligibility | Coded values underwhich a specific service is made available. | Unknown | No details provided yet |
| HealthcareService.characteristic | A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | Unknown | No details provided yet |
| HealthcareService.referralMethod |
The
methods
of
referral
can
be
used
when
referring
to
a
specific
HealthCareService
|
Example |
|
| HealthcareService.availableTime.daysOfWeek | The days of the week. | Required | DaysOfWeek |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| characteristic | token | One of the HealthcareService's characteristics | HealthcareService.characteristic |
| 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.serviceName |
| organization | reference | The organization that provides this Healthcare Service |
HealthcareService.providedBy
( Organization ) |
| programname | string | One of the Program Names serviced by this HealthcareService | HealthcareService.programName |
| servicecategory | token | Service Category of the Healthcare Service | HealthcareService.serviceCategory |
| servicetype | token | The type of service provided by this healthcare service | HealthcareService.serviceType.type |