Administration
This page is part of the FHIR Specification (v1.6.0:
STU
3 Ballot 4). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions 
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
|
|
|
Compartments
|
The details of a healthcare service available at a location.
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:
HealthcareService resources do not represent Computer related Services (not SOA)
Example uses of HealthcareService resources are:
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.
This resource is referenced by
Account
,
,
Appointment
,
,
AppointmentResponse
,
,
Practitioner
and
,
PractitionerRole
and
Schedule
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
HealthcareService
|
DomainResource |
|
||
identifier
|
Σ | 0..* | Identifier |
|
active
|
?! Σ | 0..1 |
|
|
providedBy
|
Σ | 0..1 |
|
|
|
serviceCategory
|
Σ |
|
|
ServiceCategory ( Example ) |
|
serviceType
|
Σ |
|
CodeableConcept |
|
|
specialty
|
Σ | 0..* | CodeableConcept |
Practice Setting Code Value Set ( Preferred ) |
|
location
|
Σ |
|
Reference ( Location ) |
|
|
serviceName
|
Σ | 0..1 | string |
|
|
comment
|
Σ | 0..1 | string |
|
|
extraDetails
|
0..1 | string |
|
|
|
photo
|
Σ | 0..1 | Attachment |
|
|
telecom
|
0..* | ContactPoint |
|
|
|
coverageArea
|
0..* | Reference ( Location ) |
|
|
|
serviceProvisionCode
|
0..* | CodeableConcept |
ServiceProvisionConditions |
|
|
eligibility
|
0..1 | CodeableConcept |
|
|
|
eligibilityNote
|
0..1 | string |
|
|
|
programName
|
0..* | string |
|
|
|
characteristic
|
0..* | CodeableConcept |
|
|
|
referralMethod
|
0..* | CodeableConcept |
ReferralMethod |
|
|
publicKey
|
0..1 | string |
|
|
|
appointmentRequired
|
0..1 | boolean |
|
|
availableTime
|
0..* | BackboneElement |
|
|
daysOfWeek
|
0..* | code |
DaysOfWeek |
|
|
allDay
|
0..1 | boolean |
|
|
|
availableStartTime
|
0..1 | time |
|
|
availableEndTime
|
0..1 | time |
|
|
|
notAvailable
|
0..* | BackboneElement |
|
|
|
description
|
1..1 | string |
|
|
|
during
|
0..1 | Period |
|
|
|
availabilityExceptions
|
0..1 | string |
|
|
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
(
Legend
)
XML
Template
XML Template
<
<HealthcareService xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier> <</providedBy> <</serviceCategory> < <</type> <</specialty> </serviceType> <</location> < < < <</photo> <</telecom> <</coverageArea> <</serviceProvisionCode> <</eligibility> < < <</characteristic> <</referralMethod> < < < < < < <<identifier><!-- 0..* Identifier External identifiers for this item --></identifier> <active value="[boolean]"/><!-- 0..1 Whether this healthcareservice is in active use --> <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..* CodeableConcept Type of service that may be delivered or performed --></serviceType> <specialty><!-- 0..* CodeableConcept Specialties handled by the HealthcareService --></specialty> <location><!-- 0..* Reference(Location) Location(s) 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>< < <</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><<availabilityExceptions value="[string]"/><!-- 0..1 Description of availability exceptions --> </HealthcareService>
JSON
Template
JSON Template
{
"resourceType" : "",
{
"resourceType" : "HealthcareService",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
}],
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // External identifiers for this item
"active" : <boolean>, // Whether this healthcareservice is in active use
"providedBy" : { Reference(Organization) }, // Organization that provides this service
"serviceCategory" : { CodeableConcept }, // Broad category of service being performed or delivered
"serviceType" : [{ CodeableConcept }], // Type of service that may be delivered or performed
"specialty" : [{ CodeableConcept }], // Specialties handled by the HealthcareService
"location" : [{ Reference(Location) }], // Location(s) 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)
}],
"
"
"
"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
}],
"
"availabilityExceptions" : "<string>" // Description of availability exceptions
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| HealthcareService | |
| HealthcareService.active | added |
| HealthcareService.serviceType | Type changed from BackboneElement to CodeableConcept |
| HealthcareService.specialty | added |
| HealthcareService.location | Min Cardinality changed from 1 to 0 Max Cardinality changed from 1 to * |
| HealthcareService.serviceType.type | deleted |
| HealthcareService.serviceType.specialty | deleted |
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
HealthcareService
|
DomainResource |
|
||
|
identifier
|
Σ | 0..* | Identifier |
|
|
active
|
?! Σ | 0..1 |
|
|
|
providedBy
|
Σ | 0..1 |
|
|
|
serviceCategory
|
Σ |
|
|
ServiceCategory ( Example ) |
|
serviceType
|
Σ |
|
CodeableConcept |
|
|
specialty
|
Σ | 0..* | CodeableConcept |
Practice Setting Code Value Set ( Preferred ) |
|
location
|
Σ |
|
Reference ( Location ) |
|
|
serviceName
|
Σ | 0..1 | string |
|
|
comment
|
Σ | 0..1 | string |
|
|
extraDetails
|
0..1 | string |
|
|
|
photo
|
Σ | 0..1 | Attachment |
|
|
telecom
|
0..* | ContactPoint |
|
|
|
coverageArea
|
0..* | Reference ( Location ) |
|
|
|
serviceProvisionCode
|
0..* | CodeableConcept |
ServiceProvisionConditions |
|
|
eligibility
|
0..1 | CodeableConcept |
|
|
|
eligibilityNote
|
0..1 | string |
|
|
|
programName
|
0..* | string |
|
|
|
characteristic
|
0..* | CodeableConcept |
|
|
|
referralMethod
|
0..* | CodeableConcept |
ReferralMethod |
|
|
publicKey
|
0..1 | string |
|
|
|
appointmentRequired
|
0..1 | boolean |
|
|
|
availableTime
|
0..* | BackboneElement |
|
|
|
daysOfWeek
|
0..* | code |
DaysOfWeek |
|
|
allDay
|
0..1 | boolean |
|
|
|
availableStartTime
|
0..1 | time |
|
|
|
availableEndTime
|
0..1 | time |
|
|
|
notAvailable
|
0..* | BackboneElement |
|
|
|
description
|
1..1 | string |
|
|
|
during
|
0..1 | Period |
|
|
|
availabilityExceptions
|
0..1 | string |
|
|
|
Documentation for this format
|
||||
XML
Template
XML Template
<
<HealthcareService xmlns="http://hl7.org/fhir"><</identifier> <</providedBy> <</serviceCategory> < <</type> <</specialty> </serviceType> <</location> < < < <</photo> <</telecom> <</coverageArea> <</serviceProvisionCode> <</eligibility> < < <</characteristic> <</referralMethod> < < < < < < <<identifier><!-- 0..* Identifier External identifiers for this item --></identifier> <active value="[boolean]"/><!-- 0..1 Whether this healthcareservice is in active use --> <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..* CodeableConcept Type of service that may be delivered or performed --></serviceType> <specialty><!-- 0..* CodeableConcept Specialties handled by the HealthcareService --></specialty> <location><!-- 0..* Reference(Location) Location(s) 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>< < <</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><<availabilityExceptions value="[string]"/><!-- 0..1 Description of availability exceptions --> </HealthcareService>
JSON
Template
JSON Template
{
"resourceType" : "",
{
"resourceType" : "HealthcareService",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"
"
"
"
"
}],
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"identifier" : [{ Identifier }], // External identifiers for this item
"active" : <boolean>, // Whether this healthcareservice is in active use
"providedBy" : { Reference(Organization) }, // Organization that provides this service
"serviceCategory" : { CodeableConcept }, // Broad category of service being performed or delivered
"serviceType" : [{ CodeableConcept }], // Type of service that may be delivered or performed
"specialty" : [{ CodeableConcept }], // Specialties handled by the HealthcareService
"location" : [{ Reference(Location) }], // Location(s) 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)
}],
"
"
"
"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
}],
"
"availabilityExceptions" : "<string>" // Description of availability exceptions
}
Alternate
definitions:
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| HealthcareService | |
| HealthcareService.active | added |
| HealthcareService.serviceType | Type changed from BackboneElement to CodeableConcept |
| HealthcareService.specialty | added |
| HealthcareService.location | Min Cardinality changed from 1 to 0 Max Cardinality changed from 1 to * |
| HealthcareService.serviceType.type | deleted |
| HealthcareService.serviceType.specialty | deleted |
See the Full Difference for further information
Alternate definitions: Master Definition (
XML
,
JSON
),
XML
Schema
/
Schematron
,
Resource
Profile
(
XML
,
(for ) +
JSON
Schema
,
ShEx
(for
Turtle
),
Questionnaire
)
| Path | Definition | Type | Reference |
|---|---|---|---|
| HealthcareService.serviceCategory |
|
|
|
| HealthcareService.serviceType |
|
|
|
| HealthcareService.specialty |
|
|
|
| HealthcareService.serviceProvisionCode |
|
Example | ServiceProvisionConditions |
| HealthcareService.eligibility |
|
Unknown |
|
| HealthcareService.characteristic |
|
Unknown |
|
| HealthcareService.referralMethod |
|
Example | ReferralMethod |
| HealthcareService.availableTime.daysOfWeek |
|
Required | DaysOfWeek |
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| active | token | The Healthcare Service is currently marked as active | HealthcareService.active |
| characteristic | token |
|
HealthcareService.characteristic |
| identifier | token |
|
HealthcareService.identifier |
| location | reference |
|
HealthcareService.location
( Location ) |
| name | string |
|
HealthcareService.serviceName |
| organization | reference |
|
HealthcareService.providedBy
( Organization ) |
| programname | string |
|
HealthcareService.programName |
| servicecategory | token |
|
HealthcareService.serviceCategory |
| servicetype | token |
|
|
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000.
QA Page
Links:
Search
|
|
Version History
|
Table of Contents
|
Compare to DSTU2
|
|
Propose
a
change
try
{
var
currentTabIndex
=
sessionStorage.getItem('fhir-resource-tab-index');
}
catch(exception){
}
if
(!currentTabIndex)
currentTabIndex
=
'0';
$(
'#tabs'
).tabs({
active:
currentTabIndex,
activate:
function(
event,
ui
)
{
var
active
=
$('.selector').tabs('option',
'active');
currentTabIndex
=
ui.newTab.index();
document.activeElement.blur();
try
{
sessionStorage.setItem('fhir-resource-tab-index',
currentTabIndex);
}
catch(exception){
}
}
});
|
Propose a change