R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

8.8 Resource HealthcareService - Content

Patient Administration icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

The details of a healthcare service available at a location.

The HealthcareService resource is used to describe a single healthcare service or category of services that are provided by an organization at a location.
The location of the services could be virtual, as with telemedicine services.

Common examples of HealthcareServices resources are:

  • Allied Health
  • Clinical Neuropsychologist
  • Podiatry Service
  • Smallville Hospital Emergency Services
  • Respite care provided at a nursing home or hostel
  • 24hr crisis telephone counseling service
  • Information, advice and/or referral services; Disability, Telecommunications
  • Rural TeleHealth Services
  • Hospital in the home
  • Yellow Cabs
  • Pharmacy
  • Active Rehab
  • Social Support
  • Drug and/or alcohol counseling
  • Day Programs, Adult Training & Support Services
  • Consulting psychologists and/or psychology services
  • Group Hydrotherapy
  • Little River Home Maintenance
  • CT Head Scan w/o Contrast
  • CT Head Scan with Contrast
  • CT Head+Chest Scan with Contrast

HealthcareService resources do not represent Computer related Services (not SOA)

Example uses of HealthcareService resources are:

  • National Services Directory - Consumer Focus
  • National Services Directory - Practitioner Referrals Searching
  • Organization's Client Portal - to locate services / book appointments
  • Address book of services for Referrals
    including references to Questionnaires for assessments that are required as part of the referral
  • Health Network internal directory Used for tracking available services offered internally, and also those offered by business partners.
    This information may also include costing information.
  • Catalog of schedulable services or activities

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.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService TUDomainResourceThe details of a healthcare service available at a location

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierExternal identifiers for this item

... active ?!Σ0..1booleanWhether this HealthcareService record is in active use
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... category Σ0..*CodeableConceptBroad category of service being performed or delivered
Binding: Service Category (Example)

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

... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Practice Setting Code Value Set (Preferred)

... location Σ0..*Reference(Location)Location(s) where service may be provided

... name Σ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1markdownAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... contact 0..*ExtendedContactDetailOfficial contact details for the HealthcareService

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

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

... eligibility 0..*BackboneElementSpecific eligibility requirements required to use the service

.... code 0..1CodeableConceptCoded value for the eligibility
Binding: ServiceEligibility (Example)
.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (Example)

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

... communication 0..*CodeableConceptThe language that this service is offered in
Binding: All Languages (Required)
Additional BindingsPurpose
Common LanguagesStarter Set


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

... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availability 0..*AvailabilityTimes 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 itemidentifier : 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 serviceprovidedBy : Reference [0..1] « Organization »When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic serviceofferedIn : Reference [0..*] « HealthcareService »Identifies the broad category of service being performed or deliveredcategory : CodeableConcept [0..*] « null (Strength=Example)ServiceCategory?? »The specific type of service that may be delivered or performedtype : CodeableConcept [0..*] « null (Strength=Example)ServiceType?? »Collection of specialties handled by the Healthcare service. This is more of a medical termspecialty : CodeableConcept [0..*] « null (Strength=Preferred)PracticeSettingCodeValueSet? »The location(s) where this healthcare service may be providedlocation : Reference [0..*] « Location »Further description of the service as it would be presented to a consumer while searchingname : 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 serviceNamecomment : markdown [0..1]Extra details about the service that can't be placed in the other fieldsextraDetails : 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 listphoto : 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 sitescontact : 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/offeredserviceProvisionCode : CodeableConcept [0..*] « null (Strength=Example) ServiceProvisionConditions?? »Programs that this service is applicable toprogram : 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 usedcommunication : 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 requiredreferralMethod : CodeableConcept [0..*] « null (Strength=Example)ReferralMethod?? »Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this serviceappointmentRequired : boolean [0..1]A collection of times that the healthcare service is availableavailability : Availability [0..*]Technical endpoints providing access to services operated for the specific healthcare services defined at this resourceendpoint : Reference [0..*] « Endpoint »EligibilityCoded value for the eligibilitycode : CodeableConcept [0..1] « null (Strength=Example)ServiceEligibility?? »Describes the eligibility conditions for the servicecomment : 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><!-- 0..1 CodeableConcept Coded value for the eligibility --></code>
  <comment value="[markdown]"/><!-- 0..1 Describes the eligibility conditions for the service -->
 </eligibility>
 <program><!-- 0..* CodeableConcept Programs that this service is applicable to --></program>
 <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic>
 <communication><!-- 0..* CodeableConcept The language that this service is offered in --></communication>
 <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod>
 <appointmentRequired value="[boolean]"/><!-- 0..1 If an appointment is required for access to this service -->
 <availability><!-- 0..* Availability Times the healthcare service is available (including exceptions) --></availability>
 <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service --></endpoint>
