R4 Ballot #1 (Mixed Normative/Trial use) Current Build
This page was published as part of FHIR v3.3.0: R4 Ballot #1 : Mixed Normative/Trial use (First Normative ballot). It has been superceded by R4 . For a full list of available versions, see the Directory of published versions .

8.8 Resource HealthcareService - Content

Patient Administration Work Group Maturity Level : 2   Trial Use Security Category : Business 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:

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

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.

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.

The HealthcareService resource is used with the following resources:

  • Organization : The organization provides the services, the healthcareservice describes the services
  • ServiceRequest : This is a subject specific request for a specific service, it may be to a specific healthcare service, and/or simply a coded service value. The granularity included in the request codes may be finer than defined in the healthcare service.
  • OrganizationAffiliation : Might constrain a list of healthcare services that are available between 2 organizations
  • Location : Specifies the place where the service(s) are offered/available within.

This resource is referenced by UsageContext , Account , Appointment , AppointmentResponse , CarePlan , CatalogEntry , Communication , CommunicationRequest , DeviceRequest , EntryDefinition MedicationRequest , OrganizationRole OrganizationAffiliation , PractitionerRole , Procedure , Schedule , ServiceRequest , SupplyRequest and Task .

This resource implements the Participant pattern.

Structure

Name Flags Card. Type Description & Constraints doco
. . HealthcareService TU DomainResource The details of a healthcare service available at a location
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier External identifiers for this item
. . . active ?! Σ 0..1 boolean Whether this HealthcareService record is in active use
. . . providedBy Σ 0..1 Reference ( Organization ) Organization that provides this service
. . . category Σ 0..* CodeableConcept Broad category of service being performed or delivered
ServiceCategory Service category ( Example )
. . . type Σ 0..* CodeableConcept Type of service that may be delivered or performed
ServiceType Service type ( Example )
. . . specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Practice Setting Code Value Set ( Preferred )
. . . location Σ 0..* Reference ( Location ) Location(s) where service may be provided
. . . name Σ 0..1 string Description of service as presented to a consumer while searching
. . . comment Σ 0..1 string Additional description and/or any specific issues not covered elsewhere
. . . extraDetails 0..1 string markdown Extra details about the service that can't be placed in the other fields
. . . photo Σ 0..1 Attachment Facilitates quick identification of the service
. . . telecom 0..* ContactPoint Contacts related to the healthcare service
. . . coverageArea 0..* Reference ( Location ) Location(s) service is intended for/available to
. . . serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
ServiceProvisionConditions ( Example )
. . . eligibility 0..1 0..* CodeableConcept BackboneElement Specific eligibility requirements required to use the service
. . . eligibilityNote . code 0..1 string CodeableConcept Coded value for the eligibility
.... comment 0..1 markdown Describes the eligibility conditions for the service
. . programName . program 0..* string CodeableConcept Program Names Programs that categorize the this service is applicable to
Program ( Example )
. . . characteristic 0..* CodeableConcept Collection of characteristics (attributes)
. . . referralMethod communication 0..* CodeableConcept The language that this service is offered in
Common Languages ( Preferred but limited to AllLanguages )
... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
ReferralMethod ( Example )
. . . appointmentRequired 0..1 boolean If an appointment is required for access to this service
. . . availableTime 0..* BackboneElement Times the Service Site is available
. . . . daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
DaysOfWeek ( Required )
. . . . allDay 0..1 boolean Always available? e.g. 24 hour service
. . . . availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
. . . . availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
. . . notAvailable 0..* BackboneElement Not available during this time due to provided reason
. . . . description 1..1 string Reason presented to the user explaining why time not available
. . . . during 0..1 Period Service not available from this date
. . . availabilityExceptions 0..1 string Description of availability exceptions
. . . endpoint 0..* Reference ( Endpoint ) Technical endpoints providing access to electronic services operated for the location healthcare service

doco Documentation for this format

UML Diagram ( Legend )

