PATIENT ADMINISTRTAION (PA) Workgroup Development Draft

5.6 Resource HealthcareService - Content

This resource maintained by the Patient Administration Work Group

The details of a Healthcare Service available at a location.

5.6.1 Scope and Usage

The HealthcareService resource is used to describe a single healthcare service that is being 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 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
  • 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 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

5.6.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService DomainResourceThe details of a Healthcare Service available at a location
... identifier Σ0..*IdentifierExternal Identifiers for this item
... providedBy Σ0..1OrganizationThe organization that provides this Healthcare Service
... location Σ1..1LocationThe location where this healthcare service may be provided
... serviceCategory Σ0..1CodeableConceptIdentifies 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
... serviceType Σ0..*ElementA specific type of service that may be delivered or performed
.... type Σ1..1CodeableConceptThe specific type of service being delivered or performed
Practice Setting Code Value Set (Preferred)
.... specialty Σ0..*CodeableConceptCollection of Specialties handled by the Service Site. This is more of a Medical Term
... serviceName Σ0..1stringFurther description of the service as it would be presented to a consumer while searching
... comment Σ0..1stringAny additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName
... extraDetails 0..1stringExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list
... telecom 0..*ContactPointList of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts
... coverageArea 0..*LocationThe location(s) that this service is available to (not where the service is provided)
... serviceProvisionCode 0..*CodeableConceptThe code(s) that detail the conditions under which the healthcare service is available/offered
ServiceProvisionConditions (Example)
... eligibility 0..1CodeableConceptDoes this service have specific eligibility requirements that need to be met in order to use the service
... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... programName 0..*stringProgram Names that can be used to categorize the service
... characteristic 0..*CodeableConceptCollection of Characteristics (attributes)
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
ReferralMethod (Example)
... publicKey 0..1stringThe 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
... appointmentRequired 0..1booleanIndicates if an appointment is required for access to this service
... availableTime 0..*ElementA Collection of times that the Service Site is available
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
DaysOfWeek (Required)
.... allDay 0..1booleanIs this always available? (hence times are irrelevant) e.g. 24 hour service
.... availableStartTime 0..1timeThe opening time of day. Note: If the AllDay flag is set, then this time is ignored
.... availableEndTime 0..1timeThe closing time of day. Note: If the AllDay flag is set, then this time is ignored
... notAvailable 0..*ElementThe HealthcareService is not available during this period of time due to the provided reason
.... description 1..1stringThe reason that can be presented to the user as to why this time is not available
.... during 0..1PeriodService is not available (seasonally or for a public holiday) from this date
... availabilityExceptions 0..1stringA 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

UML Diagram

HealthcareService (DomainResource)External Identifiers for this itemidentifier : Identifier 0..*The organization that provides this Healthcare ServiceprovidedBy : Reference(Organization) 0..1The location where this healthcare service may be providedlocation : Reference(Location) 1..1Identifies 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 TypeserviceCategory : CodeableConcept 0..1Further description of the service as it would be presented to a consumer while searchingserviceName : string 0..1Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceNamecomment : string 0..1Extra details about the service that can't be placed in the other fieldsextraDetails : string 0..1If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a listphoto : Attachment 0..1List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contactstelecom : ContactPoint 0..*The location(s) that this service is available to (not where the service is provided)coverageArea : Reference(Location) 0..*The code(s) that detail the conditions under which the healthcare service is available/offeredserviceProvisionCode : CodeableConcept 0..* « (The code(s) that detail the conditions under which the healthcare service is available/offeredServiceProvisionConditions) »Does this service have specific eligibility requirements that need to be met in order to use the serviceeligibility : CodeableConcept 0..1The 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 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 the source document such as a web pageeligibilityNote : string 0..1Program Names that can be used to categorize the serviceprogramName : string 0..*Collection of Characteristics (attributes)characteristic : CodeableConcept 0..*Ways that the service accepts referrals, if this is not provided then it is implied that no referral is requiredreferralMethod : CodeableConcept 0..* « (The methods of referral can be used when referring to a specific HealthCareService resourceReferralMethod) »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 availablepublicKey : string 0..1Indicates whether or not a prospective consumer will require an appointment for a particular service at a Site to be provided by the Organization. Indicates if an appointment is required for access to this serviceappointmentRequired : boolean 0..1A 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 TimesavailabilityExceptions : string 0..1ServiceTypeThe specific type of service being delivered or performedtype : CodeableConcept 1..1 « Additional details about where the content was created (e.g. clinical specialty)Practice Setting Code Value Set+ »Collection of Specialties handled by the Service Site. This is more of a Medical Termspecialty : CodeableConcept 0..*AvailableTimeIndicates which Days of the week are available between the Start and End TimesdaysOfWeek : code 0..* « The days of the weekDaysOfWeek »Is this always available? (hence times are irrelevant) e.g. 24 hour serviceallDay : boolean 0..1The opening time of day. Note: If the AllDay flag is set, then this time is ignoredavailableStartTime : time 0..1The closing time of day. Note: If the AllDay flag is set, then this time is ignoredavailableEndTime : time 0..1NotAvailableThe reason that can be presented to the user as to why this time is not availabledescription : string 1..1Service is not available (seasonally or for a public holiday) from this dateduring : Period 0..1A specific type of service that may be delivered or performedserviceType0..*A Collection of times that the Service Site is availableavailableTime0..*The HealthcareService is not available during this period of time due to the provided reasonnotAvailable0..*

