2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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.6 Resource HealthcareService - Content

This resource maintained by the Patient Administration Work Group

The details of a Healthcare Service available at a location.

5.6.1 Scope and Usage

The HealthcareService resource is used to describe a single healthcare service that is being provided by an organization at a location.

This resource is referenced by [Practitioner]

5.6.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService DomainResourceThe details of a Healthcare Service available at a location
... identifier 0..*IdentifierExternal Ids for this item
... location 1..1LocationThe location where this healthcare service may be provided
... serviceCategory 0..1CodeableConceptIdentifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type
... serviceType 0..*ElementA specific type of service that may be delivered or performed
.... type 1..1CodeableConceptThe specific type of service being delivered or performed
.... specialty 0..*CodeableConceptCollection of Specialties handled by the Service Site. This is more of a Medical Term
... serviceName 0..1stringFurther description of the service as it would be presented to a consumer while searching
... comment 0..1stringAdditional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName
... extraDetails 0..1stringExtra details about the service that can't be placed in the other fields
... freeProvisionCode 0..1CodeableConceptThe free provision code provides a link to the Free Provision reference entity to enable the selection of one free provision type
... eligibility 0..1CodeableConceptDoes this service have specific eligibility requirements that need to be met in order to use the service
... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... appointmentRequired 0..1CodeableConceptIndicates whether or not a prospective consumer will require an appointment for a particular service at a Site to be provided by the Organization. Indicates if an appointment is required for access to this service. If this flag is 'NotDefined', then this flag is overridden by the Site's availability flag. (ConditionalIndicator Enum)
... imageURI 0..1uriIf there is an image associated with this Service Site, its URI can be included here
... availableTime 0..*ElementA Collection of times that the Service Site is available
.... daysOfWeek 0..*CodeableConceptIndicates which Days of the week are available between the Start and End Times
.... allDay 0..1booleanIs this always available? (hence times are irrelevant) e.g. 24 hour service
.... availableStartTime 0..1dateTimeThe opening time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignored
.... availableEndTime 0..1dateTimeThe closing time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignored
... notAvailableTime 0..*ElementNot avail times - need better description
.... description 1..1stringThe reason that can be presented to the user as to why this time is not available
.... startDate 0..1dateTimeService is not available (seasonally or for a public holiday) from this date
.... endDate 0..1dateTimeService is not available (seasonally or for a public holiday) until this date
... availabilityExceptions 0..1stringA 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 Times
... publicKey 0..1stringThe 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 available
... programName 0..*stringProgram Names that can be used to categorize the service
... contactPoint 0..*ContactPointList of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts
... characteristic 0..*CodeableConceptCollection of Characteristics (attributes)
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
... setting 0..*CodeableConceptThe setting where this service can be provided, such is in home, or at location in organisation
... targetGroup 0..*CodeableConceptCollection of Target Groups for the Service Site (The target audience that this service is for)
... coverageArea 0..*CodeableConceptNeed better description
... catchmentArea 0..*CodeableConceptNeed better description
... serviceCode 0..*CodeableConceptList of the specific

UML Diagram

