STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). 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

5.7 Resource HealthcareService - Content

Patient Administration Work GroupMaturity Level: 1Compartments: Not linked to any defined compartments

The details of a healthcare service available at a location.

5.7.1 Scope and Usage

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

Common examples of HealthcareServices resources are:

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

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.

5.7.2 Boundaries and Relationships

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

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

This resource is referenced by Account, Appointment, AppointmentResponse, Practitioner, PractitionerRole and Schedule

5.7.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService DomainResourceThe details of a healthcare service available at a location
... identifier Σ0..*IdentifierExternal identifiers for this item
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... serviceCategory Σ0..1CodeableConceptBroad category of service being performed or delivered
ServiceCategory (Example)
... serviceType Σ0..*CodeableConceptType of service that may be delivered or performed
ServiceType (Example)
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Practice Setting Code Value Set (Preferred)
... location Σ0..*Reference(Location)Location(s) where service may be provided
... serviceName Σ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1stringExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom 0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(Location)Location(s) service is inteded for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
ServiceProvisionConditions (Example)
... eligibility 0..1CodeableConceptSpecific eligibility requirements required to use the service
... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... programName 0..*stringProgram Names that categorize the service
... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
ReferralMethod (Example)
... publicKey 0..1stringPKI Public keys to support secure communications
... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
DaysOfWeek (Required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions

doco Documentation for this format

UML Diagram

HealthcareService (DomainResource)External identifiers for this itemidentifier : Identifier [0..*]The organization that provides this healthcare serviceprovidedBy : Reference [0..1] « Organization »Identifies the broad category of service being performed or deliveredserviceCategory : CodeableConcept [0..1] « A category of the service(s) that could be provided. (Strength=Example)ServiceCategory?? »The specific type of service that may be delivered or performedserviceType : CodeableConcept [0..*] « Additional details about where the content was created (e.g. clinical specialty). (Strength=Example)ServiceType?? »Collection of specialties handled by the service site. This is more of a medical termspecialty : CodeableConcept [0..*] « A specialty that a healthcare service may provide. (Strength=Preferred)Practice Setting Code Value S...? »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 searchingserviceName : 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 : string [0..1]Extra details about the service that can't be placed in the other fieldsextraDetails : string [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]List of contacts related to this specific healthcare servicetelecom : ContactPoint [0..*]The location(s) that this service is available to (not where the service is provided)coverageArea : Reference [0..*] « Location »The code(s) that detail the conditions under which the healthcare service is available/offeredserviceProvisionCode : CodeableConcept [0..*] « The code(s) that detail the conditions under which the healthcare service is available/offered. (Strength=Example) ServiceProvisionConditions?? »Does this service have specific eligibility requirements that need to be met in order to use the service?eligibility : CodeableConcept [0..1]Describes the eligibility conditions for the serviceeligibilityNote : string [0..1]Program Names that can be used to categorize the serviceprogramName : string [0..*]Collection of characteristics (attributes)characteristic : CodeableConcept [0..*]Ways that the service accepts referrals, if this is not provided then it is implied that no referral is requiredreferralMethod : CodeableConcept [0..*] « The methods of referral can be used when referring to a specific HealthCareService resource. (Strength=Example)ReferralMethod?? »The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where availablepublicKey : string [0..1]Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this serviceappointmentRequired : boolean [0..1]A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available TimesavailabilityExceptions : string [0..1]AvailableTimeIndicates which days of the week are available between the start and end TimesdaysOfWeek : code [0..*] « The days of the week. (Strength=Required)DaysOfWeek! »Is this always available? (hence times are irrelevant) e.g. 24 hour serviceallDay : boolean [0..1]The opening time of day. Note: If the AllDay flag is set, then this time is ignoredavailableStartTime : time [0..1]The closing time of day. Note: If the AllDay flag is set, then this time is ignoredavailableEndTime : time [0..1]NotAvailableThe reason that can be presented to the user as to why this time is not availabledescription : string [1..1]Service is not available (seasonally or for a public holiday) from this dateduring : Period [0..1]A collection of times that the Service Site is availableavailableTime[0..*]The HealthcareService is not available during this period of time due to the provided reasonnotAvailable[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>
 <providedBy><!-- 0..1 Reference(Organization) Organization that provides this service --></providedBy>
 <serviceCategory><!-- 0..1 CodeableConcept Broad category of service being performed or delivered --></serviceCategory>
 <serviceType><!-- 0..* CodeableConcept Type of service that may be delivered or performed --></serviceType>
 <specialty><!-- 0..* CodeableConcept Specialties handled by the HealthcareService --></specialty>
 <location><!-- 0..* Reference(Location) Location(s) where service may be provided --></location>
 <serviceName value="[string]"/><!-- 0..1 Description of service as presented to a consumer while searching -->
 <comment value="[string]"/><!-- 0..1 Additional description and/or any specific issues not covered elsewhere -->
 <extraDetails value="[string]"/><!-- 0..1 Extra details about the service that can't be placed in the other fields -->
 <photo><!-- 0..1 Attachment Facilitates quick identification of the service --></photo>
 <telecom><!-- 0..* ContactPoint Contacts related to the healthcare service --></telecom>
 <coverageArea><!-- 0..* Reference(Location) Location(s) service is inteded for/available to --></coverageArea>
 <serviceProvisionCode><!-- 0..* CodeableConcept Conditions under which service is available/offered --></serviceProvisionCode>
 <eligibility><!-- 0..1 CodeableConcept Specific eligibility requirements required to use the service --></eligibility>
 <eligibilityNote value="[string]"/><!-- 0..1 Describes the eligibility conditions for the service -->
 <programName value="[string]"/><!-- 0..* Program Names that categorize the service -->
 <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic>
 <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod>
 <publicKey value="[string]"/><!-- 0..1 PKI Public keys to support secure communications -->
 <appointmentRequired value="[boolean]"/><!-- 0..1 If an appointment is required for access to this service -->
 <availableTime>  <!-- 0..* Times the Service Site is available -->
  <daysOfWeek value="[code]"/><!-- 0..* mon | tue | wed | thu | fri | sat | sun -->
  <allDay value="[boolean]"/><!-- 0..1 Always available? e.g. 24 hour service -->
  <availableStartTime value="[time]"/><!-- 0..1 Opening time of day (ignored if allDay = true) -->
  <availableEndTime value="[time]"/><!-- 0..1 Closing time of day (ignored if allDay = true) -->
 </availableTime>
 <notAvailable>  <!-- 0..* Not available during this time due to provided reason -->
  <description value="[string]"/><!-- 1..1 Reason presented to the user explaining why time not available -->
  <during><!-- 0..1 Period Service not availablefrom this date --></during>
 </notAvailable>
 <availabilityExceptions value="[string]"/><!-- 0..1 Description of availability exceptions -->
</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
  "providedBy" : { Reference(Organization) }, // Organization that provides this service
  "serviceCategory" : { CodeableConcept }, // Broad category of service being performed or delivered
  "serviceType" : [{ 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
  "serviceName" : "<string>", // Description of service as presented to a consumer while searching
  "comment" : "<string>", // Additional description and/or any specific issues not covered elsewhere
  "extraDetails" : "<string>", // Extra details about the service that can't be placed in the other fields
  "photo" : { Attachment }, // Facilitates quick identification of the service
  "telecom" : [{ ContactPoint }], // Contacts related to the healthcare service
  "coverageArea" : [{ Reference(Location) }], // Location(s) service is inteded for/available to
  "serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered
  "eligibility" : { CodeableConcept }, // Specific eligibility requirements required to use the service
  "eligibilityNote" : "<string>", // Describes the eligibility conditions for the service
  "programName" : ["<string>"], // Program Names that categorize the service
  "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
  "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
  "publicKey" : "<string>", // PKI Public keys to support secure communications
  "appointmentRequired" : <boolean>, // If an appointment is required for access to this service
  "availableTime" : [{ // Times the Service Site is available
    "daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
    "allDay" : <boolean>, // Always available? e.g. 24 hour service
    "availableStartTime" : "<time>", // Opening time of day (ignored if allDay = true)
    "availableEndTime" : "<time>" // Closing time of day (ignored if allDay = true)
  }],
  "notAvailable" : [{ // Not available during this time due to provided reason
    "description" : "<string>", // R!  Reason presented to the user explaining why time not available
    "during" : { Period } // Service not availablefrom this date
  }],
  "availabilityExceptions" : "<string>" // Description of availability exceptions
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService DomainResourceThe details of a healthcare service available at a location
... identifier Σ0..*IdentifierExternal identifiers for this item
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... serviceCategory Σ0..1CodeableConceptBroad category of service being performed or delivered
ServiceCategory (Example)
... serviceType Σ0..*CodeableConceptType of service that may be delivered or performed
ServiceType (Example)
... specialty Σ0..*CodeableConceptSpecialties handled by the HealthcareService
Practice Setting Code Value Set (Preferred)
... location Σ0..*Reference(Location)Location(s) where service may be provided
... serviceName Σ0..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1stringExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... telecom 0..*ContactPointContacts related to the healthcare service
... coverageArea 0..*Reference(Location)Location(s) service is inteded for/available to
... serviceProvisionCode 0..*CodeableConceptConditions under which service is available/offered
ServiceProvisionConditions (Example)
... eligibility 0..1CodeableConceptSpecific eligibility requirements required to use the service
... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... programName 0..*stringProgram Names that categorize the service
... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
ReferralMethod (Example)
... publicKey 0..1stringPKI Public keys to support secure communications
... appointmentRequired 0..1booleanIf an appointment is required for access to this service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
DaysOfWeek (Required)
.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not availablefrom this date
... availabilityExceptions 0..1stringDescription of availability exceptions

doco Documentation for this format

UML Diagram

HealthcareService (DomainResource)External identifiers for this itemidentifier : Identifier [0..*]The organization that provides this healthcare serviceprovidedBy : Reference [0..1] « Organization »Identifies the broad category of service being performed or deliveredserviceCategory : CodeableConcept [0..1] « A category of the service(s) that could be provided. (Strength=Example)ServiceCategory?? »The specific type of service that may be delivered or performedserviceType : CodeableConcept [0..*] « Additional details about where the content was created (e.g. clinical specialty). (Strength=Example)ServiceType?? »Collection of specialties handled by the service site. This is more of a medical termspecialty : CodeableConcept [0..*] « A specialty that a healthcare service may provide. (Strength=Preferred)Practice Setting Code Value S...? »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 searchingserviceName : 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 : string [0..1]Extra details about the service that can't be placed in the other fieldsextraDetails : string [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]List of contacts related to this specific healthcare servicetelecom : ContactPoint [0..*]The location(s) that this service is available to (not where the service is provided)coverageArea : Reference [0..*] « Location »The code(s) that detail the conditions under which the healthcare service is available/offeredserviceProvisionCode : CodeableConcept [0..*] « The code(s) that detail the conditions under which the healthcare service is available/offered. (Strength=Example) ServiceProvisionConditions?? »Does this service have specific eligibility requirements that need to be met in order to use the service?eligibility : CodeableConcept [0..1]Describes the eligibility conditions for the serviceeligibilityNote : string [0..1]Program Names that can be used to categorize the serviceprogramName : string [0..*]Collection of characteristics (attributes)characteristic : CodeableConcept [0..*]Ways that the service accepts referrals, if this is not provided then it is implied that no referral is requiredreferralMethod : CodeableConcept [0..*] « The methods of referral can be used when referring to a specific HealthCareService resource. (Strength=Example)ReferralMethod?? »The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where availablepublicKey : string [0..1]Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this serviceappointmentRequired : boolean [0..1]A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available TimesavailabilityExceptions : string [0..1]AvailableTimeIndicates which days of the week are available between the start and end TimesdaysOfWeek : code [0..*] « The days of the week. (Strength=Required)DaysOfWeek! »Is this always available? (hence times are irrelevant) e.g. 24 hour serviceallDay : boolean [0..1]The opening time of day. Note: If the AllDay flag is set, then this time is ignoredavailableStartTime : time [0..1]The closing time of day. Note: If the AllDay flag is set, then this time is ignoredavailableEndTime : time [0..1]NotAvailableThe reason that can be presented to the user as to why this time is not availabledescription : string [1..1]Service is not available (seasonally or for a public holiday) from this dateduring : Period [0..1]A collection of times that the Service Site is availableavailableTime[0..*]The HealthcareService is not available during this period of time due to the provided reasonnotAvailable[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>
 <providedBy><!-- 0..1 Reference(Organization) Organization that provides this service --></providedBy>
 <serviceCategory><!-- 0..1 CodeableConcept Broad category of service being performed or delivered --></serviceCategory>
 <serviceType><!-- 0..* CodeableConcept Type of service that may be delivered or performed --></serviceType>
 <specialty><!-- 0..* CodeableConcept Specialties handled by the HealthcareService --></specialty>
 <location><!-- 0..* Reference(Location) Location(s) where service may be provided --></location>
 <serviceName value="[string]"/><!-- 0..1 Description of service as presented to a consumer while searching -->
 <comment value="[string]"/><!-- 0..1 Additional description and/or any specific issues not covered elsewhere -->
 <extraDetails value="[string]"/><!-- 0..1 Extra details about the service that can't be placed in the other fields -->
 <photo><!-- 0..1 Attachment Facilitates quick identification of the service --></photo>
 <telecom><!-- 0..* ContactPoint Contacts related to the healthcare service --></telecom>
 <coverageArea><!-- 0..* Reference(Location) Location(s) service is inteded for/available to --></coverageArea>
 <serviceProvisionCode><!-- 0..* CodeableConcept Conditions under which service is available/offered --></serviceProvisionCode>
 <eligibility><!-- 0..1 CodeableConcept Specific eligibility requirements required to use the service --></eligibility>
 <eligibilityNote value="[string]"/><!-- 0..1 Describes the eligibility conditions for the service -->
 <programName value="[string]"/><!-- 0..* Program Names that categorize the service -->
 <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic>
 <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod>
 <publicKey value="[string]"/><!-- 0..1 PKI Public keys to support secure communications -->
 <appointmentRequired value="[boolean]"/><!-- 0..1 If an appointment is required for access to this service -->
 <availableTime>  <!-- 0..* Times the Service Site is available -->
  <daysOfWeek value="[code]"/><!-- 0..* mon | tue | wed | thu | fri | sat | sun -->
  <allDay value="[boolean]"/><!-- 0..1 Always available? e.g. 24 hour service -->
  <availableStartTime value="[time]"/><!-- 0..1 Opening time of day (ignored if allDay = true) -->
  <availableEndTime value="[time]"/><!-- 0..1 Closing time of day (ignored if allDay = true) -->
 </availableTime>
 <notAvailable>  <!-- 0..* Not available during this time due to provided reason -->
  <description value="[string]"/><!-- 1..1 Reason presented to the user explaining why time not available -->
  <during><!-- 0..1 Period Service not availablefrom this date --></during>
 </notAvailable>
 <availabilityExceptions value="[string]"/><!-- 0..1 Description of availability exceptions -->
</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
  "providedBy" : { Reference(Organization) }, // Organization that provides this service
  "serviceCategory" : { CodeableConcept }, // Broad category of service being performed or delivered
  "serviceType" : [{ 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
  "serviceName" : "<string>", // Description of service as presented to a consumer while searching
  "comment" : "<string>", // Additional description and/or any specific issues not covered elsewhere
  "extraDetails" : "<string>", // Extra details about the service that can't be placed in the other fields
  "photo" : { Attachment }, // Facilitates quick identification of the service
  "telecom" : [{ ContactPoint }], // Contacts related to the healthcare service
  "coverageArea" : [{ Reference(Location) }], // Location(s) service is inteded for/available to
  "serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered
  "eligibility" : { CodeableConcept }, // Specific eligibility requirements required to use the service
  "eligibilityNote" : "<string>", // Describes the eligibility conditions for the service
  "programName" : ["<string>"], // Program Names that categorize the service
  "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
  "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
  "publicKey" : "<string>", // PKI Public keys to support secure communications
  "appointmentRequired" : <boolean>, // If an appointment is required for access to this service
  "availableTime" : [{ // Times the Service Site is available
    "daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
    "allDay" : <boolean>, // Always available? e.g. 24 hour service
    "availableStartTime" : "<time>", // Opening time of day (ignored if allDay = true)
    "availableEndTime" : "<time>" // Closing time of day (ignored if allDay = true)
  }],
  "notAvailable" : [{ // Not available during this time due to provided reason
    "description" : "<string>", // R!  Reason presented to the user explaining why time not available
    "during" : { Period } // Service not availablefrom this date
  }],
  "availabilityExceptions" : "<string>" // Description of availability exceptions
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

5.7.3.1 Terminology Bindings

PathDefinitionTypeReference
HealthcareService.serviceCategory A category of the service(s) that could be provided.ExampleServiceCategory
HealthcareService.serviceType Additional details about where the content was created (e.g. clinical specialty).ExampleServiceType
HealthcareService.specialty A specialty that a healthcare service may provide.PreferredPractice Setting Code Value Set
HealthcareService.serviceProvisionCode The code(s) that detail the conditions under which the healthcare service is available/offered.ExampleServiceProvisionConditions
HealthcareService.eligibility Coded values underwhich a specific service is made available.UnknownNo details provided yet
HealthcareService.characteristic A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).UnknownNo details provided yet
HealthcareService.referralMethod The methods of referral can be used when referring to a specific HealthCareService resource.ExampleReferralMethod
HealthcareService.availableTime.daysOfWeek The days of the week.RequiredDaysOfWeek

5.7.4 Notes:

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

5.7.5 Search Parameters

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

NameTypeDescriptionPaths
characteristictokenOne of the HealthcareService's characteristicsHealthcareService.characteristic
identifiertokenExternal identifiers for this itemHealthcareService.identifier
locationreferenceThe location of the Healthcare ServiceHealthcareService.location
(Location)
namestringA portion of the Healthcare service nameHealthcareService.serviceName
organizationreferenceThe organization that provides this Healthcare ServiceHealthcareService.providedBy
(Organization)
programnamestringOne of the Program Names serviced by this HealthcareServiceHealthcareService.programName
servicecategorytokenService Category of the Healthcare ServiceHealthcareService.serviceCategory
servicetypetokenThe type of service provided by this healthcare serviceHealthcareService.serviceType