This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Patient Administration Work Group | Maturity Level: 0 | Compartments: Not linked to any defined 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 Schedule
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | DomainResource | The details of a Healthcare Service available at a location | ||
identifier | Σ | 0..* | Identifier | External Identifiers for this item |
providedBy | Σ | 0..1 | Reference(Organization) | The organization that provides this Healthcare Service |
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 |
serviceType | Σ | 0..* | BackboneElement | A specific type of service that may be delivered or performed |
type | Σ | 1..1 | CodeableConcept | The specific type of service being delivered or performed Practice Setting Code Value Set (Preferred) |
specialty | Σ | 0..* | CodeableConcept | Collection of Specialties handled by the Service Site. This is more of a Medical Term |
location | Σ | 1..1 | Reference(Location) | The location where this healthcare service may be provided |
serviceName | Σ | 0..1 | string | Further description of the service as it would be presented to a consumer while searching |
comment | Σ | 0..1 | 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 | 0..1 | string | 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 |
telecom | 0..* | ContactPoint | List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts | |
coverageArea | 0..* | Reference(Location) | The location(s) that this service is available to (not where the service is provided) | |
serviceProvisionCode | 0..* | CodeableConcept | The code(s) that detail the conditions under which the healthcare service is available/offered ServiceProvisionConditions (Example) | |
eligibility | 0..1 | CodeableConcept | Does this service have specific eligibility requirements that need to be met in order 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 (attributes) | |
referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals ReferralMethod (Example) | |
publicKey | 0..1 | 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 | 0..1 | boolean | Indicates if an appointment is required for access to this service | |
availableTime | 0..* | BackboneElement | A Collection of times that the Service Site is available | |
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun DaysOfWeek (Required) | |
allDay | 0..1 | boolean | Is this always available? (hence times are irrelevant) e.g. 24 hour service | |
availableStartTime | 0..1 | time | The opening time of day. Note: If the AllDay flag is set, then this time is ignored | |
availableEndTime | 0..1 | time | The closing time of day. Note: If the AllDay flag is set, then this time is ignored | |
notAvailable | 0..* | BackboneElement | The HealthcareService is not available during this period of time due to the provided reason | |
description | 1..1 | string | 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 | |
availabilityExceptions | 0..1 | 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 | |
Documentation for this format |
UML Diagram
XML Template
<HealthcareService xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External Identifiers for this item --></identifier> <providedBy><!-- 0..1 Reference(Organization) The organization that provides this Healthcare Service --></providedBy> <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> <location><!-- 1..1 Reference(Location) The location where this healthcare service may be provided --></location> <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
{ "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 "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 }], "location" : { Reference(Location) }, // R! The location where this healthcare service may be provided "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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | DomainResource | The details of a Healthcare Service available at a location | ||
identifier | Σ | 0..* | Identifier | External Identifiers for this item |
providedBy | Σ | 0..1 | Reference(Organization) | The organization that provides this Healthcare Service |
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 |
serviceType | Σ | 0..* | BackboneElement | A specific type of service that may be delivered or performed |
type | Σ | 1..1 | CodeableConcept | The specific type of service being delivered or performed Practice Setting Code Value Set (Preferred) |
specialty | Σ | 0..* | CodeableConcept | Collection of Specialties handled by the Service Site. This is more of a Medical Term |
location | Σ | 1..1 | Reference(Location) | The location where this healthcare service may be provided |
serviceName | Σ | 0..1 | string | Further description of the service as it would be presented to a consumer while searching |
comment | Σ | 0..1 | 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 | 0..1 | string | 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 |
telecom | 0..* | ContactPoint | List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts | |
coverageArea | 0..* | Reference(Location) | The location(s) that this service is available to (not where the service is provided) | |
serviceProvisionCode | 0..* | CodeableConcept | The code(s) that detail the conditions under which the healthcare service is available/offered ServiceProvisionConditions (Example) | |
eligibility | 0..1 | CodeableConcept | Does this service have specific eligibility requirements that need to be met in order 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 (attributes) | |
referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals ReferralMethod (Example) | |
publicKey | 0..1 | 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 | 0..1 | boolean | Indicates if an appointment is required for access to this service | |
availableTime | 0..* | BackboneElement | A Collection of times that the Service Site is available | |
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun DaysOfWeek (Required) | |
allDay | 0..1 | boolean | Is this always available? (hence times are irrelevant) e.g. 24 hour service | |
availableStartTime | 0..1 | time | The opening time of day. Note: If the AllDay flag is set, then this time is ignored | |
availableEndTime | 0..1 | time | The closing time of day. Note: If the AllDay flag is set, then this time is ignored | |
notAvailable | 0..* | BackboneElement | The HealthcareService is not available during this period of time due to the provided reason | |
description | 1..1 | string | 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 | |
availabilityExceptions | 0..1 | 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 | |
Documentation for this format |
XML Template
<HealthcareService xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External Identifiers for this item --></identifier> <providedBy><!-- 0..1 Reference(Organization) The organization that provides this Healthcare Service --></providedBy> <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> <location><!-- 1..1 Reference(Location) The location where this healthcare service may be provided --></location> <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
{ "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 "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 }], "location" : { Reference(Location) }, // R! The location where this healthcare service may be provided "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), Questionnaire
Path | Definition | Type | Reference |
---|---|---|---|
HealthcareService.serviceType.type | Additional details about where the content was created (e.g. clinical specialty) | Preferred | Practice Setting Code Value Set |
HealthcareService.serviceProvisionCode | The code(s) that detail the conditions under which the healthcare service is available/offered | Example | ServiceProvisionConditions |
HealthcareService.referralMethod | The methods of referral can be used when referring to a specific HealthCareService resource | Example | ReferralMethod |
HealthcareService.availableTime.daysOfWeek | The days of the week | Required | DaysOfWeek |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
characteristic | token | One of the HealthcareService's characteristics | HealthcareService.characteristic |
identifier | token | External Identifiers for this item | HealthcareService.identifier |
location | reference | The location of the Healthcare Service | HealthcareService.location (Location) |
name | string | A portion of the Healthcare service name | HealthcareService.serviceName |
organization | reference | The organization that provides this Healthcare Service | HealthcareService.providedBy (Organization) |
programname | string | One of the Program Names serviced by this HealthcareService | HealthcareService.programName |
servicecategory | token | Service Category of the Healthcare Service | HealthcareService.serviceCategory |
servicetype | token | The type of service provided by this healthcare service | HealthcareService.serviceType.type |