Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.8 Resource HealthcareService - Mixed Normative Content

Responsible Owner: Patient Administration icon Work Group   Trial Use Security Category : Business Compartments : No defined compartments

The details of a healthcare service available at a location.

8.8.1 Scope and STU 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. General categories of services, such as "Radiology" are typically not directly schedulable, but would be more specific services like "CT Scan" which are specific services within Radiology.
The location of the services could be virtual, as with telemedicine services.

HealthcareService is the intersection of Organization, Location and Service. It can also be used as actor, e.g. as performer/requester/recipient (therefore it is also available on the request and the event pattern in it's permanent such roles). In such cases the meaning of "HealthcareService A ordered B" translates to "The collection of people who work with/for HealthcareService A ordered B"

Common examples of HealthcareServices that may be offered at an organization/location include:

  • Clinical Neuropsychologist
  • Podiatry Service
  • Smallville Hospital Emergency Services
  • Respite care provided at a nursing home (it will always 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 (multiple instances for variations such as with or w/o 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 at a location/organization

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

8.8.4 Resource Content

Structure

Name Flags Card. Type Description & Constraints      Filter: Filtersdoco
.. 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 URL). 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
Binding: Service Category ( Example )

... type Σ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: Service Type ( Example )

... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: Practice Setting Code Value Set ( Example )

... 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 markdown 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
... contact 0..* ExtendedContactDetail Official contact details for the HealthcareService

... coverageArea 0..* Reference ( Location ) Location(s) service is intended for/available to

... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: Service Provision Conditions ( Example )

... eligibility C 0..* BackboneElement Specific eligibility requirements required to use the service
+ Rule: To use an eligibility value a code must also be provided to determine the type of eligibility the value applies to.

.... code C 0..1 CodeableConcept Coded value for the eligibility
Binding: Eligibility Characteristics ( Example )
.... value[x] C 0..1 Value associated with the eligibility code
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference ()
.... comment 0..1 markdown Describes the eligibility conditions for the service
.... period 0..1 markdown The period this eligibility rule applies
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program ( Example )

... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: Service Mode ( Example )

... communication 0..* CodeableConcept The language that this service is offered in
Binding: All Languages ( Required )
Additional Bindings Purpose
Common Languages Starter


... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: Referral Method ( Example )

... referralRequired 0..1 boolean A referral is required for access to this service
... appointmentRequired 0..1 boolean An appointment is required for access to this service
... availability 0..1 Availability Times the healthcare service is available (including exceptions)
... endpoint 0..* Reference ( Endpoint ) Technical endpoints providing access to electronic services operated for the healthcare service


doco Documentation for this format icon

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 Healthcare service. This is more of a medical term specialty : CodeableConcept [0..*] « null (Strength=Example) 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 : markdown [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 full list photo : Attachment [0..1] The contact details of communication devices available versions, see relevant to the Directory specific HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites contact : 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 published versions characteristics (attributes) characteristic : CodeableConcept [0..*] « . Page versions: R4B null (Strength=Example) ServiceMode ?? » 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=Required) AllLanguages ! » 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 a referral for a particular service at a site to be provided by the Organization referralRequired : boolean [0..1] Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization appointmentRequired : boolean [0..1] A collection of times that the healthcare service is available availability : Availability [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] « null (Strength=Example) Eligibility ?? » « This element has or is affected by some invariants C » Sometimes an eligibility code requires additional data to calculate the eligibility rules value[x] : DataType [0..1] « CodeableConcept | boolean | Quantity | Range | Reference » « This element has or is affected by some invariants C » Describes the eligibility conditions for the service comment : markdown [0..1] The period that this eligibility rule is a requirement for this service period : markdown [0..1] Does this service have specific eligibility requirements that need to be met in order to use the service? eligibility [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><!-- 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="[markdown]"/><!-- 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>
 <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><!-- I 0..1 CodeableConcept Coded value for the eligibility --></code>
  <value[x]><!-- I 0..1 CodeableConcept|boolean|Quantity|Range|Reference Value associated with the eligibility code --></value[x]>
  <comment value="[markdown]"/><!-- 0..1 Describes the eligibility conditions for the service -->
  <period value="[markdown]"/><!-- 0..1 The period this eligibility rule applies -->
 </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>
 <referralRequired value="[boolean]"/><!-- 0..1 A referral is required for access to this service -->
 <appointmentRequired value="[boolean]"/><!-- 0..1 An appointment is required for access to this service -->
 <availability><!-- 0..1 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" : "<markdown>", // 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 }, // I Coded value for the eligibility
    // value[x]: Value associated with the eligibility code. One of these 5:

    "valueCodeableConcept" : { CodeableConcept },
    "valueBoolean" : <boolean>,
    "valueQuantity" : { Quantity },
    "valueRange" : { Range },
    "valueReference" : { Reference },
    "comment" : "<markdown>", // Describes the eligibility conditions for the service
    "period" : "<markdown>" // The period this eligibility rule applies
  }],
  "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
  "referralRequired" : <boolean>, // A referral is required for access to this service
  "appointmentRequired" : <boolean>, // 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: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* External identifiers for this item
  fhir:active [ boolean ] ; # 0..1 Whether this HealthcareService record is in active use
  fhir:providedBy [ Reference(Organization) ] ; # 0..1 Organization that provides this service
  fhir:offeredIn  ( [ Reference(HealthcareService) ] ... ) ; # 0..* The service within which this service is offered
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Broad category of service being performed or delivered
  fhir:type  ( [ CodeableConcept ] ... ) ; # 0..* Type of service that may be delivered or performed
  fhir:specialty  ( [ CodeableConcept ] ... ) ; # 0..* Specialties handled by the HealthcareService
  fhir:location  ( [ Reference(Location) ] ... ) ; # 0..* Location(s) where service may be provided
  fhir:name [ string ] ; # 0..1 Description of service as presented to a consumer while searching
  fhir:comment [ markdown ] ; # 0..1 Additional description and/or any specific issues not covered elsewhere
  fhir:extraDetails [ markdown ] ; # 0..1 Extra details about the service that can't be placed in the other fields
  fhir:photo [ Attachment ] ; # 0..1 Facilitates quick identification of the service
  fhir:contact  ( [ ExtendedContactDetail ] ... ) ; # 0..* Official contact details for the HealthcareService
  fhir:coverageArea  ( [ Reference(Location) ] ... ) ; # 0..* Location(s) service is intended for/available to
  fhir:serviceProvisionCode  ( [ CodeableConcept ] ... ) ; # 0..* Conditions under which service is available/offered
  fhir:eligibility ( [ # 0..* Specific eligibility requirements required to use the service
    fhir:code [ CodeableConcept ] ; # 0..1 I Coded value for the eligibility
    # value[x] : 0..1 I Value associated with the eligibility code. One of these 5
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:Boolean ; boolean ]
      fhir:value [  a fhir:Quantity ; Quantity ]
      fhir:value [  a fhir:Range ; Range ]
      fhir:value [  a fhir:Reference ; Reference ]
    fhir:comment [ markdown ] ; # 0..1 Describes the eligibility conditions for the service
    fhir:period [ markdown ] ; # 0..1 The period this eligibility rule applies
  ] ... ) ;
  fhir:program  ( [ CodeableConcept ] ... ) ; # 0..* Programs that this service is applicable to
  fhir:characteristic  ( [ CodeableConcept ] ... ) ; # 0..* Collection of characteristics (attributes)
  fhir:communication  ( [ CodeableConcept ] ... ) ; # 0..* The language that this service is offered in
  fhir:referralMethod  ( [ CodeableConcept ] ... ) ; # 0..* Ways that the service accepts referrals
  fhir:referralRequired [ boolean ] ; # 0..1 A referral is required for access to this service
  fhir:appointmentRequired [ boolean ] ; # 0..1 An appointment is required for access to this service
  fhir:availability [ Availability ] ; # 0..1 Times the healthcare service is available (including exceptions)
  fhir:endpoint  ( [ Reference(Endpoint) ] ... ) ; # 0..* Technical endpoints providing access to electronic services operated for the healthcare service
]