HealthcareService ( DomainResource ) External identifiers for this item identifier : Identifier [0..*] This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this (this element modifies the meaning of other elements) active : boolean [0..1] The organization that provides this healthcare service providedBy : Reference [0..1] « Organization » Identifies the broad category of service being performed or delivered category : CodeableConcept [0..*] « A category of the service(s) that could be provided. (Strength=Example) ServiceCategory ?? » The specific type of service that may be delivered or performed type : CodeableConcept [0..*] « Additional details about where the content was created (e.g. clinical specialty). (Strength=Example) ServiceType ?? » Collection of specialties handled by the service site. This is more of a medical term specialty : CodeableConcept [0..*] « A specialty that a healthcare service may provide. (Strength=Preferred) Practice Setting Code Value S... PracticeSettingCodeValueSet ? » The location(s) where this healthcare service may be provided location : Reference [0..*] « Location » Further description of the service as it would be presented to a consumer while searching name : 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 comment : string [0..1] Extra details about the service that can't be placed in the other fields extraDetails : string markdown [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] List of contacts related to this specific healthcare service telecom : ContactPoint [0..*] The location(s) that this service is available to (not where the service is provided) coverageArea : Reference [0..*] « Location » 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 Programs that this service have specific eligibility requirements that need to be met in order is applicable to use the service? eligibility program : CodeableConcept [0..1] [0..*] « Government or local programs that this service applies to. (Strength=Example) Program ?? » Describes the eligibility conditions for the service Collection of characteristics (attributes) eligibilityNote characteristic : string CodeableConcept [0..1] [0..*] Program Names that can be used Some services are specifically made available in multiple languages, this property permits a directory to categorize declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used programName communication : string CodeableConcept [0..*] « Collection of characteristics (attributes) A human language. (Strength=Preferred) characteristic : CodeableConcept CommonLanguages [0..*] ? » Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required referralMethod : CodeableConcept [0..*] « The methods of referral can be used when referring to a specific HealthCareService resource. (Strength=Example) ReferralMethod ?? » Indicates 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 service appointmentRequired : boolean [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 availabilityExceptions : string [0..1] Technical endpoints providing access to services operated for the specific healthcare services defined at this resource endpoint : Reference [0..*] « Endpoint » Eligibility Coded value for the eligibility code : CodeableConcept [0..1] Describes the eligibility conditions for the service comment : markdown [0..1] AvailableTime Indicates which days of the week are available between the start and end Times daysOfWeek : code [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] The opening time of day. Note: If the AllDay flag is set, then this time is ignored availableStartTime : time [0..1] The closing time of day. Note: If the AllDay flag is set, then this time is ignored availableEndTime : time [0..1] NotAvailable The reason that can be presented to the user as to why this time is not available description : string [1..1] Service is not available (seasonally or for a public holiday) from this date during : Period [0..1] Does this service have specific eligibility requirements that need to be met in order to use the service? eligibility [0..*] A collection of times that the Service Site is available availableTime [0..*] The HealthcareService is not available during this period of time due to the provided reason notAvailable [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><!-- 0..* Identifier External identifiers for this item --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this HealthcareService record is in active use -->
 <providedBy><!-- 0..1 Reference(Organization) Organization that provides this service --></providedBy>
 <category><!-- 0..* CodeableConcept Broad category of service being performed or delivered --></category>
 <type><!-- 0..* CodeableConcept Type of service that may be delivered or performed --></type>
 <specialty><!-- 0..* CodeableConcept Specialties handled by the HealthcareService --></specialty>
 <location><!-- 0..* Reference(Location) Location(s) where service may be provided --></location>
 <name 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="[markdown]"/><!-- 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 intended for/available to --></coverageArea>
 <serviceProvisionCode><!-- 0..* CodeableConcept Conditions under which service is available/offered --></serviceProvisionCode>
 <</eligibility>
 <
 <

 <eligibility>  <!-- 0..* Specific eligibility requirements required to use the service -->
  <code><!-- 0..1 CodeableConcept Coded value for the eligibility --></code>
  <comment value="[markdown]"/><!-- 0..1 Describes the eligibility conditions for the service -->
 </eligibility>
 <program><!-- 0..* CodeableConcept Programs that this service is applicable to --></program>

 <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic>
 <communication><!-- 0..* CodeableConcept The language that this service is offered in --></communication>

 <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod>
 <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>
 <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 available from this date --></during>
 </notAvailable>
 <availabilityExceptions value="[string]"/><!-- 0..1 Description of availability exceptions -->
 <</endpoint>

 <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service --></endpoint>

