SMART Scheduling Links
1.0.0 - STU 1
SMART Scheduling Links
1.0.0 - STU 1
SMART Scheduling Links, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/smart-scheduling-links/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/smart-scheduling-links/StructureDefinition/smart-scheduling-healthcare-service | Version: 1.0.0 | ||||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: SmartSchedulingHealthcareService | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.91.42.5 | |||||
The Health Service 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. This profile provides a scheduling-optimized view of healthcare service offerings, enabling discovery and booking of appointments when no specific practitioner is required or specified.
Example Usage Scenarios
The following are example usage scenarios for the SMART Scheduling Links HealthcareService profile:
The following data elements must always be present or must be supported if the data is present in the sending system. They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.
Each HealthcareService Must Have:
Each HealthcareService Must Support:
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |
  id |
1..1 | id | Logical id of this artifact | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| active |
1..1 | boolean | Whether this HealthcareService record is in active use | |
 providedBy |
0..1 | Reference(Organization) | Organization that provides this service | |
 category |
0..1 | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | |
| type |
1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). | |
| specialty |
1..1 | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | |
| location |
1..1 | Reference(Location) | Location(s) where service may be provided | |
| name |
1..1 | string | Description of service as presented to a consumer while searching | |
| comment |
0..1 | string | Additional description and/or any specific issues not covered elsewhere | |
| telecom |
0..* | ContactPoint | Contacts related to the healthcare service | |
| serviceProvisionCode |
0..1 | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. | |
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |
 availableTime |
0..* | BackboneElement | Times the Service Site is available | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |
 availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |
 notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| description |
1..1 | string | Reason presented to the user explaining why time not available | |
| during |
0..1 | Period | Service not available from this date | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| HealthcareService.type | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| HealthcareService.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| HealthcareService.serviceProvisionCode | Base | example | ServiceProvisionConditions | 📍4.0.1 | FHIR Std. |
| HealthcareService.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |
 id |
