DSTU2

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

5.6 Resource HealthcareService - Content

This resource maintained by the
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.

5.6.1 Scope and Usage

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:

  • Allied Health
  • Clinical Neuropsychologist
  • Podiatry Service
  • Smallville Hospital Emergency Services
  • Respite care provided at a nursing home or hostel
  • 24hr crisis telephone counselling 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 counselling counseling
  • Day Programs, Adult Training & Support Services
  • Consulting psychologists and/or psychology services
  • Group Hydrotherapy
  • Little River Home Maintenance
  • Example mowing services

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.

5.6.2 Boundaries and Relationships

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

5.6.3 Resource Content

Structure

The organization Identifies the broad A specific type of The specific type Collection of Further description If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate List of contacts The location(s) that this Does this service have specific The public part of the 'keys' allocated to an Organization by an accredited body Indicates if A Collection of times that Is this always The opening The closing The HealthcareService is not The reason that can be A description
Name Flags Card. Type Description & Constraints doco
. . HealthcareService DomainResource The details of a Healthcare Service healthcare service available at a location
. . . identifier Σ 0..* Identifier External Identifiers identifiers for this item
. . . providedBy Σ 0..1 Reference ( Organization ) Organization that provides this Healthcare Service location Σ 1..1 Location The location where this healthcare service may be provided
. . . serviceCategory Σ 0..1 CodeableConcept 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 delivered
. . . serviceType Σ 0..* Element BackboneElement Specific service that may be delivered or performed
. . . . type Σ 1..1 CodeableConcept Type of service being delivered or performed
DocumentC80PracticeSetting Practice Setting Code Value Set ( Preferred )
. . . . specialty Σ 0..* CodeableConcept Specialties handled by the Service Site. This is more of a Medical Term Site
. . . location Σ 1..1 Reference ( Location ) Location where service may be provided
... serviceName Σ 0..1 string Description of the service as it would be presented to a consumer while searching
. . . comment Σ 0..1 string Additional description of the or and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName elsewhere
. . . extraDetails 0..1 string Extra details about the service that can't be placed in the other fields
. . . photo Σ 0..1 Attachment Facilitates quick identification of the service in a list
. . . telecom 0..* ContactPoint Contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts healthcare service
. . . coverageArea 0..* Reference ( Location ) Location(s) service is available inteded for/available to (not where the
. . . serviceProvisionCode 0..* CodeableConcept Conditions under which service is provided) available/offered
ServiceProvisionConditions ( Example )
. . . eligibility 0..1 CodeableConcept Specific eligibility requirements that need to be met in order required to use the service
. . . eligibilityNote 0..1 string Describes the eligibility conditions for the service
. . . programName 0..* string Program Names that can be used to categorize the service
. . . characteristic 0..* CodeableConcept Collection of Characteristics characteristics (attributes)
. . . referralMethod 0..* CodeableConcept Ways that the service accepts referrals
ReferralMethod ( Example )
. . . publicKey 0..1 string PKI Public keys to support secure exchange of data over the internet. To be provided by the Organization, where available communications
. . . appointmentRequired 0..1 boolean If an appointment is required for access to this service
. . . availableTime 0..* Element BackboneElement Times the Service Site is available
. . . . daysOfWeek 0..* CodeableConcept code mon | tue | wed | thu | fri | sat | sun
DaysOfWeek ( Required )
. . . . allDay 0..1 boolean Always available? (hence times are irrelevant) e.g. 24 hour service
. . . . availableStartTime 0..1 time Opening time of day. Note: If the AllDay flag is set, then this time is ignored day (ignored if allDay = true)
. . . . availableEndTime 0..1 time Closing time of day. Note: If the AllDay flag is set, then this time is ignored day (ignored if allDay = true)
. . . notAvailable 0..* Element BackboneElement Not available during this period of time due to the provided reason
. . . . description 1..1 string Reason presented to the user as to explaining why this time is not available
. . . . during 0..1 Period Service is not available (seasonally or for a public holiday) from availablefrom this date
. . . availabilityExceptions 0..1 string 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

doco Documentation for this format

UML Diagram

