Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3 R2

8.8 Resource HealthcareService - Content

Responsible Owner: Patient Administration icon Work Group Maturity Level : 2   Trial Use Security Category : Business Compartments : Not linked to any No defined compartments

The details of a healthcare service available at a location.

The HealthcareService resource is used to describe a single healthcare service or category of services that are provided by an organization at a location. 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 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 resources are: that may be offered at an organization/location include:

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

The HealthcareService resource can be used with the Schedule resource to define actual availability of the service. This would be done by using the Schedule's Actor property.

When creating an Appointment, the HealthcareService is to be assigned to one of the participants.
It is up to the scheduling system to determine if the service is available and can be accepted.

The HealthcareService resource is used with the following resources:

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

Structure

0..* Contacts related to markdown Describes Programs that this service is applicable to Program ( Example ) Collection of characteristics (attributes) The language that this service is offered in Common Languages ( Preferred but limited to AllLanguages ) CodeableConcept If an appointment is required 0..* Times the Service Site is available mon | tue | wed | thu | fri | sat | sun 0..1 0..1 1..1 Reason presented Service not available from
Name Flags Card. Type Description & Constraints      Filter: Filters 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
Binding: Service category Category ( Example )

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

. . . specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: Practice Setting Code Value Set ( Preferred 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 string 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
. . 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 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 )
. . . comment . value[x] C 0..1 Value associated with the eligibility conditions for the service code
. program . . . . valueCodeableConcept 0..* CodeableConcept
. characteristic . . . . valueBoolean 0..* CodeableConcept boolean
. communication . . . . valueQuantity 0..* CodeableConcept Quantity
. . . . referralMethod . valueRange Range 0..*
. . . . . valueReference Ways that the service accepts referrals ReferralMethod ( Example Reference ) ()
. . . . appointmentRequired comment 0..1 boolean markdown Describes the eligibility conditions for access to this the service
. . availableTime . . period 0..1 BackboneElement markdown The period this eligibility rule applies
. . daysOfWeek . program 0..* code CodeableConcept Programs that this service is applicable to
DaysOfWeek Binding: Program ( Required Example )

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

Always available? e.g. 24 hour service
. . availableStartTime . communication 0..* time CodeableConcept The language that this service is offered in
Binding: All Languages ( Required ) Opening time of day (ignored if allDay = true) availableEndTime 0..1
Additional Bindings Purpose
Common Languages Starter
time

Closing time of day (ignored if allDay = true)
. . notAvailable . referralMethod 0..* BackboneElement CodeableConcept Ways that the service accepts referrals
Binding: Referral Method ( Example )
Not available during this time due to provided reason
. . description . referralRequired 0..1 string boolean A referral is required for access to the user explaining why time not available this service
. . during . appointmentRequired 0..1 Period boolean An appointment is required for access to this date service
. . availabilityExceptions . availability 0..1 string Availability Times the healthcare service is available (including exceptions)
Description of availability 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..*] « A category of the service(s) that could be provided. null (Strength=Example) ServiceCategory ?? » The specific type of service that may be delivered or performed type : CodeableConcept [0..*] « Additional details about where the content was created (e.g. clinical specialty). null (Strength=Example) ServiceType ?? » Collection of specialties handled by the service site. Healthcare service. This is more of a medical term specialty : CodeableConcept [0..*] « A specialty that a healthcare service may provide. (Strength=Preferred) 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 : string 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] 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..*] « The code(s) that detail the conditions under which the healthcare service is available/offered. null (Strength=Example) ServiceProvisionConditions ?? » Programs that this service is applicable to program : CodeableConcept [0..*] « Government or local programs that this service applies to. 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..*] « A human language. (Strength=Preferred) null (Strength=Required) CommonLanguages ? AllLanguages ! » Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required referralMethod : CodeableConcept [0..*] « The methods of referral can be used when referring to a specific HealthCareService resource. null (Strength=Example) ReferralMethod ?? » Indicates whether or not a prospective consumer will require an appointment a referral for a particular service at a site to be provided by the Organization. Organization referralRequired : boolean [0..1] Indicates if whether or not a prospective consumer will require an appointment is required for access to this a particular service at a site to be provided by the Organization 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] Technical endpoints providing access to services operated for the specific healthcare services defined at this resource endpoint : Reference [0..*] « Endpoint » Eligibility Coded value for the eligibility code : CodeableConcept [0..1] « Describes the eligibility conditions for the service null (Strength=Example) comment : markdown Eligibility [0..1] ?? » « AvailableTime This element has or is affected by some invariants C » Indicates which days of the week are available between Sometimes an eligibility code requires additional data to calculate the start and end Times eligibility rules daysOfWeek value[x] : code DataType [0..*] [0..1] « The days of the week. (Strength=Required) DaysOfWeek ! » Is this always available? (hence times are irrelevant) e.g. 24 hour service allDay CodeableConcept : | boolean [0..1] | Quantity | Range | Reference » « The opening time of day. Note: If the AllDay flag is set, then this time This element has or is ignored affected by some invariants availableStartTime : time C [0..1] » The closing time of day. Note: If Describes the AllDay flag is set, then this time is ignored eligibility conditions for the service availableEndTime comment : time markdown [0..1] NotAvailable The reason period that can be presented to the user as to why this time is not available description : string [1..1] Service eligibility rule is not available (seasonally or for a public holiday) from requirement for this date service during period : Period markdown [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="[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>
 <</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>

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

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

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

  # 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 since R3 from both R4 and R4B

HealthcareService
HealthcareService.active HealthcareService.offeredIn
  • Default Value "true" removed Added Element
HealthcareService.category HealthcareService.comment
  • Max Cardinality Type changed from 1 string to * markdown
HealthcareService.extraDetails HealthcareService.contact
  • Type changed from string to markdown Added Element
HealthcareService.eligibility HealthcareService.eligibility.value[x]
  • Max Cardinality changed from 1 to * Type changed from CodeableConcept to BackboneElement Added Element
HealthcareService.eligibility.code HealthcareService.eligibility.period
  • Added Element
HealthcareService.eligibility.comment HealthcareService.communication
HealthcareService.program HealthcareService.referralRequired
  • Added Element
HealthcareService.communication HealthcareService.availability
  • Added Element
HealthcareService.availableTime.daysOfWeek HealthcareService.telecom
  • Change value set from http://hl7.org/fhir/ValueSet/days-of-week to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 Deleted (-> HealthcareService.contact.telecom)
HealthcareService.eligibilityNote HealthcareService.availableTime
  • deleted Deleted (-> HealthcareService.availability.availabileTime)
HealthcareService.programName HealthcareService.notAvailable
  • deleted 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 . 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). ) for R4B as XML or JSON .