</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
  "active" : <boolean>, // Whether this HealthcareService record is in active use
  "providedBy" : { Reference(Organization) }, // Organization that provides this service
  "category" : [{ CodeableConcept }], // Broad category of service being performed or delivered
  "type" : [{ CodeableConcept }], // Type of service that may be delivered or performed
  "specialty" : [{ CodeableConcept }], // Specialties handled by the HealthcareService
  "location" : [{ Reference(Location) }], // Location(s) where service may be provided
  "name" : "<string>", // Description of service as presented to a consumer while searching
  "comment" : "<string>", // Additional description and/or any specific issues not covered elsewhere
  "

  "extraDetails" : "<markdown>", // 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 intended for/available to
  "serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered
  "
  "
  "

  "eligibility" : [{ // Specific eligibility requirements required to use the service
    "code" : { CodeableConcept }, // Coded value for the eligibility
    "comment" : "<markdown>" // Describes the eligibility conditions for the service
  }],
  "program" : [{ CodeableConcept }], // Programs that this service is applicable to

  "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
  "communication" : [{ CodeableConcept }], // The language that this service is offered in

  "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
  "appointmentRequired" : <boolean>, // If an appointment is required for access to this service
  "availableTime" : [{ // Times the Service Site is available
    "daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
    "allDay" : <boolean>, // Always available? e.g. 24 hour service
    "availableStartTime" : "<time>", // Opening time of day (ignored if allDay = true)
    "availableEndTime" : "<time>" // Closing time of day (ignored if allDay = true)
  }],
  "notAvailable" : [{ // Not available during this time due to provided reason
    "description" : "<string>", // R!  Reason presented to the user explaining why time not available
    "during" : { Period } // Service not available from this date
  }],
  "availabilityExceptions" : "<string>", // Description of availability exceptions
  "

  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to electronic services operated for the healthcare service

}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:HealthcareService;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:HealthcareService.identifier [ Identifier ], ... ; # 0..* External identifiers for this item
  fhir:HealthcareService.active [ boolean ]; # 0..1 Whether this HealthcareService record is in active use
  fhir:HealthcareService.providedBy [ Reference(Organization) ]; # 0..1 Organization that provides this service
  fhir:HealthcareService.category [ CodeableConcept ], ... ; # 0..* Broad category of service being performed or delivered
  fhir:HealthcareService.type [ CodeableConcept ], ... ; # 0..* Type of service that may be delivered or performed
  fhir:HealthcareService.specialty [ CodeableConcept ], ... ; # 0..* Specialties handled by the HealthcareService
  fhir:HealthcareService.location [ Reference(Location) ], ... ; # 0..* Location(s) where service may be provided
  fhir:HealthcareService.name [ string ]; # 0..1 Description of service as presented to a consumer while searching
  fhir:HealthcareService.comment [ string ]; # 0..1 Additional description and/or any specific issues not covered elsewhere
  fhir:

  fhir:HealthcareService.extraDetails [ markdown ]; # 0..1 Extra details about the service that can't be placed in the other fields

  fhir:HealthcareService.photo [ Attachment ]; # 0..1 Facilitates quick identification of the service
  fhir:HealthcareService.telecom [ ContactPoint ], ... ; # 0..* Contacts related to the healthcare service
  fhir:HealthcareService.coverageArea [ Reference(Location) ], ... ; # 0..* Location(s) service is intended for/available to
  fhir:HealthcareService.serviceProvisionCode [ CodeableConcept ], ... ; # 0..* Conditions under which service is available/offered
  fhir:
  fhir:
  fhir:

  fhir:HealthcareService.eligibility [ # 0..* Specific eligibility requirements required to use the service
    fhir:HealthcareService.eligibility.code [ CodeableConcept ]; # 0..1 Coded value for the eligibility
    fhir:HealthcareService.eligibility.comment [ markdown ]; # 0..1 Describes the eligibility conditions for the service
  ], ...;
  fhir:HealthcareService.program [ CodeableConcept ], ... ; # 0..* Programs that this service is applicable to

  fhir:HealthcareService.characteristic [ CodeableConcept ], ... ; # 0..* Collection of characteristics (attributes)
  fhir:HealthcareService.communication [ CodeableConcept ], ... ; # 0..* The language that this service is offered in

  fhir:HealthcareService.referralMethod [ CodeableConcept ], ... ; # 0..* Ways that the service accepts referrals
  fhir:HealthcareService.appointmentRequired [ boolean ]; # 0..1 If an appointment is required for access to this service
  fhir:HealthcareService.availableTime [ # 0..* Times the Service Site is available
    fhir:HealthcareService.availableTime.daysOfWeek [ code ], ... ; # 0..* mon | tue | wed | thu | fri | sat | sun
    fhir:HealthcareService.availableTime.allDay [ boolean ]; # 0..1 Always available? e.g. 24 hour service
    fhir:HealthcareService.availableTime.availableStartTime [ time ]; # 0..1 Opening time of day (ignored if allDay = true)
    fhir:HealthcareService.availableTime.availableEndTime [ time ]; # 0..1 Closing time of day (ignored if allDay = true)
  ], ...;
  fhir:HealthcareService.notAvailable [ # 0..* Not available during this time due to provided reason
    fhir:HealthcareService.notAvailable.description [ string ]; # 1..1 Reason presented to the user explaining why time not available
    fhir:HealthcareService.notAvailable.during [ Period ]; # 0..1 Service not available from this date
  ], ...;
  fhir:HealthcareService.availabilityExceptions [ string ]; # 0..1 Description of availability exceptions
  fhir:

  fhir:HealthcareService.endpoint [ Reference(Endpoint) ], ... ; # 0..* Technical endpoints providing access to electronic services operated for the healthcare service

]