HealthcareService (DomainResource)External Ids for this itemidentifier : Identifier 0..*The location where this healthcare service may be providedlocation : Reference(Location) 1..1Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service TypeserviceCategory : CodeableConcept 0..1Further description of the service as it would be presented to a consumer while searchingserviceName : string 0..1Additional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceNamecomment : string 0..1Extra details about the service that can't be placed in the other fieldsextraDetails : string 0..1The free provision code provides a link to the Free Provision reference entity to enable the selection of one free provision typefreeProvisionCode : CodeableConcept 0..1Does this service have specific eligibility requirements that need to be met in order to use the serviceeligibility : CodeableConcept 0..1The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web pageeligibilityNote : string 0..1Indicates whether or not a prospective consumer will require an appointment for a particular service at a Site to be provided by the Organization. Indicates if an appointment is required for access to this service. If this flag is 'NotDefined', then this flag is overridden by the Site's availability flag. (ConditionalIndicator Enum)appointmentRequired : CodeableConcept 0..1If there is an image associated with this Service Site, its URI can be included hereimageURI : uri 0..1A 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..1The 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..1Program Names that can be used to categorize the serviceprogramName : string 0..*List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contactscontactPoint : ContactPoint 0..*Collection of Characteristics (attributes)characteristic : CodeableConcept 0..*Ways that the service accepts referralsreferralMethod : CodeableConcept 0..*The setting where this service can be provided, such is in home, or at location in organisationsetting : CodeableConcept 0..*Collection of Target Groups for the Service Site (The target audience that this service is for)targetGroup : CodeableConcept 0..*Need better descriptioncoverageArea : CodeableConcept 0..*Need better descriptioncatchmentArea : CodeableConcept 0..*List of the specificserviceCode : CodeableConcept 0..*ServiceTypeThe specific type of service being delivered or performedtype : CodeableConcept 1..1Collection of Specialties handled by the Service Site. This is more of a Medical Termspecialty : CodeableConcept 0..*AvailableTimeIndicates which Days of the week are available between the Start and End TimesdaysOfWeek : CodeableConcept 0..*Is this always available? (hence times are irrelevant) e.g. 24 hour serviceallDay : boolean 0..1The opening time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignoredavailableStartTime : dateTime 0..1The closing time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignoredavailableEndTime : dateTime 0..1NotAvailableTimeThe reason that can be presented to the user as to why this time is not availabledescription : string 1..1Service is not available (seasonally or for a public holiday) from this datestartDate : dateTime 0..1Service is not available (seasonally or for a public holiday) until this dateendDate : dateTime 0..1A specific type of service that may be delivered or performedserviceType0..*A Collection of times that the Service Site is availableavailableTime0..*Not avail times - need better descriptionnotAvailableTime0..*

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 Ids for this item --></identifier>
 <location><!-- 1..1 Reference(Location) 
     The location where this healthcare service may be provided --></location>
 <serviceCategory><!-- 0..1 CodeableConcept 
     Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type --></serviceCategory>
 <serviceType>  <!-- 0..* A specific type of service that may be delivered or performed -->
  <type><!-- 1..1 CodeableConcept The specific type of service being delivered or performed --></type>
  <specialty><!-- 0..* CodeableConcept 
      Collection of Specialties handled by the Service Site. This is more of a Medical Term --></specialty>
 </serviceType>
 <serviceName value="[string]"/><!-- 0..1 
     Further description of the service as it would be presented to a consumer while searching -->
 <comment value="[string]"/><!-- 0..1 
     Additional description of the  or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName -->
 <extraDetails value="[string]"/><!-- 0..1 Extra details about the service that can't be placed in the other fields -->
 <freeProvisionCode><!-- 0..1 CodeableConcept 
     The free provision code provides a link to the Free Provision reference entity to enable the selection of one free provision type --></freeProvisionCode>
 <eligibility><!-- 0..1 CodeableConcept 
     Does this service have specific eligibility requirements that need to be met in order to use the service --></eligibility>
 <eligibilityNote value="[string]"/><!-- 0..1 Describes the eligibility conditions for the service -->
 <appointmentRequired><!-- 0..1 CodeableConcept 
     Indicates whether or not a prospective consumer will require an appointment for a particular service at a Site to be provided by the Organization. Indicates if an appointment is required for access to this service. If this flag is 'NotDefined', then this flag is overridden by the Site's availability flag. (ConditionalIndicator Enum) --></appointmentRequired>
 <imageURI value="[uri]"/><!-- 0..1 If there is an image associated with this Service Site, its URI can be included here -->
 <availableTime>  <!-- 0..* A Collection of times that the Service Site is available -->
  <daysOfWeek><!-- 0..* CodeableConcept 
      Indicates which Days of the week are available between the Start and End Times --></daysOfWeek>
  <allDay value="[boolean]"/><!-- 0..1 Is this always available? (hence times are irrelevant) e.g. 24 hour service -->
  <availableStartTime value="[dateTime]"/><!-- 0..1 
      The opening time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignored -->
  <availableEndTime value="[dateTime]"/><!-- 0..1 
      The closing time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignored -->
 </availableTime>
 <notAvailableTime>  <!-- 0..* Not avail times - need better description -->
  <description value="[string]"/><!-- 1..1 The reason that can be presented to the user as to why this time is not available -->
  <startDate value="[dateTime]"/><!-- 0..1 Service is not available (seasonally or for a public holiday) from this date -->
  <endDate value="[dateTime]"/><!-- 0..1 Service is not available (seasonally or for a public holiday) until this date -->
 </notAvailableTime>
 <availabilityExceptions value="[string]"/><!-- 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 Times -->
 <publicKey value="[string]"/><!-- 0..1 
     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 available -->
 <programName value="[string]"/><!-- 0..* Program Names that can be used to categorize the service -->
 <contactPoint><!-- 0..* ContactPoint 
     List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts --></contactPoint>
 <characteristic><!-- 0..* CodeableConcept 
     Collection of Characteristics (attributes) --></characteristic>
 <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod>
 <setting><!-- 0..* CodeableConcept 
     The setting where this service can be provided, such is in home, or at location in organisation --></setting>
 <targetGroup><!-- 0..* CodeableConcept 
     Collection of Target Groups for the Service Site (The target audience that this service is for) --></targetGroup>
 <coverageArea><!-- 0..* CodeableConcept Need better description --></coverageArea>
 <catchmentArea><!-- 0..* CodeableConcept Need better description --></catchmentArea>
 <serviceCode><!-- 0..* CodeableConcept List of the specific --></serviceCode>
