Structure Definition: HealthcareService Profile
Canonical URL: https://signalbhn.org/fhir/StructureDefinition/healthcareservice
Simplifier project page: https://simplifier.net/signal-mso-fhir-profiles/signalhealthcareservice
Derived from: HealthcareService (R4)
Module: Organization Services Module
Formal profile content
HealthcareService | I | HealthcareService | There are no (further) constraints on this element Element IdHealthcareService The details of a healthcare service available at a location DefinitionThe details of a healthcare service available at a location.
| |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdHealthcareService.identifier External identifiers for this item DefinitionExternal identifiers for this item.
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.active Whether this HealthcareService record is in active use DefinitionThis flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element
|
providedBy | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdHealthcareService.providedBy Organization that provides this service DefinitionThe organization that provides this healthcare service. This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.
|
category | Σ | 0..* | CodeableConceptBinding | Element IdHealthcareService.category Broad category of service being performed or delivered Alternate namesservice category DefinitionIdentifies 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. A category of the service(s) that could be provided. SignalHealthcareServiceCategory (required)Constraints
|
type | Σ | 0..* | CodeableConcept | Element IdHealthcareService.type Type of service that may be delivered or performed Alternate namesservice type DefinitionThe specific type of service that may be delivered or performed. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Unordered, Open, by coding.system(Value) BindingAdditional details about where the content was created (e.g. clinical specialty). ServiceType (example)Constraints
|
services | Σ | 1..* | CodeableConceptBinding | Element IdHealthcareService.type:services Type of service that may be delivered or performed Alternate namesservice type DefinitionEach CPT code falls into one of ten primary categories of service, or 'Service categories' Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Service types allowed in healthcare service SignalHealthcareServiceType (required)Constraints
|
procedure | Σ | 0..* | CodeableConceptBinding | Element IdHealthcareService.type:procedure Type of service that may be delivered or performed Alternate namesservice type DefinitionCPT procedure code associated with serviceCategory(ies) Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CPT procedure codes allowed in healthcare service. HealthCareServiceProcedureCodeCPT (required)Constraints
|
specialty | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdHealthcareService.specialty Specialties handled by the HealthcareService DefinitionCollection of specialties handled by the service site. This is more of a medical term. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A specialty that a healthcare service may provide. PracticeSettingCodeValueSet (preferred)Constraints
|
location | Σ I | 0..* | Reference(Location) | There are no (further) constraints on this element Element IdHealthcareService.location Location(s) where service may be provided DefinitionThe location(s) where this healthcare service may be provided. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.name Description of service as presented to a consumer while searching DefinitionFurther description of the service as it would be presented to a consumer while searching. Note that FHIR strings SHALL NOT exceed 1MB in size
|
comment | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.comment Additional description and/or any specific issues not covered elsewhere DefinitionAny additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.
|
extraDetails | 0..1 | markdown | There are no (further) constraints on this element Element IdHealthcareService.extraDetails Extra details about the service that can't be placed in the other fields DefinitionExtra details about the service that can't be placed in the other fields. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
photo | Σ I | 0..1 | Attachment | There are no (further) constraints on this element Element IdHealthcareService.photo Facilitates quick identification of the service DefinitionIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdHealthcareService.telecom Contacts related to the healthcare service DefinitionList of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts.
|
coverageArea | I | 0..* | Reference(Location) | There are no (further) constraints on this element Element IdHealthcareService.coverageArea Location(s) service is intended for/available to DefinitionThe location(s) that this service is available to (not where the service is provided). The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".
|
serviceProvisionCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.serviceProvisionCode Conditions under which service is available/offered DefinitionThe code(s) that detail the conditions under which the healthcare service is available/offered. The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply. The code(s) that detail the conditions under which the healthcare service is available/offered. ServiceProvisionConditions (example)Constraints
| |
eligibility | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.eligibility Specific eligibility requirements required to use the service DefinitionDoes this service have specific eligibility requirements that need to be met in order to use the service?
| |
code | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.eligibility.code Coded value for the eligibility DefinitionCoded value for the eligibility. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Coded values underwhich a specific service is made available. (unbound) (example)Constraints
| |
comment | 0..1 | markdown | There are no (further) constraints on this element Element IdHealthcareService.eligibility.comment Describes the eligibility conditions for the service DefinitionDescribes the eligibility conditions for the service. The 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 page.
| |
program | 1..* | CodeableConceptBinding | Element IdHealthcareService.program Programs that this service is applicable to DefinitionPrograms that this service is applicable to. Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, …. Government or local programs that this service applies to. SignalProgram (required)Constraints
| |
characteristic | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.characteristic Collection of characteristics (attributes) DefinitionCollection of characteristics (attributes). These could be such things as is wheelchair accessible. A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). (unbound) (example)Constraints
| |
communication | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdHealthcareService.communication The language that this service is offered in DefinitionSome services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling. A human language. Common Languages (preferred)Constraints
| |
referralMethod | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.referralMethod Ways that the service accepts referrals DefinitionWays that the service accepts referrals, if this is not provided then it is implied that no referral is required. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The methods of referral can be used when referring to a specific HealthCareService resource. ReferralMethod (example)Constraints
| |
appointmentRequired | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.appointmentRequired If an appointment is required for access to this service DefinitionIndicates 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.
| |
availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.availableTime Times the Service Site is available DefinitionA collection of times that the Service Site is available. More detailed availability information may be provided in associated Schedule/Slot resources.
| |
daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element IdHealthcareService.availableTime.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
| |
allDay | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| |
availableStartTime | 0..1 | time | There are no (further) constraints on this element Element IdHealthcareService.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The time zone is expected to be for where this HealthcareService is provided at.
| |
availableEndTime | 0..1 | time | There are no (further) constraints on this element Element IdHealthcareService.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The time zone is expected to be for where this HealthcareService is provided at.
| |
notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.notAvailable Not available during this time due to provided reason DefinitionThe HealthcareService is not available during this period of time due to the provided reason.
| |
description | 1..1 | string | There are no (further) constraints on this element Element IdHealthcareService.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
during | I | 0..1 | Period | There are no (further) constraints on this element Element IdHealthcareService.notAvailable.during Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.availabilityExceptions Description of availability exceptions DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element IdHealthcareService.endpoint Technical endpoints providing access to electronic services operated for the healthcare service DefinitionTechnical endpoints providing access to services operated for the specific healthcare services defined at this resource. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
HealthcareService | I | HealthcareService | There are no (further) constraints on this element Element IdHealthcareService The details of a healthcare service available at a location DefinitionThe details of a healthcare service available at a location.
| |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdHealthcareService.identifier External identifiers for this item DefinitionExternal identifiers for this item.
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.active Whether this HealthcareService record is in active use DefinitionThis flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element
|
providedBy | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdHealthcareService.providedBy Organization that provides this service DefinitionThe organization that provides this healthcare service. This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.
|
category | Σ | 0..* | CodeableConceptBinding | Element IdHealthcareService.category Broad category of service being performed or delivered Alternate namesservice category DefinitionIdentifies 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. A category of the service(s) that could be provided. SignalHealthcareServiceCategory (required)Constraints
|
type | Σ | 0..* | CodeableConcept | Element IdHealthcareService.type Type of service that may be delivered or performed Alternate namesservice type DefinitionThe specific type of service that may be delivered or performed. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Unordered, Open, by coding.system(Value) BindingAdditional details about where the content was created (e.g. clinical specialty). ServiceType (example)Constraints
|
services | Σ | 1..* | CodeableConceptBinding | Element IdHealthcareService.type:services Type of service that may be delivered or performed Alternate namesservice type DefinitionEach CPT code falls into one of ten primary categories of service, or 'Service categories' Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Service types allowed in healthcare service SignalHealthcareServiceType (required)Constraints
|
procedure | Σ | 0..* | CodeableConceptBinding | Element IdHealthcareService.type:procedure Type of service that may be delivered or performed Alternate namesservice type DefinitionCPT procedure code associated with serviceCategory(ies) Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CPT procedure codes allowed in healthcare service. HealthCareServiceProcedureCodeCPT (required)Constraints
|
specialty | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdHealthcareService.specialty Specialties handled by the HealthcareService DefinitionCollection of specialties handled by the service site. This is more of a medical term. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A specialty that a healthcare service may provide. PracticeSettingCodeValueSet (preferred)Constraints
|
location | Σ I | 0..* | Reference(Location) | There are no (further) constraints on this element Element IdHealthcareService.location Location(s) where service may be provided DefinitionThe location(s) where this healthcare service may be provided. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.name Description of service as presented to a consumer while searching DefinitionFurther description of the service as it would be presented to a consumer while searching. Note that FHIR strings SHALL NOT exceed 1MB in size
|
comment | Σ | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.comment Additional description and/or any specific issues not covered elsewhere DefinitionAny additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.
|
extraDetails | 0..1 | markdown | There are no (further) constraints on this element Element IdHealthcareService.extraDetails Extra details about the service that can't be placed in the other fields DefinitionExtra details about the service that can't be placed in the other fields. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
photo | Σ I | 0..1 | Attachment | There are no (further) constraints on this element Element IdHealthcareService.photo Facilitates quick identification of the service DefinitionIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdHealthcareService.telecom Contacts related to the healthcare service DefinitionList of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts.
|
coverageArea | I | 0..* | Reference(Location) | There are no (further) constraints on this element Element IdHealthcareService.coverageArea Location(s) service is intended for/available to DefinitionThe location(s) that this service is available to (not where the service is provided). The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".
|
serviceProvisionCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.serviceProvisionCode Conditions under which service is available/offered DefinitionThe code(s) that detail the conditions under which the healthcare service is available/offered. The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply. The code(s) that detail the conditions under which the healthcare service is available/offered. ServiceProvisionConditions (example)Constraints
| |
eligibility | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.eligibility Specific eligibility requirements required to use the service DefinitionDoes this service have specific eligibility requirements that need to be met in order to use the service?
| |
code | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.eligibility.code Coded value for the eligibility DefinitionCoded value for the eligibility. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Coded values underwhich a specific service is made available. (unbound) (example)Constraints
| |
comment | 0..1 | markdown | There are no (further) constraints on this element Element IdHealthcareService.eligibility.comment Describes the eligibility conditions for the service DefinitionDescribes the eligibility conditions for the service. The 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 page.
| |
program | 1..* | CodeableConceptBinding | Element IdHealthcareService.program Programs that this service is applicable to DefinitionPrograms that this service is applicable to. Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, …. Government or local programs that this service applies to. SignalProgram (required)Constraints
| |
characteristic | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.characteristic Collection of characteristics (attributes) DefinitionCollection of characteristics (attributes). These could be such things as is wheelchair accessible. A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). (unbound) (example)Constraints
| |
communication | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdHealthcareService.communication The language that this service is offered in DefinitionSome services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling. A human language. Common Languages (preferred)Constraints
| |
referralMethod | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdHealthcareService.referralMethod Ways that the service accepts referrals DefinitionWays that the service accepts referrals, if this is not provided then it is implied that no referral is required. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The methods of referral can be used when referring to a specific HealthCareService resource. ReferralMethod (example)Constraints
| |
appointmentRequired | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.appointmentRequired If an appointment is required for access to this service DefinitionIndicates 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.
| |
availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.availableTime Times the Service Site is available DefinitionA collection of times that the Service Site is available. More detailed availability information may be provided in associated Schedule/Slot resources.
| |
daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element IdHealthcareService.availableTime.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
| |
allDay | 0..1 | boolean | There are no (further) constraints on this element Element IdHealthcareService.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| |
availableStartTime | 0..1 | time | There are no (further) constraints on this element Element IdHealthcareService.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The time zone is expected to be for where this HealthcareService is provided at.
| |
availableEndTime | 0..1 | time | There are no (further) constraints on this element Element IdHealthcareService.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The time zone is expected to be for where this HealthcareService is provided at.
| |
notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element IdHealthcareService.notAvailable Not available during this time due to provided reason DefinitionThe HealthcareService is not available during this period of time due to the provided reason.
| |
description | 1..1 | string | There are no (further) constraints on this element Element IdHealthcareService.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
during | I | 0..1 | Period | There are no (further) constraints on this element Element IdHealthcareService.notAvailable.during Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdHealthcareService.availabilityExceptions Description of availability exceptions DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element IdHealthcareService.endpoint Technical endpoints providing access to electronic services operated for the healthcare service DefinitionTechnical endpoints providing access to services operated for the specific healthcare services defined at this resource. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
{ "resourceType": "StructureDefinition", "id": "signal-healthcareservice", "url": "https://signalbhn.org/fhir/StructureDefinition/healthcareservice", "name": "SignalHealthcareService", "title": "HealthcareService Profile", "status": "draft", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "HealthcareService", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/HealthcareService", "derivation": "constraint", "differential": { "element": [ { "id": "HealthcareService.category", "path": "HealthcareService.category", "binding": { "strength": "required", "valueSet": "https://signalbhn.org/fhir/ValueSet/signal-healthcare-service-category" } }, { "id": "HealthcareService.type", "path": "HealthcareService.type", "slicing": { "discriminator": [ { "type": "value", "path": "coding.system" } ], "description": "Each slice represents a different coding system/valueset", "rules": "open" } }, { "id": "HealthcareService.type:services", "path": "HealthcareService.type", "sliceName": "services", "definition": "Each CPT code falls into one of ten primary categories of service, or 'Service categories'", "min": 1, "binding": { "strength": "required", "description": "Service types allowed in healthcare service", "valueSet": "https://signalbhn.org/fhir/ValueSet/signal-healthcare-service-type" } }, { "id": "HealthcareService.type:procedure", "path": "HealthcareService.type", "sliceName": "procedure", "definition": "CPT procedure code associated with serviceCategory(ies)", "binding": { "strength": "required", "description": "CPT procedure codes allowed in healthcare service.", "valueSet": "https://signalbhn.org/fhir/ValueSet/healthcare-service-procedure-code-cpt" } }, { "id": "HealthcareService.program", "path": "HealthcareService.program", "min": 1, "binding": { "strength": "required", "valueSet": "https://signalbhn.org/fhir/ValueSet/signal-program" } } ] } }
Profile usage
The HealthcareService resource is used to describe healthcare services offered by an organization (called a provider) within a given context defined by OrganizationAffiliation. This resource contains many business-specific elements including offered programs, service types (modalities), service categories, procedure codes, and more. HealthcareService is meant to be a reusable resource, relating the aforementioned business elements to providers.
Profile element notes
.program
- SHALL be used to group services offered by one or more organizations under a formal "program" label; e.g. SUD, CYMHTA, CCS.
- Programs are relatively static within the organization and create the main taxonomy for the service categories and procedures available.
.category
- SHALL be used to facilitate groupings of procedures to be offered; e.g. Prevention/Eearly Intervention Services, Screening, Crisis
- Definitions from Colorado BHA USCS Manual and a catch-all Other for business-specific definitions
- will also include an "Other" code for non-Colorado BHA procedures
- Procedure codes will directly fall into one of these categories
- Secondary level to program, used as a hierarchical relationship to programs; e.g. SUD ASAM-0.5, SUD Differential Assessment, Crisis mobile, CYMHTA treatment.
- Previously referred to as modality
.type
- Will remain FHIR default (example) but will be unused at this time (see slices)
.type:services
- Custom code system for Signal that represents the "services" or "service type" codes that are available based on Organization qualifications; e.g. asam-0.5, da, crisis-mobile, etc.
.type:procedure -- Tentative use, this is likely to change
- SHOULD be populated with with procedure codes (HCPCS, CPT) that are applicable to this service category
- Definitions come from Colorado BHA USCS Manual