Changes since R3

HealthcareService
HealthcareService.active Default Value "true" removed HealthcareService.category HealthcareService.availableTime.daysOfWeek
  • Max Cardinality changed Change value set from 1 http://hl7.org/fhir/ValueSet/days-of-week|4.0.0 to * http://hl7.org/fhir/ValueSet/days-of-week|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. 1 fail All tests pass round-trip testing and all 1 r3 resources are valid.). Note: these have note yet been updated to be R3 to R4 invalid (0 errors). )

Structure

Name Flags Card. Type Description & Constraints doco
. . HealthcareService TU DomainResource The details of a healthcare service available at a location
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier External identifiers for this item
. . . active ?! Σ 0..1 boolean Whether this HealthcareService record is in active use
. . . providedBy Σ 0..1 Reference ( Organization ) Organization that provides this service
. . . category Σ 0..* CodeableConcept Broad category of service being performed or delivered
ServiceCategory Service category ( Example )
. . . type Σ 0..* CodeableConcept Type of service that may be delivered or performed
ServiceType Service type ( Example )
. . . specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Practice Setting Code Value Set ( Preferred )
. . . location Σ 0..* Reference ( Location ) Location(s) where service may be provided
. . . name Σ 0..1 string Description of service as presented to a consumer while searching
. . . comment Σ 0..1 string Additional description and/or any specific issues not covered elsewhere
. . . extraDetails 0..1 string markdown Extra details about the service that can't be placed in the other fields
. . . photo Σ 0..1 Attachment Facilitates quick identification of the service
. . . telecom 0..* ContactPoint Contacts related to the healthcare service
. . . coverageArea 0..* Reference ( Location ) Location(s) service is intended for/available to
. . . serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
ServiceProvisionConditions ( Example )
. . . eligibility 0..1 0..* CodeableConcept BackboneElement Specific eligibility requirements required to use the service
. . . eligibilityNote . code 0..1 string CodeableConcept Coded value for the eligibility
.... comment 0..1 markdown Describes the eligibility conditions for the service
. . programName . program 0..* string CodeableConcept Program Names Programs that categorize the this service is applicable to
Program ( Example )
. . . characteristic 0..* CodeableConcept Collection of characteristics (attributes)
. . . referralMethod communication 0..* CodeableConcept The language that this service is offered in
Common Languages ( Preferred but limited to AllLanguages )
... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
ReferralMethod ( Example )
. . . appointmentRequired 0..1 boolean If an appointment is required for access to this service
. . . availableTime 0..* BackboneElement Times the Service Site is available
. . . . daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
DaysOfWeek ( Required )
. . . . allDay 0..1 boolean Always available? e.g. 24 hour service
. . . . availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
. . . . availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
. . . notAvailable 0..* BackboneElement Not available during this time due to provided reason
. . . . description 1..1 string Reason presented to the user explaining why time not available
. . . . during 0..1 Period Service not available from this date
. . . availabilityExceptions 0..1 string Description of availability exceptions
. . . endpoint 0..* Reference ( Endpoint ) Technical endpoints providing access to electronic services operated for the location healthcare service