Changes from both R4 and R4B

Extension-event-location.xml
FHIR Infrastructure HealthcareService Work Group Maturity Level : N/A
HealthcareService.offeredIn
  • Added Element
Standards Status : Informative
HealthcareService.comment
  • Type changed from string to markdown
HealthcareService.contact
  • Added Element
HealthcareService.eligibility.value[x]
  • Added Element
HealthcareService.eligibility.period
  • Added Element
HealthcareService.communication
HealthcareService.referralRequired
  • Added Element
HealthcareService.availability
  • Added Element
HealthcareService.telecom
  • Deleted (-> HealthcareService.contact.telecom)
HealthcareService.availableTime
  • Deleted (-> HealthcareService.availability.availabileTime)
HealthcareService.notAvailable
  • Deleted (-> HealthcareService.availability.notAvailabileTime)
HealthcareService.availabilityExceptions
  • Deleted (-> HealthcareService.availability.notAvailabileTime.description)

Raw See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

Structure

Name Flags Card. Type Description & Constraints      Filter: Filtersdoco
.. 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 ( canonical form Organization ) Organization that provides this service
... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: Service Category ( Example )

... type Σ 0..* CodeableConcept Type of service that may be delivered or performed
Binding: Service Type ( Example )

... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: Practice Setting Code Value Set ( Example )