XML Template

<HealthcareService xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External Identifiers for this item --></identifier>
 <providedBy><!-- 0..1 Reference(Organization) The organization that provides this Healthcare Service --></providedBy>
 <location><!-- 1..1 Reference(Location) The location where this healthcare service may be provided --></location>
 <serviceCategory><!-- 0..1 CodeableConcept 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>
 <serviceType>  <!-- 0..* A specific type of service that may be delivered or performed -->
  <type><!-- 1..1 CodeableConcept The specific type of service being delivered or performed --></type>
  <specialty><!-- 0..* CodeableConcept Collection of Specialties handled by the Service Site. This is more of a Medical Term --></specialty>
 </serviceType>
 <serviceName value="[string]"/><!-- 0..1 Further description of the service as it would be presented to a consumer while searching -->
 <comment value="[string]"/><!-- 0..1 Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName -->
 <extraDetails value="[string]"/><!-- 0..1 Extra details about the service that can't be placed in the other fields -->
 <photo><!-- 0..1 Attachment 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>
 <telecom><!-- 0..* ContactPoint List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts --></telecom>
 <coverageArea><!-- 0..* Reference(Location) The location(s) that this service is available to (not where the service is provided) --></coverageArea>
 <serviceProvisionCode><!-- 0..* CodeableConcept The code(s) that detail the conditions under which the healthcare service is available/offered --></serviceProvisionCode>
 <eligibility><!-- 0..1 CodeableConcept Does this service have specific eligibility requirements that need to be met in order to use the service --></eligibility>
 <eligibilityNote value="[string]"/><!-- 0..1 Describes the eligibility conditions for the service -->
 <programName value="[string]"/><!-- 0..* Program Names that can be used to 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 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 -->
 <appointmentRequired value="[boolean]"/><!-- 0..1 Indicates if an appointment is required for access to this service -->
 <availableTime>  <!-- 0..* A Collection of times that the Service Site is available -->
  <daysOfWeek value="[code]"/><!-- 0..* mon | tue | wed | thu | fri | sat | sun -->
  <allDay value="[boolean]"/><!-- 0..1 Is this always available? (hence times are irrelevant) e.g. 24 hour service -->
  <availableStartTime value="[time]"/><!-- 0..1 The opening time of day. Note: If the AllDay flag is set, then this time is ignored -->
  <availableEndTime value="[time]"/><!-- 0..1 The closing time of day. Note: If the AllDay flag is set, then this time is ignored -->
 </availableTime>
 <notAvailable>  <!-- 0..* The HealthcareService is not available during this period of time due to the provided reason -->
  <description value="[string]"/><!-- 1..1 The reason that can be presented to the user as to why this time is not available -->
  <during><!-- 0..1 Period Service is not available (seasonally or for a public holiday) from this date --></during>
 </notAvailable>
 <availabilityExceptions value="[string]"/><!-- 0..1 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 -->
</HealthcareService>

JSON Template