</HealthcareService>

JSON Template

{doco
  "resourceType" : "HealthcareService",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External identifiers for this item
  "active" : <boolean>, // Whether this HealthcareService record is in active use
  "providedBy" : { Reference(Organization) }, // Organization that provides this service
  "offeredIn" : [{ Reference(HealthcareService) }], // The service within which this service is offered
  "category" : [{ CodeableConcept }], // Broad category of service being performed or delivered
  "type" : [{ CodeableConcept }], // Type of service that may be delivered or performed
  "specialty" : [{ CodeableConcept }], // Specialties handled by the HealthcareService
  "location" : [{ Reference(Location) }], // Location(s) where service may be provided
  "name" : "<string>", // Description of service as presented to a consumer while searching
  "comment" : "<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 }, // Coded value for the eligibility
    "comment" : "<markdown>" // Describes the eligibility conditions for the service
  }],
  "program" : [{ CodeableConcept }], // Programs that this service is applicable to
  "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
  "communication" : [{ CodeableConcept }], // The language that this service is offered in
  "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
  "appointmentRequired" : <boolean>, // If an appointment is required for access to this service
  "availability" : [{ Availability }], // Times the healthcare service is available (including exceptions)
  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to electronic services operated for the healthcare service
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir: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 Coded value for the eligibility
    fhir:comment [ markdown ] ; # 0..1 Describes the eligibility conditions for the service
  ] ... ) ;
  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:appointmentRequired [ boolean ] ; # 0..1 If an appointment is required for access to this service
  fhir:availability  ( [ Availability ] ... ) ; # 0..* 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 R4

HealthcareService
HealthcareService.offeredIn
  • Added Element
HealthcareService.comment
  • Type changed from string to markdown
HealthcareService.contact
  • Added Element
HealthcareService.communication
  • Change binding strength from preferred to required
  • Change value set from http://hl7.org/fhir/ValueSet/languages to http://hl7.org/fhir/ValueSet/all-languages|5.0.0-draft-final
  • Change max value set from http://hl7.org/fhir/ValueSet/all-languages to n/a
HealthcareService.availability
  • Added Element
HealthcareService.telecom
  • deleted
HealthcareService.availableTime
  • deleted
HealthcareService.notAvailable
  • deleted
HealthcareService.availabilityExceptions
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

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

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService TUDomainResourceThe details of a healthcare service available at a location

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierExternal identifiers for this item

... active ?!Σ0..1booleanWhether this HealthcareService record is in active use
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... category Σ0..*CodeableConceptBroad category of service being performed or delivered
Binding: Service Category (Example)

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

... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Binding: Practice Setting Code Value Set (Preferred)

... location Σ0..*Reference(Location)Location(s) where service may be provided

... name Σ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1markdownAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... contact 0..*ExtendedContactDetailOfficial contact details for the HealthcareService

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

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

... eligibility 0..*BackboneElementSpecific eligibility requirements required to use the service

.... code 0..1CodeableConceptCoded value for the eligibility
Binding: ServiceEligibility (Example)
.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (Example)

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

... communication 0..*CodeableConceptThe language that this service is offered in
Binding: All Languages (Required)
Additional BindingsPurpose
Common LanguagesStarter Set


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

... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availability 0..*AvailabilityTimes 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 itemidentifier : 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 serviceprovidedBy : Reference [0..1] « Organization »When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic serviceofferedIn : Reference [0..*] « HealthcareService »Identifies the broad category of service being performed or deliveredcategory : CodeableConcept [0..*] « null (Strength=Example)ServiceCategory?? »The specific type of service that may be delivered or performedtype : CodeableConcept [0..*] « null (Strength=Example)ServiceType?? »Collection of specialties handled by the Healthcare service. This is more of a medical termspecialty : CodeableConcept [0..*] « null (Strength=Preferred)PracticeSettingCodeValueSet? »The location(s) where this healthcare service may be providedlocation : Reference [0..*] « Location »Further description of the service as it would be presented to a consumer while searchingname : 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 serviceNamecomment : markdown [0..1]Extra details about the service that can't be placed in the other fieldsextraDetails : 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 listphoto : 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 sitescontact : 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/offeredserviceProvisionCode : CodeableConcept [0..*] « null (Strength=Example) ServiceProvisionConditions?? »Programs that this service is applicable toprogram : 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 usedcommunication : 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 requiredreferralMethod : CodeableConcept [0..*] « null (Strength=Example)ReferralMethod?? »Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this serviceappointmentRequired : boolean [0..1]A collection of times that the healthcare service is availableavailability : Availability [0..*]Technical endpoints providing access to services operated for the specific healthcare services defined at this resourceendpoint : Reference [0..*] « Endpoint »EligibilityCoded value for the eligibilitycode : CodeableConcept [0..1] « null (Strength=Example)ServiceEligibility?? »Describes the eligibility conditions for the servicecomment : 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><!-- 0..1 CodeableConcept Coded value for the eligibility --></code>
  <comment value="[markdown]"/><!-- 0..1 Describes the eligibility conditions for the service -->
 </eligibility>
 <program><!-- 0..* CodeableConcept Programs that this service is applicable to --></program>
 <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic>
 <communication><!-- 0..* CodeableConcept The language that this service is offered in --></communication>
 <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod>
 <appointmentRequired value="[boolean]"/><!-- 0..1 If an appointment is required for access to this service -->
 <availability><!-- 0..* Availability Times the healthcare service is available (including exceptions) --></availability>
 <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service --></endpoint>