</HealthcareService>

JSON Template

{doco
  "resourceType" : "HealthcareService",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Ids for this item
  "location" : { Reference(Location) }, // R! 
     The location where this healthcare service may be provided
  "serviceCategory" : { CodeableConcept }, // 
     Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type
  "serviceType" : [{ // A specific type of service that may be delivered or performed
    "type" : { CodeableConcept }, // R! The specific type of service being delivered or performed
    "specialty" : [{ CodeableConcept }] // 
      Collection of Specialties handled by the Service Site. This is more of a Medical Term
  }],
  "serviceName" : "<string>", // 
     Further description of the service as it would be presented to a consumer while searching
  "comment" : "<string>", // 
     Additional description of the  or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName
  "extraDetails" : "<string>", // Extra details about the service that can't be placed in the other fields
  "freeProvisionCode" : { CodeableConcept }, // 
     The free provision code provides a link to the Free Provision reference entity to enable the selection of one free provision type
  "eligibility" : { CodeableConcept }, // 
     Does this service have specific eligibility requirements that need to be met in order to use the service
  "eligibilityNote" : "<string>", // Describes the eligibility conditions for the service
  "appointmentRequired" : { CodeableConcept }, // 
     Indicates whether or not a prospective consumer will require an appointment for a particular service at a Site to be provided by the Organization. Indicates if an appointment is required for access to this service. If this flag is 'NotDefined', then this flag is overridden by the Site's availability flag. (ConditionalIndicator Enum)
  "imageURI" : "<uri>", // If there is an image associated with this Service Site, its URI can be included here
  "availableTime" : [{ // A Collection of times that the Service Site is available
    "daysOfWeek" : [{ CodeableConcept }], // 
      Indicates which Days of the week are available between the Start and End Times
    "allDay" : <boolean>, // Is this always available? (hence times are irrelevant) e.g. 24 hour service
    "availableStartTime" : "<dateTime>", // 
      The opening time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignored
    "availableEndTime" : "<dateTime>" // 
      The closing time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignored
  }],
  "notAvailableTime" : [{ // Not avail times - need better description
    "description" : "<string>", // R! The reason that can be presented to the user as to why this time is not available
    "startDate" : "<dateTime>", // Service is not available (seasonally or for a public holiday) from this date
    "endDate" : "<dateTime>" // Service is not available (seasonally or for a public holiday) until this date
  }],
  "availabilityExceptions" : "<string>", // 
     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 Times
  "publicKey" : "<string>", // 
     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 available
  "programName" : ["<string>"], // Program Names that can be used to categorize the service
  "contactPoint" : [{ ContactPoint }], // 
     List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts
  "characteristic" : [{ CodeableConcept }], // 
     Collection of Characteristics (attributes)
  "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
  "setting" : [{ CodeableConcept }], // 
     The setting where this service can be provided, such is in home, or at location in organisation
  "targetGroup" : [{ CodeableConcept }], // 
     Collection of Target Groups for the Service Site (The target audience that this service is for)
  "coverageArea" : [{ CodeableConcept }], // Need better description
  "catchmentArea" : [{ CodeableConcept }], // Need better description
  "serviceCode" : [{ CodeableConcept }] // List of the specific
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService DomainResourceThe details of a Healthcare Service available at a location
... identifier 0..*IdentifierExternal Ids for this item
... location 1..1LocationThe location where this healthcare service may be provided
... serviceCategory 0..1CodeableConceptIdentifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type
... serviceType 0..*ElementA specific type of service that may be delivered or performed
.... type 1..1CodeableConceptThe specific type of service being delivered or performed
.... specialty 0..*CodeableConceptCollection of Specialties handled by the Service Site. This is more of a Medical Term
... serviceName 0..1stringFurther description of the service as it would be presented to a consumer while searching
... comment 0..1stringAdditional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName
... extraDetails 0..1stringExtra details about the service that can't be placed in the other fields
... freeProvisionCode 0..1CodeableConceptThe free provision code provides a link to the Free Provision reference entity to enable the selection of one free provision type
... eligibility 0..1CodeableConceptDoes this service have specific eligibility requirements that need to be met in order to use the service
... eligibilityNote 0..1stringDescribes the eligibility conditions for the service
... appointmentRequired 0..1CodeableConceptIndicates whether or not a prospective consumer will require an appointment for a particular service at a Site to be provided by the Organization. Indicates if an appointment is required for access to this service. If this flag is 'NotDefined', then this flag is overridden by the Site's availability flag. (ConditionalIndicator Enum)
... imageURI 0..1uriIf there is an image associated with this Service Site, its URI can be included here
... availableTime 0..*ElementA Collection of times that the Service Site is available
.... daysOfWeek 0..*CodeableConceptIndicates which Days of the week are available between the Start and End Times
.... allDay 0..1booleanIs this always available? (hence times are irrelevant) e.g. 24 hour service
.... availableStartTime 0..1dateTimeThe opening time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignored
.... availableEndTime 0..1dateTimeThe closing time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignored
... notAvailableTime 0..*ElementNot avail times - need better description
.... description 1..1stringThe reason that can be presented to the user as to why this time is not available
.... startDate 0..1dateTimeService is not available (seasonally or for a public holiday) from this date
.... endDate 0..1dateTimeService is not available (seasonally or for a public holiday) until this date
... availabilityExceptions 0..1stringA 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 Times
... publicKey 0..1stringThe 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 available
... programName 0..*stringProgram Names that can be used to categorize the service
... contactPoint 0..*ContactPointList of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts
... characteristic 0..*CodeableConceptCollection of Characteristics (attributes)
... referralMethod 0..*CodeableConceptWays that the service accepts referrals
... setting 0..*CodeableConceptThe setting where this service can be provided, such is in home, or at location in organisation
... targetGroup 0..*CodeableConceptCollection of Target Groups for the Service Site (The target audience that this service is for)
... coverageArea 0..*CodeableConceptNeed better description
... catchmentArea 0..*CodeableConceptNeed better description
... serviceCode 0..*CodeableConceptList of the specific

UML Diagram

HealthcareService (DomainResource)External Ids for this itemidentifier : Identifier 0..*The location where this healthcare service may be providedlocation : Reference(Location) 1..1Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service TypeserviceCategory : CodeableConcept 0..1Further description of the service as it would be presented to a consumer while searchingserviceName : string 0..1Additional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceNamecomment : string 0..1Extra details about the service that can't be placed in the other fieldsextraDetails : string 0..1The free provision code provides a link to the Free Provision reference entity to enable the selection of one free provision typefreeProvisionCode : CodeableConcept 0..1Does this service have specific eligibility requirements that need to be met in order to use the serviceeligibility : CodeableConcept 0..1The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web pageeligibilityNote : string 0..1Indicates whether or not a prospective consumer will require an appointment for a particular service at a Site to be provided by the Organization. Indicates if an appointment is required for access to this service. If this flag is 'NotDefined', then this flag is overridden by the Site's availability flag. (ConditionalIndicator Enum)appointmentRequired : CodeableConcept 0..1If there is an image associated with this Service Site, its URI can be included hereimageURI : uri 0..1A 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..1The 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..1Program Names that can be used to categorize the serviceprogramName : string 0..*List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contactscontactPoint : ContactPoint 0..*Collection of Characteristics (attributes)characteristic : CodeableConcept 0..*Ways that the service accepts referralsreferralMethod : CodeableConcept 0..*The setting where this service can be provided, such is in home, or at location in organisationsetting : CodeableConcept 0..*Collection of Target Groups for the Service Site (The target audience that this service is for)targetGroup : CodeableConcept 0..*Need better descriptioncoverageArea : CodeableConcept 0..*Need better descriptioncatchmentArea : CodeableConcept 0..*List of the specificserviceCode : CodeableConcept 0..*ServiceTypeThe specific type of service being delivered or performedtype : CodeableConcept 1..1Collection of Specialties handled by the Service Site. This is more of a Medical Termspecialty : CodeableConcept 0..*AvailableTimeIndicates which Days of the week are available between the Start and End TimesdaysOfWeek : CodeableConcept 0..*Is this always available? (hence times are irrelevant) e.g. 24 hour serviceallDay : boolean 0..1The opening time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignoredavailableStartTime : dateTime 0..1The closing time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignoredavailableEndTime : dateTime 0..1NotAvailableTimeThe reason that can be presented to the user as to why this time is not availabledescription : string 1..1Service is not available (seasonally or for a public holiday) from this datestartDate : dateTime 0..1Service is not available (seasonally or for a public holiday) until this dateendDate : dateTime 0..1A specific type of service that may be delivered or performedserviceType0..*A Collection of times that the Service Site is availableavailableTime0..*Not avail times - need better descriptionnotAvailableTime0..*

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 Ids for this item --></identifier>
 <location><!-- 1..1 Reference(Location) 
     The location where this healthcare service may be provided --></location>
 <serviceCategory><!-- 0..1 CodeableConcept 
     Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type --></serviceCategory>
 <serviceType>  <!-- 0..* A specific type of service that may be delivered or performed -->
  <type><!-- 1..1 CodeableConcept The specific type of service being delivered or performed --></type>
  <specialty><!-- 0..* CodeableConcept 
      Collection of Specialties handled by the Service Site. This is more of a Medical Term --></specialty>
 </serviceType>
 <serviceName value="[string]"/><!-- 0..1 
     Further description of the service as it would be presented to a consumer while searching -->
 <comment value="[string]"/><!-- 0..1 
     Additional description of the  or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName -->
 <extraDetails value="[string]"/><!-- 0..1 Extra details about the service that can't be placed in the other fields -->
 <freeProvisionCode><!-- 0..1 CodeableConcept 
     The free provision code provides a link to the Free Provision reference entity to enable the selection of one free provision type --></freeProvisionCode>
 <eligibility><!-- 0..1 CodeableConcept 
     Does this service have specific eligibility requirements that need to be met in order to use the service --></eligibility>
 <eligibilityNote value="[string]"/><!-- 0..1 Describes the eligibility conditions for the service -->
 <appointmentRequired><!-- 0..1 CodeableConcept 
     Indicates whether or not a prospective consumer will require an appointment for a particular service at a Site to be provided by the Organization. Indicates if an appointment is required for access to this service. If this flag is 'NotDefined', then this flag is overridden by the Site's availability flag. (ConditionalIndicator Enum) --></appointmentRequired>
 <imageURI value="[uri]"/><!-- 0..1 If there is an image associated with this Service Site, its URI can be included here -->
 <availableTime>  <!-- 0..* A Collection of times that the Service Site is available -->
  <daysOfWeek><!-- 0..* CodeableConcept 
      Indicates which Days of the week are available between the Start and End Times --></daysOfWeek>
  <allDay value="[boolean]"/><!-- 0..1 Is this always available? (hence times are irrelevant) e.g. 24 hour service -->
  <availableStartTime value="[dateTime]"/><!-- 0..1 
      The opening time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignored -->
  <availableEndTime value="[dateTime]"/><!-- 0..1 
      The closing time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignored -->
 </availableTime>
 <notAvailableTime>  <!-- 0..* Not avail times - need better description -->
  <description value="[string]"/><!-- 1..1 The reason that can be presented to the user as to why this time is not available -->
  <startDate value="[dateTime]"/><!-- 0..1 Service is not available (seasonally or for a public holiday) from this date -->
  <endDate value="[dateTime]"/><!-- 0..1 Service is not available (seasonally or for a public holiday) until this date -->
 </notAvailableTime>
 <availabilityExceptions value="[string]"/><!-- 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 Times -->
 <publicKey value="[string]"/><!-- 0..1 
     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 available -->
 <programName value="[string]"/><!-- 0..* Program Names that can be used to categorize the service -->
 <contactPoint><!-- 0..* ContactPoint 
     List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts --></contactPoint>
 <characteristic><!-- 0..* CodeableConcept 
     Collection of Characteristics (attributes) --></characteristic>
 <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod>
 <setting><!-- 0..* CodeableConcept 
     The setting where this service can be provided, such is in home, or at location in organisation --></setting>
 <targetGroup><!-- 0..* CodeableConcept 
     Collection of Target Groups for the Service Site (The target audience that this service is for) --></targetGroup>
 <coverageArea><!-- 0..* CodeableConcept Need better description --></coverageArea>
 <catchmentArea><!-- 0..* CodeableConcept Need better description --></catchmentArea>
 <serviceCode><!-- 0..* CodeableConcept List of the specific --></serviceCode>
</HealthcareService>

JSON Template

{doco
  "resourceType" : "HealthcareService",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Ids for this item
  "location" : { Reference(Location) }, // R! 
     The location where this healthcare service may be provided
  "serviceCategory" : { CodeableConcept }, // 
     Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type
  "serviceType" : [{ // A specific type of service that may be delivered or performed
    "type" : { CodeableConcept }, // R! The specific type of service being delivered or performed
    "specialty" : [{ CodeableConcept }] // 
      Collection of Specialties handled by the Service Site. This is more of a Medical Term
  }],
  "serviceName" : "<string>", // 
     Further description of the service as it would be presented to a consumer while searching
  "comment" : "<string>", // 
     Additional description of the  or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName
  "extraDetails" : "<string>", // Extra details about the service that can't be placed in the other fields
  "freeProvisionCode" : { CodeableConcept }, // 
     The free provision code provides a link to the Free Provision reference entity to enable the selection of one free provision type
  "eligibility" : { CodeableConcept }, // 
     Does this service have specific eligibility requirements that need to be met in order to use the service
  "eligibilityNote" : "<string>", // Describes the eligibility conditions for the service
  "appointmentRequired" : { CodeableConcept }, // 
     Indicates whether or not a prospective consumer will require an appointment for a particular service at a Site to be provided by the Organization. Indicates if an appointment is required for access to this service. If this flag is 'NotDefined', then this flag is overridden by the Site's availability flag. (ConditionalIndicator Enum)
  "imageURI" : "<uri>", // If there is an image associated with this Service Site, its URI can be included here
  "availableTime" : [{ // A Collection of times that the Service Site is available
    "daysOfWeek" : [{ CodeableConcept }], // 
      Indicates which Days of the week are available between the Start and End Times
    "allDay" : <boolean>, // Is this always available? (hence times are irrelevant) e.g. 24 hour service
    "availableStartTime" : "<dateTime>", // 
      The opening time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignored
    "availableEndTime" : "<dateTime>" // 
      The closing time of day (the date is not included). Note: If the AllDay flag is set, then this time is ignored
  }],
  "notAvailableTime" : [{ // Not avail times - need better description
    "description" : "<string>", // R! The reason that can be presented to the user as to why this time is not available
    "startDate" : "<dateTime>", // Service is not available (seasonally or for a public holiday) from this date
    "endDate" : "<dateTime>" // Service is not available (seasonally or for a public holiday) until this date
  }],
  "availabilityExceptions" : "<string>", // 
     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 Times
  "publicKey" : "<string>", // 
     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 available
  "programName" : ["<string>"], // Program Names that can be used to categorize the service
  "contactPoint" : [{ ContactPoint }], // 
     List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts
  "characteristic" : [{ CodeableConcept }], // 
     Collection of Characteristics (attributes)
  "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
  "setting" : [{ CodeableConcept }], // 
     The setting where this service can be provided, such is in home, or at location in organisation
  "targetGroup" : [{ CodeableConcept }], // 
     Collection of Target Groups for the Service Site (The target audience that this service is for)
  "coverageArea" : [{ CodeableConcept }], // Need better description
  "catchmentArea" : [{ CodeableConcept }], // Need better description
  "serviceCode" : [{ CodeableConcept }] // List of the specific
}

 

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

5.6.3 Notes:

  • Interaction with other Standards

    • The strong desire is that implementers of this resource should consider providing this resource in the iCalendar format as an alternative representation. Many 3rd party applications and component providers have parsers and user interface controls to display this information. This may lower the entry point to integrate outside the health-care specific applications, and into the consumer space. This would permit the easier creation of a mobile application that creates appointments in the devices native calendar.
    The iCalendar specification can be found at http://www.ietf.org/rfc/rfc2445.txt.

5.6.4 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
locationreferenceThe location of the Healthcare ServiceHealthcareService.location
(Location)
namestringA portion of the Healthcare service nameHealthcareService.serviceName
servicecategorytokenService Category of the Healthcare ServiceHealthcareService.serviceCategory
servicetypetokenThe type of service provided by this healthcare serviceHealthcareService.serviceType.type