Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU see ballot notes ). 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

8.8 Resource HealthcareService - Content

Patient Administration icon 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.

8.8.1 Scope and Usage

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
  • CT Head Scan w/o Contrast
  • CT Head Scan with Contrast
  • CT Head+Chest Scan with Contrast

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.
  • Catalog of schedulable services or activities

8.8.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.

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.

8.8.3 References to this Resource

This resource is referenced by UsageContext ,

8.8.4 Resource Content

Structure

Contacts related to availabilityExceptions 0..1 string Description of availability exceptions
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 ( Example )

. . . type Σ 0..* CodeableConcept Type of service that may be delivered or performed
ServiceType ( 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 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 . contact 0..* ContactPoint ExtendedContactDetail Official contact details for the healthcare service HealthcareService

. . . 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..* BackboneElement Specific eligibility requirements required to use the service

. . . . code 0..1 CodeableConcept Coded value for the eligibility
ServiceEligibility ( Example )
. . . . comment 0..1 markdown Describes the eligibility conditions for the service
. . . program 0..* CodeableConcept Programs that this service is applicable to
Program ( Example )

. . . characteristic 0..* CodeableConcept Collection of characteristics (attributes)
ServiceCharacteristic ( Example )

. . . 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 . availability 0..* code Availability mon | tue | wed | thu | fri | sat | sun DaysOfWeek ( Required ) allDay 0..1 boolean Always available? e.g. 24 hour Times the healthcare 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 is available during this time due to provided reason (including exceptions)
description 1..1 string Reason presented to the user explaining why time not available during 0..1 Period
Service not available from this date
. . . endpoint 0..* Reference ( Endpoint ) Technical endpoints providing access to electronic services operated for the healthcare service


doco Documentation for this format

See the Extensions for this resource

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 » When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service offeredIn : Reference [0..*] « HealthcareService » Identifies the broad category of service being performed or delivered category : CodeableConcept [0..*] « null (Strength=Example) ServiceCategory ?? » The specific type of service that may be delivered or performed type : CodeableConcept [0..*] « null (Strength=Example) ServiceType ?? » Collection of specialties handled by the service site. Healthcare service. This is more of a medical term specialty : CodeableConcept [0..*] « null (Strength=Preferred) 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 : 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 The contact details of contacts related communication devices available relevant to this the specific healthcare service HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites telecom contact : ContactPoint ExtendedContactDetail [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..*] « null (Strength=Example) ServiceProvisionConditions ?? » Programs that this service is applicable to program : CodeableConcept [0..*] « null (Strength=Example) Program ?? » Collection of characteristics (attributes) characteristic : CodeableConcept [0..*] « null (Strength=Example) ServiceCharacteristic?? » Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used communication : CodeableConcept [0..*] « null (Strength=Preferred) CommonLanguages ? » Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required referralMethod : CodeableConcept [0..*] « null (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 collection of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in times that the healthcare service is available Times and not available Times availabilityExceptions availability : string Availability [0..1] [0..*] 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] « null (Strength=Example) ServiceEligibility?? » 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..*] « null (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>
 <offeredIn><!-- 0..* Reference(HealthcareService) The service within which this service is offered --></offeredIn>

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

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

 <contact><!-- 0..* ExtendedContactDetail Official contact details for the HealthcareService --></contact>

 <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>  <!-- 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>
 <
  <
  <</during>
 </notAvailable>
 <

 <availability><!-- 0..* Availability Times the healthcare service is available (including exceptions) --></availability>

 <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
  "offeredIn" : [{ Reference(HealthcareService) }], // The service within which this service is offered

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

  "contact" : [{ ExtendedContactDetail }], // Official contact details for the HealthcareService

  "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
  "
    "
    "
    "
    "
  }],
  "
    "
    "
  }],
  "

  "availability" : [{ Availability }], // Times the healthcare service is available (including 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.offeredIn [ Reference(HealthcareService) ], ... ; # 0..* The service within which this service is offered

  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:

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

  fhir:HealthcareService.contact [ ExtendedContactDetail ], ... ; # 0..* Official contact details for the HealthcareService

  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: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:
    fhir:
    fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
    fhir:
    fhir:
  ], ...;
  fhir:

  fhir:HealthcareService.availability [ Availability ], ... ; # 0..* Times the healthcare service is available (including exceptions)

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

Changes since R4

HealthcareService
HealthcareService.offeredIn
  • No Changes Added Element
HealthcareService.contact
  • Added Element
HealthcareService.availability
  • Added Element
HealthcareService.telecom
  • deleted
HealthcareService.availableTime
  • deleted
HealthcareService.notAvailable
  • deleted
HealthcareService.availabilityExceptions
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4 See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). )

Structure

Contacts related to Service not available from this date availabilityExceptions 0..1 string Description of availability exceptions
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 ( Example )