... 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 markdown 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
... contact 0..* ExtendedContactDetail Official contact details for the HealthcareService

... coverageArea 0..* Reference ( Location ) Location(s) service is intended for/available to

... serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
Binding: Service Provision Conditions ( Example )

... eligibility C 0..* BackboneElement Specific eligibility requirements required to use the service
+ Rule: To use an eligibility value a code must also see XML Format Specification be provided to determine the type of eligibility the value applies to.

.... code C 0..1 CodeableConcept Coded value for the eligibility
Binding: Eligibility Characteristics ( Example )
.... value[x] C 0..1 Value associated with the eligibility code
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference ()
.... comment 0..1 markdown Describes the eligibility conditions for the service
.... period 0..1 markdown The period this eligibility rule applies
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program ( Example )

... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: Service Mode ( Example )

... communication 0..* CodeableConcept The language that this service is offered in
Binding: All Languages ( Required )
Additional Bindings Purpose
Common Languages Starter


... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: Referral Method ( Example )

... referralRequired 0..1 boolean A referral is required for access to this service
... appointmentRequired 0..1 boolean An appointment is required for access to this service
... availability 0..1 Availability Times the healthcare service is available (including exceptions)
... endpoint 0..* Reference ( Endpoint ) Technical endpoints providing access to electronic services operated for the healthcare service


doco Documentation for this format icon

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 Healthcare service. This is more of a medical term specialty : CodeableConcept [0..*] « null (Strength=Example) 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 : markdown [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] The contact details of communication devices available relevant to the specific HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites contact : 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) ServiceMode ?? » 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=Required) AllLanguages ! » 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 a referral for a particular service at a site to be provided by the Organization referralRequired : boolean [0..1] Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization appointmentRequired : boolean [0..1] A collection of times that the healthcare service is available availability : Availability [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] « null (Strength=Example) Eligibility ?? » « This element has or is affected by some invariants C » Sometimes an eligibility code requires additional data to calculate the eligibility rules value[x] : DataType [0..1] « CodeableConcept | boolean | Quantity | Range | Reference » « This element has or is affected by some invariants C » Describes the eligibility conditions for the service comment : markdown [0..1] The period that this eligibility rule is a requirement for this service period : markdown [0..1] Does this service have specific eligibility requirements that need to be met in order to use the service? eligibility [0..*]

XML Template