HealthcareService ( DomainResource ) External Identifiers identifiers for this item identifier : Identifier 0..* [0..*] The organization that provides this Healthcare Service healthcare service providedBy : Reference ( [0..1] « Organization ) 0..1 » Identifies the broad category of service being performed or delivered serviceCategory : CodeableConcept [0..1] The location where this healthcare service may be provided location : Reference ( [1..1] « Location ) 1..1 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 : CodeableConcept 0..1 » Further description of the service as it would be presented to a consumer while searching serviceName : string 0..1 [0..1] Additional Any additional description of the or service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName comment : string 0..1 [0..1] Extra details about the service that can't be placed in the other fields extraDetails : string 0..1 [0..1] 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 : Attachment 0..1 [0..1] List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts service telecom : ContactPoint 0..* [0..*] The location(s) that this service is available to (not where the service is provided) coverageArea : Reference ( [0..*] « Location ) 0..* » The code(s) that detail the conditions under which the healthcare service is available/offered serviceProvisionCode : CodeableConcept [0..*] « The code(s) that detail the conditions under which the healthcare service is available/offered. (Strength=Example) ServiceProvisionConditions ?? » Does this service have specific eligibility requirements that need to be met in order to use the service service? eligibility : CodeableConcept 0..1 [0..1] The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where Describes the eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of for the source document such as a web page service eligibilityNote : string 0..1 [0..1] Program Names that can be used to categorize the service programName : string 0..* [0..*] Collection of Characteristics characteristics (attributes) characteristic : CodeableConcept 0..* [0..*] Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required referralMethod : CodeableConcept 0..* [0..*] « ( The methods of referral can be used when referring to a specific HealthCareService resource resource. (Strength=Example) 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 publicKey : string 0..1 [0..1] Indicates whether or not a prospective consumer will require an appointment for a particular service at a Site site to be provided by the Organization. Indicates if an appointment is required for access to this service appointmentRequired : boolean 0..1 [0..1] A description of Site site availability exceptions, e.g., e.g. public holiday availability. Succinctly describing all possible exceptions to normal Site site availability as details in the Available available Times and Not Available not available Times availabilityExceptions : string 0..1 [0..1] ServiceType The specific type of service being delivered or performed type : CodeableConcept 1..1 [1..1] « Additional details about where the content was created (e.g. clinical specialty) specialty). (Strength=Preferred) DocumentC80PracticeSetting Practice Setting Code Value S... + ? » Collection of Specialties specialties handled by the Service Site. service site. This is more of a Medical Term medical term specialty : CodeableConcept 0..* [0..*] AvailableTime Indicates which Days days of the week are available between the Start start and End end Times daysOfWeek : CodeableConcept code 0..* [0..*] « The days of the week. (Strength=Required) DaysOfWeek ! » Is this always available? (hence times are irrelevant) e.g. 24 hour service allDay : boolean 0..1 [0..1] The opening time of day. Note: If the AllDay flag is set, then this time is ignored availableStartTime : time 0..1 [0..1] The closing time of day. Note: If the AllDay flag is set, then this time is ignored availableEndTime : time 0..1 [0..1] NotAvailable The reason that can be presented to the user as to why this time is not available description : string 1..1 [1..1] Service is not available (seasonally or for a public holiday) from this date during : Period 0..1 [0..1] A specific type of service that may be delivered or performed serviceType 0..* [0..*] A Collection collection of times that the Service Site is available availableTime 0..* [0..*] The HealthcareService is not available during this period of time due to the provided reason notAvailable 0..* [0..*]

XML Template

<

<HealthcareService xmlns="http://hl7.org/fhir"> doco

 <!-- 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