Structure

0..* Contacts related to markdown Describes Programs that this service is applicable to Program ( Example ) Collection of characteristics (attributes) The language that this service is offered in Common Languages ( Preferred but limited to AllLanguages ) CodeableConcept If an appointment is required 0..* Times the Service Site is available mon | tue | wed | thu | fri | sat | sun 0..1 0..1 1..1 Reason presented Service not available from
Name Flags Card. Type Description & Constraints      Filter: Filters 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
Binding: Service category Category ( Example )

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

. . . specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: Practice Setting Code Value Set ( Preferred 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 string 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
. . 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 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 )
. . . comment . value[x] C 0..1 Value associated with the eligibility conditions for the service code
. program . . . . valueCodeableConcept 0..* CodeableConcept
. characteristic . . . . valueBoolean 0..* CodeableConcept boolean
. communication . . . . valueQuantity 0..* CodeableConcept Quantity
. . . . referralMethod . valueRange Range 0..*
. . . . . valueReference Ways that the service accepts referrals ReferralMethod ( Example Reference ) ()
. . . . appointmentRequired comment 0..1 boolean markdown Describes the eligibility conditions for access to this the service
. . availableTime . . period 0..1 BackboneElement markdown The period this eligibility rule applies
. . daysOfWeek . program 0..* code CodeableConcept Programs that this service is applicable to
DaysOfWeek Binding: Program ( Required Example )

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

Always available? e.g. 24 hour service
. . availableStartTime . communication 0..* time CodeableConcept The language that this service is offered in
Binding: All Languages ( Required ) Opening time of day (ignored if allDay = true) availableEndTime 0..1
Additional Bindings Purpose
Common Languages Starter
time