</HealthcareService>

JSON Template

{doco
  "resourceType" : "HealthcareService",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External identifiers for this item
  "active" : <boolean>, // Whether this HealthcareService record is in active use
  "providedBy" : { Reference(Organization) }, // Organization that provides this service
  "offeredIn" : [{ Reference(HealthcareService) }], // The service within which this service is offered
  "category" : [{ CodeableConcept }], // Broad category of service being performed or delivered
  "type" : [{ CodeableConcept }], // Type of service that may be delivered or performed
  "specialty" : [{ CodeableConcept }], // Specialties handled by the HealthcareService
  "location" : [{ Reference(Location) }], // Location(s) where service may be provided
  "name" : "<string>", // Description of service as presented to a consumer while searching
  "comment" : "<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 }, // Coded value for the eligibility
    "comment" : "<markdown>" // Describes the eligibility conditions for the service
  }],
  "program" : [{ CodeableConcept }], // Programs that this service is applicable to
  "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
  "communication" : [{ CodeableConcept }], // The language that this service is offered in
  "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
  "appointmentRequired" : <boolean>, // If an appointment is required for access to this service
  "availability" : [{ Availability }], // Times the healthcare service is available (including exceptions)
  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to electronic services operated for the healthcare service
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir: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 Coded value for the eligibility
    fhir:comment [ markdown ] ; # 0..1 Describes the eligibility conditions for the service
  ] ... ) ;
  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:appointmentRequired [ boolean ] ; # 0..1 If an appointment is required for access to this service
  fhir:availability  ( [ Availability ] ... ) ; # 0..* 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 4

HealthcareService
HealthcareService.offeredIn
  • Added Element
HealthcareService.comment
  • Type changed from string to markdown
HealthcareService.contact
  • Added Element
HealthcareService.communication
  • Change binding strength from preferred to required
  • Change value set from http://hl7.org/fhir/ValueSet/languages to http://hl7.org/fhir/ValueSet/all-languages|5.0.0-draft-final
  • Change max value set from http://hl7.org/fhir/ValueSet/all-languages to n/a
HealthcareService.availability
  • Added Element
HealthcareService.telecom
  • deleted
HealthcareService.availableTime
  • deleted
HealthcareService.notAvailable
  • deleted
HealthcareService.availabilityExceptions
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

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

 

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

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

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 ??Example
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.

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

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.

NameTypeDescriptionExpressionIn Common
activetokenThe Healthcare Service is currently marked as activeHealthcareService.active
characteristictokenOne of the HealthcareService's characteristicsHealthcareService.characteristic
communicationtokenLanguages that are available at this serviceHealthcareService.communication
coverage-areareferenceLocation(s) service is intended for/available toHealthcareService.coverageArea
(Location)
eligibilitytokenOne of the HealthcareService's eligibility requirementsHealthcareService.eligibility.code
endpointreferenceTechnical endpoints providing access to electronic services operated for the healthcare serviceHealthcareService.endpoint
(Endpoint)
identifiertokenExternal identifiers for this itemHealthcareService.identifier
locationreferenceThe location of the Healthcare ServiceHealthcareService.location
(Location)
namestringA portion of the Healthcare service nameHealthcareService.name
offered-inreferenceThe service within which this service is offeredHealthcareService.offeredIn
(HealthcareService)
organizationreferenceThe organization that provides this Healthcare ServiceHealthcareService.providedBy
(Organization)
programtokenOne of the Programs supported by this HealthcareServiceHealthcareService.program
service-categorytokenService Category of the Healthcare ServiceHealthcareService.category
service-typetokenThe type of service provided by this healthcare serviceHealthcareService.type
specialtytokenThe specialty of the service provided by this healthcare serviceHealthcareService.specialty