<?xml version="1.0" encoding="UTF-8"?> 
<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><!-- 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="[markdown]"/><!-- 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>
 <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><!-- I 0..1 CodeableConcept Coded value for the eligibility --></code>
  <value[x]><!-- I 0..1 CodeableConcept|boolean|Quantity|Range|Reference Value associated with the eligibility code --></value[x]>
  <comment value="[markdown]"/><!-- 0..1 Describes the eligibility conditions for the service -->
  <period value="[markdown]"/><!-- 0..1 The period this eligibility rule applies -->
 </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>
 <referralRequired value="[boolean]"/><!-- 0..1 A referral is required for access to this service -->
 <appointmentRequired value="[boolean]"/><!-- 0..1 An appointment is required for access to this service -->
 <availability><!-- 0..1 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" : "<markdown>", // 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 }, // I Coded value for the eligibility
    // value[x]: Value associated with the eligibility code. One of these 5:

    "valueCodeableConcept" : { CodeableConcept },
    "valueBoolean" : <boolean>,
    "valueQuantity" : { Quantity },
    "valueRange" : { Range },
    "valueReference" : { Reference },
    "comment" : "<markdown>", // Describes the eligibility conditions for the service
    "period" : "<markdown>" // The period this eligibility rule applies
  }],
  "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
  "referralRequired" : <boolean>, // A referral is required for access to this service
  "appointmentRequired" : <boolean>, // 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



  
  
    
  
  
    
  
  
  
  
  
  
  
  
  
    
      
      
    
  
  
  
  
    
    
    
  
  
    
    
    
  
  
    
    
    
  
  
  
  
    
    
  
  
    
    
  
  
    
    
  
  
    
    
  
  
  
  
  
    
      
      
      
      May reference only *Provenance* resources deemed “relevant� or important. This element
       does not point to the Provenance associated with the current version of the resource -
       as it would be created after this version existed. The Provenance for the current version
       can be retrieved with a [` _revinclude`](search.html#revinclude).
      
      
      
        
        
        
      
      
      
        
        
        
        
        
        
      
      
        
        
        
        
        
        
      
      
      
        
        
      
      
        
        
      
      
        
        
      
    
    
      
      
      
      Unique id for the element within a resource (for internal references). This may be any
       string value that does not contain spaces.
      
      
      
        
        
        
      
      
        
          
        
        
      
      
      
      
        
        
      
    
    
      
      
        
          
          
        
        
        
      
      
      
      
      
      
        
        
        
      
      
        
      
      
        
        
        
        
        
        
      
      
        
        
        
        
        
        
      
      
      
    
    
      
      
      
      
      The definition may point directly to a computable or human-readable definition of the
       extensibility codes, or it may be a logical URI as declared in some other specification.
       The definition SHALL be a URI for the Structure Definition defining the extension.
      
      
      
        
        
        
      
      
        
          
        
        
      
      
      
      
      
        
        
      
    
    
      
      
      Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://
      hl7.org/fhir/extensibility.html) for a list).
      
      
      
        
        
        
      
      
        
        
      
      
        
        
        
        
        
        
      
      
      
      
        
        
      
    
  
  
    
      
      
      
      May reference only *Provenance* resources deemed “relevant� or important. This element
       does not point to the Provenance associated with the current version of the resource -
       as it would be created after this version existed. The Provenance for the current version
       can be retrieved with a [` _revinclude`](search.html#revinclude).
      
      
      
        
        
      
      
        
        
      
      
        
        
      
    
    
      
      
    
    
      
      
    
    
      
      
      
        
        
      
    
  


[ a fhir:HealthcareService;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* External identifiers for this item
  fhir:active [ boolean ] ; # 0..1 Whether this HealthcareService record is in active use
  fhir:providedBy [ Reference(Organization) ] ; # 0..1 Organization that provides this service
  fhir:offeredIn  ( [ Reference(HealthcareService) ] ... ) ; # 0..* The service within which this service is offered
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Broad category of service being performed or delivered
  fhir:type  ( [ CodeableConcept ] ... ) ; # 0..* Type of service that may be delivered or performed
  fhir:specialty  ( [ CodeableConcept ] ... ) ; # 0..* Specialties handled by the HealthcareService
  fhir:location  ( [ Reference(Location) ] ... ) ; # 0..* Location(s) where service may be provided
  fhir:name [ string ] ; # 0..1 Description of service as presented to a consumer while searching
  fhir:comment [ markdown ] ; # 0..1 Additional description and/or any specific issues not covered elsewhere
  fhir:extraDetails [ markdown ] ; # 0..1 Extra details about the service that can't be placed in the other fields
  fhir:photo [ Attachment ] ; # 0..1 Facilitates quick identification of the service
  fhir:contact  ( [ ExtendedContactDetail ] ... ) ; # 0..* Official contact details for the HealthcareService
  fhir:coverageArea  ( [ Reference(Location) ] ... ) ; # 0..* Location(s) service is intended for/available to
  fhir:serviceProvisionCode  ( [ CodeableConcept ] ... ) ; # 0..* Conditions under which service is available/offered
  fhir:eligibility ( [ # 0..* Specific eligibility requirements required to use the service
    fhir:code [ CodeableConcept ] ; # 0..1 I Coded value for the eligibility
    # value[x] : 0..1 I Value associated with the eligibility code. One of these 5
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:Boolean ; boolean ]
      fhir:value [  a fhir:Quantity ; Quantity ]
      fhir:value [  a fhir:Range ; Range ]
      fhir:value [  a fhir:Reference ; Reference ]
    fhir:comment [ markdown ] ; # 0..1 Describes the eligibility conditions for the service
    fhir:period [ markdown ] ; # 0..1 The period this eligibility rule applies
  ] ... ) ;
  fhir:program  ( [ CodeableConcept ] ... ) ; # 0..* Programs that this service is applicable to
  fhir:characteristic  ( [ CodeableConcept ] ... ) ; # 0..* Collection of characteristics (attributes)
  fhir:communication  ( [ CodeableConcept ] ... ) ; # 0..* The language that this service is offered in
  fhir:referralMethod  ( [ CodeableConcept ] ... ) ; # 0..* Ways that the service accepts referrals
  fhir:referralRequired [ boolean ] ; # 0..1 A referral is required for access to this service
  fhir:appointmentRequired [ boolean ] ; # 0..1 An appointment is required for access to this service
  fhir:availability [ Availability ] ; # 0..1 Times the healthcare service is available (including exceptions)
  fhir:endpoint  ( [ Reference(Endpoint) ] ... ) ; # 0..* Technical endpoints providing access to electronic services operated for the healthcare service
]

