HealthcareService | Medplum

Healthcare Service

The details of a healthcare service available at a location.

Elements

Name	Required	Type	Description
identifier		Identifier[]	External identifiers for this item
Details
External identifiers for this item.
active		boolean	Whether this HealthcareService record is in active use
Details
This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used.
This element is labeled as a modifier because it may be used to mark that the resource was created in error.
providedBy		Reference<Organization>	Organization that provides this service
Details
The 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.
offeredIn		Reference<HealthcareService>[]	The service within which this service is offered
Details
When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service.
For example, if there is a generic Radiology service that offers CT Scans, MRIs, etc. You could have HealthcareService resources for the CT Scans and MRIs, which have an offeredIn reference to the Radiology HealthcareService.
This field was backported from FHIR R5 and is nonstandard in FHIR R4.
category		CodeableConcept[]	Broad category of service being performed or delivered
Details
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.
type		CodeableConcept[]	Type of service that may be delivered or performed
Details
The specific type of service that may be delivered or performed.
specialty		CodeableConcept[]	Specialties handled by the HealthcareService
Details
Collection of specialties handled by the service site. This is more of a medical term.
location		Reference<Location>[]	Location(s) where service may be provided
Details
The location(s) where this healthcare service may be provided.
name		string	Description of service as presented to a consumer while searching
Details
Further description of the service as it would be presented to a consumer while searching.
comment		string	Additional description and/or any specific issues not covered elsewhere
Details
Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the 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		markdown	Extra details about the service that can't be placed in the other fields
Details
Extra details about the service that can't be placed in the other fields.
photo		Attachment	Facilitates quick identification of the service
Details
If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
telecom		ContactPoint[]	Contacts related to the healthcare service
Details
List of contacts related to this specific healthcare service.
If this is empty, then refer to the location's contacts.
coverageArea		Reference<Location>[]	Location(s) service is intended for/available to
Details
The 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		CodeableConcept[]	Conditions under which service is available/offered
Details
The 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.
eligibility		HealthcareServiceEligibility[]	Specific eligibility requirements required to use the service
Details
Does this service have specific eligibility requirements that need to be met in order to use the service?
id		string	Unique id for inter-element referencing
Details
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations
Details
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored even if unrecognized
Details
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
code		CodeableConcept	Coded value for the eligibility
Details
Coded value for the eligibility.
comment		markdown	Describes the eligibility conditions for the service
Details
Describes 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		CodeableConcept[]	Programs that this service is applicable to
Details
Programs 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, ….
characteristic		CodeableConcept[]	Collection of characteristics (attributes)
Details
Collection of characteristics (attributes).
These could be such things as is wheelchair accessible.
communication		CodeableConcept[]	The language that this service is offered in
Details
Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages 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.
referralMethod		CodeableConcept[]	Ways that the service accepts referrals
Details
Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
appointmentRequired		boolean	If an appointment is required for access to this service
Details
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.
availableTime		HealthcareServiceAvailableTime[]	Times the Service Site is available
Details
A collection of times that the Service Site is available.
More detailed availability information may be provided in associated Schedule/Slot resources.
id		string	Unique id for inter-element referencing
Details
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations
Details
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored even if unrecognized
Details
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
daysOfWeek		code[]	mon
Details
Indicates which days of the week are available between the start and end Times.
allDay		boolean	Always available? e.g. 24 hour service
Details
Is this always available? (hence times are irrelevant) e.g. 24 hour service.
availableStartTime		time	Opening time of day (ignored if allDay = true)
Details
The 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		time	Closing time of day (ignored if allDay = true)
Details
The 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		HealthcareServiceNotAvailable[]	Not available during this time due to provided reason
Details
The HealthcareService is not available during this period of time due to the provided reason.
id		string	Unique id for inter-element referencing
Details
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations
Details
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored even if unrecognized
Details
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
description	✓	string	Reason presented to the user explaining why time not available
Details
The reason that can be presented to the user as to why this time is not available.
during		Period	Service not available from this date
Details
Service is not available (seasonally or for a public holiday) from this date.
availabilityExceptions		string	Description of availability exceptions
Details
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.
endpoint		Reference<Endpoint>[]	Technical endpoints providing access to electronic services operated for the healthcare service
Details
Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

Search Parameters

Name	Type	Description	Expression
active	token	The Healthcare Service is currently marked as active	HealthcareService.active
characteristic	token	One of the HealthcareService's characteristics	HealthcareService.characteristic
coverage-area	reference	Location(s) service is intended for/available to	HealthcareService.coverageArea
endpoint	reference	Technical endpoints providing access to electronic services operated for the healthcare service	HealthcareService.endpoint
identifier	token	External identifiers for this item	HealthcareService.identifier
location	reference	The location of the Healthcare Service	HealthcareService.location
name	string	A portion of the Healthcare service name	HealthcareService.name
organization	reference	The organization that provides this Healthcare Service	HealthcareService.providedBy
program	token	One of the Programs supported by this HealthcareService	HealthcareService.program
service-category	token	Service Category of the Healthcare Service	HealthcareService.category
service-type	token	The type of service provided by this healthcare service	HealthcareService.type
specialty	token	The specialty of the service provided by this healthcare service	HealthcareService.specialty
offered-in	reference	The service within which this service is offered	HealthcareService.offeredIn

Inherited Elements

Name	Type	Description
id	string	Logical id of this artifact
Details
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
meta	Meta	Metadata about the resource
Details
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri	A set of rules under which this content was created
Details
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
language	code	Language of the resource content
Details
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
text	Narrative	Text summary of the resource, for human interpretation
Details
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
contained	Resource[]	Contained, inline Resources
Details
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
extension	Extension[]	Additional content defined by implementations
Details
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension	Extension[]	Extensions that cannot be ignored
Details
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.