doco Documentation for this format

UML Diagram ( Legend )

HealthcareService ( DomainResource ) External identifiers for this item identifier : Identifier [0..*] This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this (this element modifies the meaning of other elements) active : boolean [0..1] The organization that provides this healthcare service providedBy : Reference [0..1] « Organization » Identifies the broad category of service being performed or delivered category : CodeableConcept [0..*] « A category of the service(s) that could be provided. (Strength=Example) ServiceCategory ?? » The specific type of service that may be delivered or performed type : CodeableConcept [0..*] « Additional details about where the content was created (e.g. clinical specialty). (Strength=Example) ServiceType ?? » Collection of specialties handled by the service site. This is more of a medical term specialty : CodeableConcept [0..*] « A specialty that a healthcare service may provide. (Strength=Preferred) Practice Setting Code Value S... PracticeSettingCodeValueSet ? » The location(s) where this healthcare service may be provided location : Reference [0..*] « Location » Further description of the service as it would be presented to a consumer while searching name : 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 comment : string [0..1] Extra details about the service that can't be placed in the other fields extraDetails : string markdown [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] List of contacts related to this specific healthcare service telecom : ContactPoint [0..*] The location(s) that this service is available to (not where the service is provided) coverageArea : Reference [0..*] « Location » 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 Programs that this service have specific eligibility requirements that need to be met in order is applicable to use the service? eligibility program : CodeableConcept [0..1] [0..*] « Government or local programs that this service applies to. (Strength=Example) Program ?? » Describes the eligibility conditions for the service Collection of characteristics (attributes) eligibilityNote characteristic : string CodeableConcept [0..1] [0..*] Program Names that can be used Some services are specifically made available in multiple languages, this property permits a directory to categorize declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used programName communication : string CodeableConcept [0..*] « Collection of characteristics (attributes) A human language. (Strength=Preferred) characteristic : CodeableConcept CommonLanguages [0..*] ? » Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required referralMethod : CodeableConcept [0..*] « The methods of referral can be used when referring to a specific HealthCareService resource. (Strength=Example) ReferralMethod ?? » Indicates 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 service appointmentRequired : boolean [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 availabilityExceptions : string [0..1] Technical endpoints providing access to services operated for the specific healthcare services defined at this resource endpoint : Reference [0..*] « Endpoint » Eligibility Coded value for the eligibility code : CodeableConcept [0..1] Describes the eligibility conditions for the service comment : markdown [0..1] AvailableTime Indicates which days of the week are available between the start and end Times daysOfWeek : code [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] The opening time of day. Note: If the AllDay flag is set, then this time is ignored availableStartTime : time [0..1] The closing time of day. Note: If the AllDay flag is set, then this time is ignored availableEndTime : time [0..1] NotAvailable The reason that can be presented to the user as to why this time is not available description : string [1..1] Service is not available (seasonally or for a public holiday) from this date during : Period [0..1] Does this service have specific eligibility requirements that need to be met in order to use the service? eligibility [0..*] A collection of times that the Service Site is available availableTime [0..*] The HealthcareService is not available during this period of time due to the provided reason notAvailable [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><!-- 0..* Identifier External identifiers for this item --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this HealthcareService record is in active use -->
 <providedBy><!-- 0..1 Reference(Organization) Organization that provides this service --></providedBy>
 <category><!-- 0..* CodeableConcept Broad category of service being performed or delivered --></category>
 <type><!-- 0..* CodeableConcept Type of service that may be delivered or performed --></type>
 <specialty><!-- 0..* CodeableConcept Specialties handled by the HealthcareService --></specialty>
 <location><!-- 0..* Reference(Location) Location(s) where service may be provided --></location>
 <name 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="[markdown]"/><!-- 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 intended for/available to --></coverageArea>
 <serviceProvisionCode><!-- 0..* CodeableConcept Conditions under which service is available/offered --></serviceProvisionCode>
 <</eligibility>
 <
 <

 <eligibility>  <!-- 0..* Specific eligibility requirements required to use the service -->
  <code><!-- 0..1 CodeableConcept Coded value for the eligibility --></code>
  <comment value="[markdown]"/><!-- 0..1 Describes the eligibility conditions for the service -->
 </eligibility>
 <program><!-- 0..* CodeableConcept Programs that this service is applicable to --></program>

 <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic>
 <communication><!-- 0..* CodeableConcept The language that this service is offered in --></communication>

 <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod>
 <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>
 <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 available from this date --></during>
 </notAvailable>
 <availabilityExceptions value="[string]"/><!-- 0..1 Description of availability exceptions -->
 <</endpoint>

 <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service --></endpoint>