. . . type Σ 0..* CodeableConcept Type of service that may be delivered or performed
ServiceType ( 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 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 . contact 0..* ContactPoint ExtendedContactDetail Official contact details for the healthcare service HealthcareService

. . . 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..* BackboneElement Specific eligibility requirements required to use the service

. . . . code 0..1 CodeableConcept Coded value for the eligibility
ServiceEligibility ( Example )
. . . . comment 0..1 markdown Describes the eligibility conditions for the service
. . . program 0..* CodeableConcept Programs that this service is applicable to
Program ( Example )

. . . characteristic 0..* CodeableConcept Collection of characteristics (attributes)
ServiceCharacteristic ( Example )

. . . 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 . availability 0..* code Availability mon | tue | wed | thu | fri | sat | sun DaysOfWeek ( Required ) allDay 0..1 boolean Always available? e.g. 24 hour Times the healthcare 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 is available during this time due to provided reason (including exceptions)
description 1..1 string Reason presented to the user explaining why time not available during 0..1 Period
. . . endpoint 0..* Reference ( Endpoint ) Technical endpoints providing access to electronic services operated for the healthcare service


doco Documentation for this format

See the Extensions for this resource

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 » When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service offeredIn : Reference [0..*] « HealthcareService » Identifies the broad category of service being performed or delivered category : CodeableConcept [0..*] « null (Strength=Example) ServiceCategory ?? » The specific type of service that may be delivered or performed type : CodeableConcept [0..*] « null (Strength=Example) ServiceType ?? » Collection of specialties handled by the service site. Healthcare service. This is more of a medical term specialty : CodeableConcept [0..*] « null (Strength=Preferred) 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 : 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 The contact details of contacts related communication devices available relevant to this the specific healthcare service HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites telecom contact : ContactPoint ExtendedContactDetail [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..*] « null (Strength=Example) ServiceProvisionConditions ?? » Programs that this service is applicable to program : CodeableConcept [0..*] « null (Strength=Example) Program ?? » Collection of characteristics (attributes) characteristic : CodeableConcept [0..*] « null (Strength=Example) ServiceCharacteristic?? » Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used communication : CodeableConcept [0..*] « null (Strength=Preferred) CommonLanguages ? » Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required referralMethod : CodeableConcept [0..*] « null (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 collection of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in times that the healthcare service is available Times and not available Times availabilityExceptions availability : string Availability [0..1] [0..*] 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] « null (Strength=Example) ServiceEligibility?? » 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..*] « null (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>
 <offeredIn><!-- 0..* Reference(HealthcareService) The service within which this service is offered --></offeredIn>

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

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

 <contact><!-- 0..* ExtendedContactDetail Official contact details for the HealthcareService --></contact>

 <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>  <!-- 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>
 <
  <
  <</during>
 </notAvailable>
 <

 <availability><!-- 0..* Availability Times the healthcare service is available (including exceptions) --></availability>

 <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
  "offeredIn" : [{ Reference(HealthcareService) }], // The service within which this service is offered

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

  "contact" : [{ ExtendedContactDetail }], // Official contact details for the HealthcareService

  "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
  "
    "
    "
    "
    "
  }],
  "
    "
    "
  }],
  "

  "availability" : [{ Availability }], // Times the healthcare service is available (including 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.offeredIn [ Reference(HealthcareService) ], ... ; # 0..* The service within which this service is offered

  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:

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

  fhir:HealthcareService.contact [ ExtendedContactDetail ], ... ; # 0..* Official contact details for the HealthcareService

  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: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:
    fhir:
    fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
    fhir:
    fhir:
  ], ...;
  fhir:

  fhir:HealthcareService.availability [ Availability ], ... ; # 0..* Times the healthcare service is available (including exceptions)

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

Changes since Release 4

HealthcareService
HealthcareService.offeredIn
  • No Changes Added Element
HealthcareService.contact
  • Added Element
HealthcareService.availability
  • Added Element
HealthcareService.telecom
  • deleted
HealthcareService.availableTime
  • deleted
HealthcareService.notAvailable
  • deleted
HealthcareService.availabilityExceptions
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4 See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). )

 

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

8.8.4.1 Terminology Bindings

HealthcareService.availableTime.daysOfWeek Required DaysOfWeek
Path Definition Type Reference
HealthcareService.category

This value set defines an example set of codes that can be used to classify groupings of service-types/specialties.

Example ServiceCategory
HealthcareService.type

This value set defines an example set of codes of service-types.

Example ServiceType
HealthcareService.specialty

This is the code representing the clinical specialty of the clinician or provider who interacted with, treated, or provided a service to/for the patient. The value set used for clinical specialty has been limited by HITSP to the value set reproduced from HITSP C80 Table 2-149 Clinical Specialty Value Set Definition.

Preferred PracticeSettingCodeValueSet
HealthcareService.serviceProvisionCode

The code(s) that detail the conditions under which the healthcare service is available/offered.

Example ServiceProvisionConditions
HealthcareService.eligibility.code Example ??
HealthcareService.program

This value set defines an example set of codes that could be can be used to classify groupings of service-types/specialties.

Example Program
HealthcareService.characteristic Example ??
HealthcareService.communication

This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47)

Preferred , but limited to AllLanguages CommonLanguages
HealthcareService.referralMethod

The methods of referral can be used when referring to a specific HealthCareService resource.

Example ReferralMethod

8.8.5 Notes:

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

8.8.6 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
active N token The Healthcare Service is currently marked as active HealthcareService.active
characteristic token One of the HealthcareService's characteristics HealthcareService.characteristic
coverage-area reference Location(s) service is intended for/available to HealthcareService.coverageArea
( Location )
endpoint reference Technical endpoints providing access to electronic services operated for the 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 N string A portion of the Healthcare service name HealthcareService.name
offered-in reference The service within which this service is offered HealthcareService.offeredIn
( HealthcareService )
organization reference The organization that provides this Healthcare Service HealthcareService.providedBy
( Organization )
program token One of the Programs supported by this HealthcareService HealthcareService.program
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