1..1 | id | Logical id of this artifact | |
| active |
1..1 | boolean | Whether this HealthcareService record is in active use | |
| providedBy |
0..1 | Reference(Organization) | Organization that provides this service | |
| category |
0..1 | CodeableConcept | Broad category of service being performed or delivered | |
| type |
1..1 | CodeableConcept | Type of service that may be delivered or performed | |
| specialty |
1..1 | CodeableConcept | Specialties handled by the HealthcareService | |
| location |
1..1 | Reference(Location) | Location(s) where service may be provided | |
| name |
1..1 | string | Description of service as presented to a consumer while searching | |
| comment |
0..1 | string | Additional description and/or any specific issues not covered elsewhere | |
| telecom |
0..* | ContactPoint | Contacts related to the healthcare service | |
| serviceProvisionCode |
0..1 | CodeableConcept | Conditions under which service is available/offered | |
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun | |
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |
| description |
1..1 | string | Reason presented to the user explaining why time not available | |
| during |
0..1 | Period | Service not available from this date | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
| id |
1..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | External identifiers for this item | |||||
| active |
1..1 | boolean | Whether this HealthcareService record is in active use | |||||
| providedBy |
0..1 | Reference(Organization) | Organization that provides this service | |||||
| category |
0..1 | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | |||||
| type |
1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
| specialty |
1..1 | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | |||||
| location |
1..1 | Reference(Location) | Location(s) where service may be provided | |||||
| name |
1..1 | string | Description of service as presented to a consumer while searching | |||||
| comment |
0..1 | string | Additional description and/or any specific issues not covered elsewhere | |||||
| extraDetails |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo |
0..1 | Attachment | Facilitates quick identification of the service | |||||
| telecom |
0..* | ContactPoint | Contacts related to the healthcare service | |||||
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode |
0..1 | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. | |||||
| eligibility |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available. | |||||
| comment |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
| characteristic |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
| communication |
0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
| referralMethod |
0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource. | |||||
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| HealthcareService.type | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| HealthcareService.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| HealthcareService.serviceProvisionCode | Base | example | ServiceProvisionConditions | 📍4.0.1 | FHIR Std. |
| HealthcareService.eligibility.code | Base | example | Not State | Unknown | |
| HealthcareService.program | Base | example | Program | 📍4.0.1 | FHIR Std. |
| HealthcareService.characteristic | Base | example | Not State | Unknown | |
| HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.referralMethod | Base | example | ReferralMethod | 📍4.0.1 | FHIR Std. |
| HealthcareService.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from HealthcareService
Summary
Mandatory: 6 elements
Must-Support: 20 elements
Structures
This structure refers to these other structures:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |
| id |
1..1 | id | Logical id of this artifact | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| active |
1..1 | boolean | Whether this HealthcareService record is in active use | |
| providedBy |
0..1 | Reference(Organization) | Organization that provides this service | |
| category |
0..1 | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | |
| type |
1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). | |
| specialty |
1..1 | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | |
| location |
1..1 | Reference(Location) | Location(s) where service may be provided | |
| name |
1..1 | string | Description of service as presented to a consumer while searching | |
| comment |
0..1 | string | Additional description and/or any specific issues not covered elsewhere | |
| telecom |
0..* | ContactPoint | Contacts related to the healthcare service | |
| serviceProvisionCode |
0..1 | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. | |
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| description |
1..1 | string | Reason presented to the user explaining why time not available | |
| during |
0..1 | Period | Service not available from this date | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| HealthcareService.type | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| HealthcareService.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| HealthcareService.serviceProvisionCode | Base | example | ServiceProvisionConditions | 📍4.0.1 | FHIR Std. |
| HealthcareService.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |
| id |
1..1 | id | Logical id of this artifact | |
| active |
1..1 | boolean | Whether this HealthcareService record is in active use | |
| providedBy |
0..1 | Reference(Organization) | Organization that provides this service | |
| category |
0..1 | CodeableConcept | Broad category of service being performed or delivered | |
| type |
1..1 | CodeableConcept | Type of service that may be delivered or performed | |
| specialty |
1..1 | CodeableConcept | Specialties handled by the HealthcareService | |
| location |
1..1 | Reference(Location) | Location(s) where service may be provided | |
| name |
1..1 | string | Description of service as presented to a consumer while searching | |
| comment |
0..1 | string | Additional description and/or any specific issues not covered elsewhere | |
| telecom |
0..* | ContactPoint | Contacts related to the healthcare service | |
| serviceProvisionCode |
0..1 | CodeableConcept | Conditions under which service is available/offered | |
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun | |
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |
| description |
1..1 | string | Reason presented to the user explaining why time not available | |
| during |
0..1 | Period | Service not available from this date | |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
| id |
1..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | External identifiers for this item | |||||
| active |
1..1 | boolean | Whether this HealthcareService record is in active use | |||||
| providedBy |
0..1 | Reference(Organization) | Organization that provides this service | |||||
| category |
0..1 | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | |||||
| type |
1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
| specialty |
1..1 | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | |||||
| location |
1..1 | Reference(Location) | Location(s) where service may be provided | |||||
| name |
1..1 | string | Description of service as presented to a consumer while searching | |||||
| comment |
0..1 | string | Additional description and/or any specific issues not covered elsewhere | |||||
| extraDetails |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo |
0..1 | Attachment | Facilitates quick identification of the service | |||||
| telecom |
0..* | ContactPoint | Contacts related to the healthcare service | |||||
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode |
0..1 | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. | |||||
| eligibility |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available. | |||||
| comment |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
| characteristic |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
| communication |
0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
| referralMethod |
0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource. | |||||
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| HealthcareService.type | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| HealthcareService.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| HealthcareService.serviceProvisionCode | Base | example | ServiceProvisionConditions | 📍4.0.1 | FHIR Std. |
| HealthcareService.eligibility.code | Base | example | Not State | Unknown | |
| HealthcareService.program | Base | example | Program | 📍4.0.1 | FHIR Std. |
| HealthcareService.characteristic | Base | example | Not State | Unknown | |
| HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.referralMethod | Base | example | ReferralMethod | 📍4.0.1 | FHIR Std. |
| HealthcareService.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from HealthcareService
Summary
Mandatory: 6 elements
Must-Support: 20 elements
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2026+ HL7 International / Patient Administration and Boston Children's Hospital. Package hl7.fhir.uv.smart-scheduling-links#1.0.0 based on FHIR 4.0.1. Generated 2026-10-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change