</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
  "active" : <boolean>, // Whether this HealthcareService record is in active use
  "providedBy" : { Reference(Organization) }, // Organization that provides this service
  "category" : [{ CodeableConcept }], // Broad category of service being performed or delivered
  "type" : [{ CodeableConcept }], // Type of service that may be delivered or performed
  "specialty" : [{ CodeableConcept }], // Specialties handled by the HealthcareService
  "location" : [{ Reference(Location) }], // Location(s) where service may be provided
  "name" : "<string>", // Description of service as presented to a consumer while searching
  "comment" : "<string>", // Additional description and/or any specific issues not covered elsewhere
  "

  "extraDetails" : "<markdown>", // 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 intended for/available to
  "serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered
  "
  "
  "

  "eligibility" : [{ // Specific eligibility requirements required to use the service
    "code" : { CodeableConcept }, // Coded value for the eligibility
    "comment" : "<markdown>" // Describes the eligibility conditions for the service
  }],
  "program" : [{ CodeableConcept }], // Programs that this service is applicable to

  "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
  "communication" : [{ CodeableConcept }], // The language that this service is offered in

  "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
  "appointmentRequired" : <boolean>, // If an appointment is required for access to this service
  "availableTime" : [{ // Times the Service Site is available
    "daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
    "allDay" : <boolean>, // Always available? e.g. 24 hour service
    "availableStartTime" : "<time>", // Opening time of day (ignored if allDay = true)
    "availableEndTime" : "<time>" // Closing time of day (ignored if allDay = true)
  }],
  "notAvailable" : [{ // Not available during this time due to provided reason
    "description" : "<string>", // R!  Reason presented to the user explaining why time not available
    "during" : { Period } // Service not available from this date
  }],
  "availabilityExceptions" : "<string>", // Description of availability exceptions
  "

  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to electronic services operated for the healthcare service

}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:HealthcareService;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:HealthcareService.identifier [ Identifier ], ... ; # 0..* External identifiers for this item
  fhir:HealthcareService.active [ boolean ]; # 0..1 Whether this HealthcareService record is in active use
  fhir:HealthcareService.providedBy [ Reference(Organization) ]; # 0..1 Organization that provides this service
  fhir:HealthcareService.category [ CodeableConcept ], ... ; # 0..* Broad category of service being performed or delivered
  fhir:HealthcareService.type [ CodeableConcept ], ... ; # 0..* Type of service that may be delivered or performed
  fhir:HealthcareService.specialty [ CodeableConcept ], ... ; # 0..* Specialties handled by the HealthcareService
  fhir:HealthcareService.location [ Reference(Location) ], ... ; # 0..* Location(s) where service may be provided
  fhir:HealthcareService.name [ string ]; # 0..1 Description of service as presented to a consumer while searching
  fhir:HealthcareService.comment [ string ]; # 0..1 Additional description and/or any specific issues not covered elsewhere
  fhir:

  fhir:HealthcareService.extraDetails [ markdown ]; # 0..1 Extra details about the service that can't be placed in the other fields

  fhir:HealthcareService.photo [ Attachment ]; # 0..1 Facilitates quick identification of the service
  fhir:HealthcareService.telecom [ ContactPoint ], ... ; # 0..* Contacts related to the healthcare service
  fhir:HealthcareService.coverageArea [ Reference(Location) ], ... ; # 0..* Location(s) service is intended for/available to
  fhir:HealthcareService.serviceProvisionCode [ CodeableConcept ], ... ; # 0..* Conditions under which service is available/offered
  fhir:
  fhir:
  fhir:

  fhir:HealthcareService.eligibility [ # 0..* Specific eligibility requirements required to use the service
    fhir:HealthcareService.eligibility.code [ CodeableConcept ]; # 0..1 Coded value for the eligibility
    fhir:HealthcareService.eligibility.comment [ markdown ]; # 0..1 Describes the eligibility conditions for the service
  ], ...;
  fhir:HealthcareService.program [ CodeableConcept ], ... ; # 0..* Programs that this service is applicable to

  fhir:HealthcareService.characteristic [ CodeableConcept ], ... ; # 0..* Collection of characteristics (attributes)
  fhir:HealthcareService.communication [ CodeableConcept ], ... ; # 0..* The language that this service is offered in

  fhir:HealthcareService.referralMethod [ CodeableConcept ], ... ; # 0..* Ways that the service accepts referrals
  fhir:HealthcareService.appointmentRequired [ boolean ]; # 0..1 If an appointment is required for access to this service
  fhir:HealthcareService.availableTime [ # 0..* Times the Service Site is available
    fhir:HealthcareService.availableTime.daysOfWeek [ code ], ... ; # 0..* mon | tue | wed | thu | fri | sat | sun
    fhir:HealthcareService.availableTime.allDay [ boolean ]; # 0..1 Always available? e.g. 24 hour service
    fhir:HealthcareService.availableTime.availableStartTime [ time ]; # 0..1 Opening time of day (ignored if allDay = true)
    fhir:HealthcareService.availableTime.availableEndTime [ time ]; # 0..1 Closing time of day (ignored if allDay = true)
  ], ...;
  fhir:HealthcareService.notAvailable [ # 0..* Not available during this time due to provided reason
    fhir:HealthcareService.notAvailable.description [ string ]; # 1..1 Reason presented to the user explaining why time not available
    fhir:HealthcareService.notAvailable.during [ Period ]; # 0..1 Service not available from this date
  ], ...;
  fhir:HealthcareService.availabilityExceptions [ string ]; # 0..1 Description of availability exceptions
  fhir:

  fhir:HealthcareService.endpoint [ Reference(Endpoint) ], ... ; # 0..* Technical endpoints providing access to electronic services operated for the healthcare service

]