{doco
  "resourceType" : "HealthcareService",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Identifiers for this item
  "providedBy" : { Reference(Organization) }, // The organization that provides this Healthcare Service
  "location" : { Reference(Location) }, // R!  The location where this healthcare service may be provided
  "serviceCategory" : { CodeableConcept }, // 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
  "serviceType" : [{ // A specific type of service that may be delivered or performed
    "type" : { CodeableConcept }, // R!  The specific type of service being delivered or performed
    "specialty" : [{ CodeableConcept }] // Collection of Specialties handled by the Service Site. This is more of a Medical Term
  }],
  "serviceName" : "<string>", // Further description of the service as it would be presented to a consumer while searching
  "comment" : "<string>", // Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName
  "extraDetails" : "<string>", // Extra details about the service that can't be placed in the other fields
  "photo" : { Attachment }, // 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
  "telecom" : [{ ContactPoint }], // List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts
  "coverageArea" : [{ Reference(Location) }], // The location(s) that this service is available to (not where the service is provided)
  "serviceProvisionCode" : [{ CodeableConcept }], // The code(s) that detail the conditions under which the healthcare service is available/offered
  "eligibility" : { CodeableConcept }, // Does this service have specific eligibility requirements that need to be met in order to use the service
  "eligibilityNote" : "<string>", // Describes the eligibility conditions for the service
  "programName" : ["<string>"], // Program Names that can be used to categorize the service
  "characteristic" : [{ CodeableConcept }], // Collection of Characteristics (attributes)
  "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
  "publicKey" : "<string>", // 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
  "appointmentRequired" : <boolean>, // Indicates if an appointment is required for access to this service
  "availableTime" : [{ // A Collection of times that the Service Site is available
    "daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
    "allDay" : <boolean>, // Is this always available? (hence times are irrelevant) e.g. 24 hour service
    "availableStartTime" : "<time>", // The opening time of day. Note: If the AllDay flag is set, then this time is ignored
    "availableEndTime" : "<time>" // The closing time of day. Note: If the AllDay flag is set, then this time is ignored
  }],
  "notAvailable" : [{ // The HealthcareService is not available during this period of time due to the provided reason
    "description" : "<string>", // R!  The reason that can be presented to the user as to why this time is not available
    "during" : { Period } // Service is not available (seasonally or for a public holiday) from this date
  }],
  "availabilityExceptions" : "<string>" // 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
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService DomainResourceThe details of a Healthcare Service available at a location
... identifier Σ0..*IdentifierExternal Identifiers for this item
... providedBy Σ0..1OrganizationThe organization that provides this Healthcare Service
... location Σ1..1LocationThe location where this healthcare service may be provided
... serviceCategory Σ0..1CodeableConceptIdentifies 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
... serviceType Σ0..*ElementA specific type of service that may be delivered or performed
.... type Σ1..1CodeableConceptThe specific type of service being delivered or performed
Practice Setting Code Value Set (Preferred)
.... specialty Σ0..*CodeableConceptCollection of Specialties handled by the Service Site. This is more of a Medical Term
... serviceName Σ0..1stringFurther description of the service as it would be presented to a consumer while searching
... comment Σ0..1stringAny additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName
... extraDetails 0..1stringExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list
... telecom 0..*ContactPointList of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts
... coverageArea 0..*LocationThe location(s) that this service is available to (not where the service is provided)
... serviceProvisionCode 0..*CodeableConceptThe code(s) that detail the conditions under which the healthcare service is available/offered
ServiceProvisionConditions (Example)
... eligibility 0..1CodeableConceptDoes this service have specific eligibility requirements that need to be met in order to use the service
... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... programName 0..*stringProgram Names that can be used to categorize the service
... characteristic 0..*CodeableConceptCollection of Characteristics (attributes)
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
ReferralMethod (Example)
... publicKey 0..1stringThe 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
... appointmentRequired 0..1booleanIndicates if an appointment is required for access to this service
... availableTime 0..*ElementA Collection of times that the Service Site is available
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
DaysOfWeek (Required)
.... allDay 0..1booleanIs this always available? (hence times are irrelevant) e.g. 24 hour service
.... availableStartTime 0..1timeThe opening time of day. Note: If the AllDay flag is set, then this time is ignored
.... availableEndTime 0..1timeThe closing time of day. Note: If the AllDay flag is set, then this time is ignored
... notAvailable 0..*ElementThe HealthcareService is not available during this period of time due to the provided reason
.... description 1..1stringThe reason that can be presented to the user as to why this time is not available
.... during 0..1PeriodService is not available (seasonally or for a public holiday) from this date
... availabilityExceptions 0..1stringA 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

UML Diagram

HealthcareService (DomainResource)External Identifiers for this itemidentifier : Identifier 0..*The organization that provides this Healthcare ServiceprovidedBy : Reference(Organization) 0..1The location where this healthcare service may be providedlocation : Reference(Location) 1..1Identifies 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 TypeserviceCategory : CodeableConcept 0..1Further description of the service as it would be presented to a consumer while searchingserviceName : string 0..1Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceNamecomment : string 0..1Extra details about the service that can't be placed in the other fieldsextraDetails : string 0..1If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a listphoto : Attachment 0..1List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contactstelecom : ContactPoint 0..*The location(s) that this service is available to (not where the service is provided)coverageArea : Reference(Location) 0..*The code(s) that detail the conditions under which the healthcare service is available/offeredserviceProvisionCode : CodeableConcept 0..* « (The code(s) that detail the conditions under which the healthcare service is available/offeredServiceProvisionConditions) »Does this service have specific eligibility requirements that need to be met in order to use the serviceeligibility : CodeableConcept 0..1The 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 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 the source document such as a web pageeligibilityNote : string 0..1Program Names that can be used to categorize the serviceprogramName : string 0..*Collection of Characteristics (attributes)characteristic : CodeableConcept 0..*Ways that the service accepts referrals, if this is not provided then it is implied that no referral is requiredreferralMethod : CodeableConcept 0..* « (The methods of referral can be used when referring to a specific HealthCareService resourceReferralMethod) »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 availablepublicKey : string 0..1Indicates whether or not a prospective consumer will require an appointment for a particular service at a Site to be provided by the Organization. Indicates if an appointment is required for access to this serviceappointmentRequired : boolean 0..1A 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 TimesavailabilityExceptions : string 0..1ServiceTypeThe specific type of service being delivered or performedtype : CodeableConcept 1..1 « Additional details about where the content was created (e.g. clinical specialty)Practice Setting Code Value Set+ »Collection of Specialties handled by the Service Site. This is more of a Medical Termspecialty : CodeableConcept 0..*AvailableTimeIndicates which Days of the week are available between the Start and End TimesdaysOfWeek : code 0..* « The days of the weekDaysOfWeek »Is this always available? (hence times are irrelevant) e.g. 24 hour serviceallDay : boolean 0..1The opening time of day. Note: If the AllDay flag is set, then this time is ignoredavailableStartTime : time 0..1The closing time of day. Note: If the AllDay flag is set, then this time is ignoredavailableEndTime : time 0..1NotAvailableThe reason that can be presented to the user as to why this time is not availabledescription : string 1..1Service is not available (seasonally or for a public holiday) from this dateduring : Period 0..1A specific type of service that may be delivered or performedserviceType0..*A Collection of times that the Service Site is availableavailableTime0..*The HealthcareService is not available during this period of time due to the provided reasonnotAvailable0..*

XML Template

<HealthcareService xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External Identifiers for this item --></identifier>
 <providedBy><!-- 0..1 Reference(Organization) The organization that provides this Healthcare Service --></providedBy>
 <location><!-- 1..1 Reference(Location) The location where this healthcare service may be provided --></location>
 <serviceCategory><!-- 0..1 CodeableConcept 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>
 <serviceType>  <!-- 0..* A specific type of service that may be delivered or performed -->
  <type><!-- 1..1 CodeableConcept The specific type of service being delivered or performed --></type>
  <specialty><!-- 0..* CodeableConcept Collection of Specialties handled by the Service Site. This is more of a Medical Term --></specialty>
 </serviceType>
 <serviceName value="[string]"/><!-- 0..1 Further description of the service as it would be presented to a consumer while searching -->
 <comment value="[string]"/><!-- 0..1 Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName -->
 <extraDetails value="[string]"/><!-- 0..1 Extra details about the service that can't be placed in the other fields -->
 <photo><!-- 0..1 Attachment 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>
 <telecom><!-- 0..* ContactPoint List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts --></telecom>
 <coverageArea><!-- 0..* Reference(Location) The location(s) that this service is available to (not where the service is provided) --></coverageArea>
 <serviceProvisionCode><!-- 0..* CodeableConcept The code(s) that detail the conditions under which the healthcare service is available/offered --></serviceProvisionCode>
 <eligibility><!-- 0..1 CodeableConcept Does this service have specific eligibility requirements that need to be met in order to use the service --></eligibility>
 <eligibilityNote value="[string]"/><!-- 0..1 Describes the eligibility conditions for the service -->
 <programName value="[string]"/><!-- 0..* Program Names that can be used to 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 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 -->
 <appointmentRequired value="[boolean]"/><!-- 0..1 Indicates if an appointment is required for access to this service -->
 <availableTime>  <!-- 0..* A Collection of times that the Service Site is available -->
  <daysOfWeek value="[code]"/><!-- 0..* mon | tue | wed | thu | fri | sat | sun -->
  <allDay value="[boolean]"/><!-- 0..1 Is this always available? (hence times are irrelevant) e.g. 24 hour service -->
  <availableStartTime value="[time]"/><!-- 0..1 The opening time of day. Note: If the AllDay flag is set, then this time is ignored -->
  <availableEndTime value="[time]"/><!-- 0..1 The closing time of day. Note: If the AllDay flag is set, then this time is ignored -->
 </availableTime>
 <notAvailable>  <!-- 0..* The HealthcareService is not available during this period of time due to the provided reason -->
  <description value="[string]"/><!-- 1..1 The reason that can be presented to the user as to why this time is not available -->
  <during><!-- 0..1 Period Service is not available (seasonally or for a public holiday) from this date --></during>
 </notAvailable>
 <availabilityExceptions value="[string]"/><!-- 0..1 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 -->
</HealthcareService>

JSON Template

{doco
  "resourceType" : "HealthcareService",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Identifiers for this item
  "providedBy" : { Reference(Organization) }, // The organization that provides this Healthcare Service
  "location" : { Reference(Location) }, // R!  The location where this healthcare service may be provided
  "serviceCategory" : { CodeableConcept }, // 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
  "serviceType" : [{ // A specific type of service that may be delivered or performed
    "type" : { CodeableConcept }, // R!  The specific type of service being delivered or performed
    "specialty" : [{ CodeableConcept }] // Collection of Specialties handled by the Service Site. This is more of a Medical Term
  }],
  "serviceName" : "<string>", // Further description of the service as it would be presented to a consumer while searching
  "comment" : "<string>", // Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName
  "extraDetails" : "<string>", // Extra details about the service that can't be placed in the other fields
  "photo" : { Attachment }, // 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
  "telecom" : [{ ContactPoint }], // List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts
  "coverageArea" : [{ Reference(Location) }], // The location(s) that this service is available to (not where the service is provided)
  "serviceProvisionCode" : [{ CodeableConcept }], // The code(s) that detail the conditions under which the healthcare service is available/offered
  "eligibility" : { CodeableConcept }, // Does this service have specific eligibility requirements that need to be met in order to use the service
  "eligibilityNote" : "<string>", // Describes the eligibility conditions for the service
  "programName" : ["<string>"], // Program Names that can be used to categorize the service
  "characteristic" : [{ CodeableConcept }], // Collection of Characteristics (attributes)
  "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
  "publicKey" : "<string>", // 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
  "appointmentRequired" : <boolean>, // Indicates if an appointment is required for access to this service
  "availableTime" : [{ // A Collection of times that the Service Site is available
    "daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
    "allDay" : <boolean>, // Is this always available? (hence times are irrelevant) e.g. 24 hour service
    "availableStartTime" : "<time>", // The opening time of day. Note: If the AllDay flag is set, then this time is ignored
    "availableEndTime" : "<time>" // The closing time of day. Note: If the AllDay flag is set, then this time is ignored
  }],
  "notAvailable" : [{ // The HealthcareService is not available during this period of time due to the provided reason
    "description" : "<string>", // R!  The reason that can be presented to the user as to why this time is not available
    "during" : { Period } // Service is not available (seasonally or for a public holiday) from this date
  }],
  "availabilityExceptions" : "<string>" // 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
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON)

5.6.3.1 Terminology Bindings

PathDefinitionTypeReference
HealthcareService.serviceType.type Additional details about where the content was created (e.g. clinical specialty)Preferredhttp://hl7.org/fhir/vs/c80-practice-codes
HealthcareService.serviceProvisionCode The code(s) that detail the conditions under which the healthcare service is available/offeredExamplehttp://hl7.org/fhir/service-provision-conditions
HealthcareService.referralMethod The methods of referral can be used when referring to a specific HealthCareService resourceExamplehttp://hl7.org/fhir/service-referral-method
HealthcareService.availableTime.daysOfWeek The days of the weekRequiredhttp://hl7.org/fhir/days-of-week

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.

NameTypeDescriptionPaths
characteristictokenOne of the HealthcareService's characteristicsHealthcareService.characteristic
locationreferenceThe location of the Healthcare ServiceHealthcareService.location
(Location)
namestringA portion of the Healthcare service nameHealthcareService.serviceName
organizationreferenceThe organization that provides this Healthcare ServiceHealthcareService.providedBy
(Organization)
programnamestringOne of the Program Names serviced by this HealthcareServiceHealthcareService.programName
servicecategorytokenService Category of the Healthcare ServiceHealthcareService.serviceCategory
servicetypetokenThe type of service provided by this healthcare serviceHealthcareService.serviceType.type