Changes from both R4 and R4B </ StructureDefinition

HealthcareService >
HealthcareService.offeredIn
  • Added Element
HealthcareService.comment
  • Type changed from string to markdown
HealthcareService.contact
  • Added Element
HealthcareService.eligibility.value[x]
  • Added Element
HealthcareService.eligibility.period
  • Added Element
HealthcareService.communication
HealthcareService.referralRequired
  • Added Element
HealthcareService.availability
  • Added Element
HealthcareService.telecom
  • Deleted (-> HealthcareService.contact.telecom)
HealthcareService.availableTime
  • Deleted (-> HealthcareService.availability.availabileTime)
HealthcareService.notAvailable
  • Deleted (-> HealthcareService.availability.notAvailabileTime)
HealthcareService.availabilityExceptions
  • Deleted (-> HealthcareService.availability.notAvailabileTime.description)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

Usage note: every effort  

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

Path ValueSet Type Documentation
HealthcareService.category ServiceCategory Example

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

HealthcareService.type ServiceType Example

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

HealthcareService.specialty PracticeSettingCodeValueSet Example

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 made limited by HITSP to ensure the value set reproduced from HITSP C80 Table 2-149 Clinical Specialty Value Set Definition.

HealthcareService.serviceProvisionCode ServiceProvisionConditions Example

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

HealthcareService.eligibility.code Eligibility (a valid code from Eligibility Characteristics ) Example

Example set of HealthcareService eligibility codes

HealthcareService.program Program Example

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

HealthcareService.characteristic ServiceMode Example

An example set of Service Modes that could be applicable to use to characterize HealthcareServices or PractitionerRoles while searching

HealthcareService.communication AllLanguages (a valid code from Tags for the Identification of Languages icon ) Required

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

  Common Languages starter
HealthcareService.referralMethod ReferralMethod Example

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

8.8.4.2 Constraints

UniqueKey Level Location Description Expression
img  hcs-1 Rule HealthcareService.eligibility To use an eligibility value a code must also be provided to determine the type of eligibility the value applies to. value.exists() implies code.exists()

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.5.1 Single or Multiple Locations

When deciding to whether to use multiple locations on a single HealthcareService, or create multiple HealthcareService resources for each location on each you should consider:

  • are correct availability hours different? (hours of operation on location - and useful, but why they can be different) - e.g. some services are only available for restricted hours
  • are contact details different? (special contact number for service, not a normative part location based number)
  • are endpoint details different?
  • are there different characteristics at different locations? (e.g. wheelchair accessible)
  • are the coverageAreas the different?
  • how is all this data managed - and does it cause resources to need to be split/merged when things change (and what impact does that have downstream - i.e. replicated directories)

Any/all of these factors could require constraining the specification. use down to a single location on the resource and create separate HealthcareService resources covering the details of the referenced Location.

In a case where all this data is the same across all locations, then a single HealthcareService resource instance can be used with all the locations listed on it.

Note that if the contact/availability/endpoint details of the HealthcareService are the same as the Location, then these may be omitted from the HealthcareService and use the Location (thus reducing administrative burden)

8.8.6 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to 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
characteristic token One of the HealthcareService's characteristics HealthcareService.characteristic
communication token Languages that are available at this service HealthcareService.communication
coverage-area reference Location(s) service is intended for/available to HealthcareService.coverageArea
( Location )
eligibility token One of the HealthcareService's eligibility requirements HealthcareService.eligibility.code
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 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