Changes since DSTU2 Release 3

HealthcareService
HealthcareService.active Default Value "true" removed HealthcareService.category HealthcareService.availableTime.daysOfWeek
  • Max Cardinality changed Change value set from 1 http://hl7.org/fhir/ValueSet/days-of-week|4.0.0 to * http://hl7.org/fhir/ValueSet/days-of-week|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON .

See R2 <--> R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. 1 fail All tests pass round-trip testing and all 1 r3 resources are valid.). Note: these have note yet been updated to be R3 to R4 invalid (0 errors). )

 

Alternate See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis a

Path Definition Type Reference
HealthcareService.category A category of the service(s) that could be provided. Example ServiceCategory
HealthcareService.type Additional details about where the content was created (e.g. clinical specialty). Example ServiceType
HealthcareService.specialty A specialty that a healthcare service may provide. Preferred Practice Setting Code Value Set PracticeSettingCodeValueSet
HealthcareService.serviceProvisionCode The code(s) that detail the conditions under which the healthcare service is available/offered. Example ServiceProvisionConditions
HealthcareService.eligibility HealthcareService.eligibility.code Coded values underwhich a specific service is made available. Unknown No details provided yet
HealthcareService.program Government or local programs that this service applies to. Example Program
HealthcareService.characteristic A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). Unknown No details provided yet
HealthcareService.communication A human language. Preferred , but limited to AllLanguages CommonLanguages
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

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

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 Expression In Common
active token The Healthcare Service is currently marked as active HealthcareService.active
category characteristic token Service Category One of the Healthcare Service HealthcareService's characteristics HealthcareService.category HealthcareService.characteristic
characteristic coverage-area token reference One of the HealthcareService's characteristics Location(s) service is intended for/available to HealthcareService.characteristic HealthcareService.coverageArea
( Location )
endpoint reference Technical endpoints providing access to electronic services operated for the location healthcare service HealthcareService.endpoint
( Endpoint )
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.name
organization reference The organization that provides this Healthcare Service HealthcareService.providedBy
( Organization )
programname program string token One of the Program Names serviced Programs supported by this HealthcareService HealthcareService.programName HealthcareService.program
type service-category token Service Category of the Healthcare Service HealthcareService.category
service-type token The type of service provided by this healthcare service HealthcareService.type
specialty token The specialty of the service provided by this healthcare service HealthcareService.specialty