Closing time of day (ignored if allDay = true)
. . notAvailable . referralMethod 0..* BackboneElement CodeableConcept Ways that the service accepts referrals
Binding: Referral Method ( Example )
Not available during this time due to provided reason
. . description . referralRequired 0..1 string boolean A referral is required for access to the user explaining why time not available this service
. . during . appointmentRequired 0..1 Period boolean An appointment is required for access to this date service
. . availabilityExceptions . availability 0..1 string Availability Times the healthcare service is available (including exceptions)
Description of availability 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..*] « A category of the service(s) that could be provided. null (Strength=Example) ServiceCategory ?? » The specific type of service that may be delivered or performed type : CodeableConcept [0..*] « Additional details about where the content was created (e.g. clinical specialty). null (Strength=Example) ServiceType ?? » Collection of specialties handled by the service site. Healthcare service. This is more of a medical term specialty : CodeableConcept [0..*] « A specialty that a healthcare service may provide. (Strength=Preferred) 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 : string 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] 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..*] « The code(s) that detail the conditions under which the healthcare service is available/offered. null (Strength=Example) ServiceProvisionConditions ?? » Programs that this service is applicable to program : CodeableConcept [0..*] « Government or local programs that this service applies to. 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..*] « A human language. (Strength=Preferred) null (Strength=Required) CommonLanguages ? AllLanguages ! » Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required referralMethod : CodeableConcept [0..*] « The methods of referral can be used when referring to a specific HealthCareService resource. null (Strength=Example) ReferralMethod ?? » Indicates whether or not a prospective consumer will require an appointment a referral for a particular service at a site to be provided by the Organization. Organization referralRequired : boolean [0..1] Indicates if whether or not a prospective consumer will require an appointment is required for access to this a particular service at a site to be provided by the Organization 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] Technical endpoints providing access to services operated for the specific healthcare services defined at this resource endpoint : Reference [0..*] « Endpoint » Eligibility Coded value for the eligibility code : CodeableConcept [0..1] « Describes the eligibility conditions for the service null (Strength=Example) comment : markdown Eligibility [0..1] ?? » « AvailableTime This element has or is affected by some invariants C » Indicates which days of the week are available between Sometimes an eligibility code requires additional data to calculate the start and end Times eligibility rules daysOfWeek value[x] : code DataType [0..*] [0..1] « The days of the week. (Strength=Required) DaysOfWeek ! » Is this always available? (hence times are irrelevant) e.g. 24 hour service allDay CodeableConcept : | boolean [0..1] | Quantity | Range | Reference » « The opening time of day. Note: If the AllDay flag is set, then this time This element has or is ignored affected by some invariants availableStartTime : time C [0..1] » The closing time of day. Note: If Describes the AllDay flag is set, then this time is ignored eligibility conditions for the service availableEndTime comment : time markdown [0..1] NotAvailable The reason period that can be presented to the user as to why this time is not available description : string [1..1] Service eligibility rule is not available (seasonally or for a public holiday) from requirement for this date service during period : Period markdown [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="[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>
 <</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>

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

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

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

  # 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 since Release 3 from both R4 and R4B

HealthcareService
HealthcareService.active HealthcareService.offeredIn
  • Default Value "true" removed Added Element
HealthcareService.category HealthcareService.comment
  • Max Cardinality Type changed from 1 string to * markdown
HealthcareService.extraDetails HealthcareService.contact
  • Type changed from string to markdown Added Element
HealthcareService.eligibility HealthcareService.eligibility.value[x]
  • Max Cardinality changed from 1 to * Type changed from CodeableConcept to BackboneElement Added Element
HealthcareService.eligibility.code HealthcareService.eligibility.period
  • Added Element
HealthcareService.eligibility.comment HealthcareService.communication
HealthcareService.program HealthcareService.referralRequired
  • Added Element
HealthcareService.communication HealthcareService.availability
  • Added Element
HealthcareService.availableTime.daysOfWeek HealthcareService.telecom
  • Change value set from http://hl7.org/fhir/ValueSet/days-of-week to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 Deleted (-> HealthcareService.contact.telecom)
HealthcareService.eligibilityNote HealthcareService.availableTime
  • deleted Deleted (-> HealthcareService.availability.availabileTime)
HealthcareService.programName HealthcareService.notAvailable
  • deleted 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 . 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). ) for R4B as XML or JSON .

 

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

HealthcareService.eligibility.code HealthcareService.program HealthcareService.characteristic HealthcareService.communication
Path Definition ValueSet Type Reference Documentation
HealthcareService.category A category of the service(s) that could be provided. ServiceCategory Example ServiceCategory

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

HealthcareService.type Additional details about where the content was created (e.g. clinical specialty). ServiceType Example ServiceType

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

HealthcareService.specialty A specialty that a healthcare service may provide. PracticeSettingCodeValueSet Preferred Example PracticeSettingCodeValueSet

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.

HealthcareService.serviceProvisionCode ServiceProvisionConditions Example

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

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

Example set of HealthcareService eligibility codes

HealthcareService.program Coded values underwhich a specific service is made available. Unknown Program Example No details provided yet

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

HealthcareService.characteristic Government or local programs that this service applies to. ServiceMode Example Program

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

HealthcareService.communication A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). AllLanguages (a valid code from Tags for the Identification of Languages icon ) Required Unknown No details provided yet

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

  A human language. Common Languages Preferred , but limited to AllLanguages starter CommonLanguages
HealthcareService.referralMethod ReferralMethod Example

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

HealthcareService.availableTime.daysOfWeek
UniqueKey ReferralMethod Level Location Description Expression
img  hcs-1 The days of the week. Required 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() DaysOfWeek

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

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 availability hours different? (hours of operation on location - and 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 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 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)

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