{doco
  "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

The organization Identifies the broad A specific type of The specific type Collection of Further description If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate List of contacts The location(s) that this Does this service have specific The public part of the 'keys' allocated to an Organization by an accredited body Indicates if A Collection of times that Is this always The opening The closing The HealthcareService is not The reason that can be A description
Name Flags Card. Type Description & Constraints doco
. . HealthcareService DomainResource The details of a Healthcare Service healthcare service available at a location
. . . identifier Σ 0..* Identifier External Identifiers identifiers for this item
. . . providedBy Σ 0..1 Reference ( Organization ) Organization that provides this Healthcare Service location Σ 1..1 Location The location where this healthcare service may be provided
. . . serviceCategory Σ 0..1 CodeableConcept 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 delivered
. . . serviceType Σ 0..* Element BackboneElement Specific service that may be delivered or performed
. . . . type Σ 1..1 CodeableConcept Type of service being delivered or performed
DocumentC80PracticeSetting Practice Setting Code Value Set ( Preferred )
. . . . specialty Σ 0..* CodeableConcept Specialties handled by the Service Site. This is more of a Medical Term Site
. . . location Σ 1..1 Reference ( Location ) Location where service may be provided
... serviceName Σ 0..1 string Description of the service as it would be presented to a consumer while searching
. . . comment Σ 0..1 string Additional description of the or and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName elsewhere
. . . extraDetails 0..1 string Extra details about the service that can't be placed in the other fields
. . . photo Σ 0..1 Attachment Facilitates quick identification of the service in a list
. . . telecom 0..* ContactPoint Contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts healthcare service
. . . coverageArea 0..* Reference ( Location ) Location(s) service is available inteded for/available to (not where the
. . . serviceProvisionCode 0..* CodeableConcept Conditions under which service is provided) available/offered
ServiceProvisionConditions ( Example )
. . . eligibility 0..1 CodeableConcept Specific eligibility requirements that need to be met in order required to use the service
. . . eligibilityNote 0..1 string Describes the eligibility conditions for the service
. . . programName 0..* string Program Names that can be used to categorize the service
. . . characteristic 0..* CodeableConcept Collection of Characteristics characteristics (attributes)
. . . referralMethod 0..* CodeableConcept Ways that the service accepts referrals
ReferralMethod ( Example )
. . . publicKey 0..1 string PKI Public keys to support secure exchange of data over the internet. To be provided by the Organization, where available communications
. . . appointmentRequired 0..1 boolean If an appointment is required for access to this service
. . . availableTime 0..* Element BackboneElement Times the Service Site is available
. . . . daysOfWeek 0..* CodeableConcept code mon | tue | wed | thu | fri | sat | sun
DaysOfWeek ( Required )
. . . . allDay 0..1 boolean Always available? (hence times are irrelevant) e.g. 24 hour service
. . . . availableStartTime 0..1 time Opening time of day. Note: If the AllDay flag is set, then this time is ignored day (ignored if allDay = true)
. . . . availableEndTime 0..1 time Closing time of day. Note: If the AllDay flag is set, then this time is ignored day (ignored if allDay = true)
. . . notAvailable 0..* Element BackboneElement Not available during this period of time due to the provided reason
. . . . description 1..1 string Reason presented to the user as to explaining why this time is not available
. . . . during 0..1 Period Service is not available (seasonally or for a public holiday) from availablefrom this date
. . . availabilityExceptions 0..1 string 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

doco Documentation for this format

UML Diagram

HealthcareService ( DomainResource ) External Identifiers identifiers for this item identifier : Identifier 0..* [0..*] The organization that provides this Healthcare Service healthcare service providedBy : Reference ( [0..1] « Organization ) 0..1 » Identifies the broad category of service being performed or delivered serviceCategory : CodeableConcept [0..1] The location where this healthcare service may be provided location : Reference ( [1..1] « Location ) 1..1 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 : CodeableConcept 0..1 » Further description of the service as it would be presented to a consumer while searching serviceName : string 0..1 [0..1] Additional Any additional description of the or service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName comment : string 0..1 [0..1] Extra details about the service that can't be placed in the other fields extraDetails : string 0..1 [0..1] 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 : Attachment 0..1 [0..1] List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts service telecom : ContactPoint 0..* [0..*] The location(s) that this service is available to (not where the service is provided) coverageArea : Reference ( [0..*] « Location ) 0..* » The code(s) that detail the conditions under which the healthcare service is available/offered serviceProvisionCode : CodeableConcept [0..*] « The code(s) that detail the conditions under which the healthcare service is available/offered. (Strength=Example) ServiceProvisionConditions ?? » Does this service have specific eligibility requirements that need to be met in order to use the service service? eligibility : CodeableConcept 0..1 [0..1] The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where Describes the eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of for the source document such as a web page service eligibilityNote : string 0..1 [0..1] Program Names that can be used to categorize the service programName : string 0..* [0..*] Collection of Characteristics characteristics (attributes) characteristic : CodeableConcept 0..* [0..*] Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required referralMethod : CodeableConcept 0..* [0..*] « ( The methods of referral can be used when referring to a specific HealthCareService resource resource. (Strength=Example) 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 publicKey : string 0..1 [0..1] Indicates whether or not a prospective consumer will require an appointment for a particular service at a Site site to be provided by the Organization. Indicates if an appointment is required for access to this service appointmentRequired : boolean 0..1 [0..1] A description of Site site availability exceptions, e.g., e.g. public holiday availability. Succinctly describing all possible exceptions to normal Site site availability as details in the Available available Times and Not Available not available Times availabilityExceptions : string 0..1 [0..1] ServiceType The specific type of service being delivered or performed type : CodeableConcept 1..1 [1..1] « Additional details about where the content was created (e.g. clinical specialty) specialty). (Strength=Preferred) DocumentC80PracticeSetting Practice Setting Code Value S... + ? » Collection of Specialties specialties handled by the Service Site. service site. This is more of a Medical Term medical term specialty : CodeableConcept 0..* [0..*] AvailableTime Indicates which Days days of the week are available between the Start start and End end Times daysOfWeek : CodeableConcept code 0..* [0..*] « The days of the week. (Strength=Required) DaysOfWeek ! » Is this always available? (hence times are irrelevant) e.g. 24 hour service allDay : boolean 0..1 [0..1] The opening time of day. Note: If the AllDay flag is set, then this time is ignored availableStartTime : time 0..1 [0..1] The closing time of day. Note: If the AllDay flag is set, then this time is ignored availableEndTime : time 0..1 [0..1] NotAvailable The reason that can be presented to the user as to why this time is not available description : string 1..1 [1..1] Service is not available (seasonally or for a public holiday) from this date during : Period 0..1 [0..1] A specific type of service that may be delivered or performed serviceType 0..* [0..*] A Collection collection of times that the Service Site is available availableTime 0..* [0..*] The HealthcareService is not available during this period of time due to the provided reason notAvailable 0..* [0..*]

XML Template

<

<HealthcareService xmlns="http://hl7.org/fhir"> doco

 <!-- 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

{doco
  "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

5.6.3.1 Terminology Bindings

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 specialty) specialty). Preferred http://hl7.org/fhir/vs/c80-practice-codes Practice Setting Code Value Set
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 resource resource. Example http://hl7.org/fhir/service-referral-method ReferralMethod
HealthcareService.availableTime.daysOfWeek The days of the week. Required DaysOfWeek

5.6.4 Notes:

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

5.6.5 Search Parameters

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