FHIR Release 3 (STU) Current Build
Patient Administration Work Group Maturity Level : 2   Trial Use Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the HealthcareService resource.

HealthcareService
Element Id HealthcareService
Definition

The details of a healthcare service available at a location.

Control 1..1
HealthcareService.identifier
Element Id HealthcareService.identifier
Definition

External identifiers for this item.

Note This is a business identifer, not a resource identifier (see discussion )
Control 0..*
Type Identifier
Summary true
HealthcareService.active
Element Id HealthcareService.active
Definition

Whether this healthcareservice This flag is used to mark the record to not be used. This is in active use. not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

Control 0..1
Type boolean
Is Modifier true (Reason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid)
Default Value Meaning if Missing true This resource is generally assumed to be active if no value is provided for the active element
Summary true
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

HealthcareService.providedBy
Element Id HealthcareService.providedBy
Definition

The organization that provides this healthcare service.

Control 0..1
Type Reference ( Organization )
Summary true
Comments

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.

HealthcareService.category
Element Id HealthcareService.category
Definition

Identifies the broad category of service being performed or delivered.

Control 0..1 0..*
Terminology Binding ServiceCategory ( Example )
Type CodeableConcept
Alternate Names service category
Summary true
Comments

Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.

HealthcareService.type
Element Id HealthcareService.type
Definition

The specific type of service that may be delivered or performed.

Control 0..*
Terminology Binding ServiceType ( Example )
Type CodeableConcept
Alternate Names service type
Summary true
HealthcareService.specialty
Element Id HealthcareService.specialty
Definition

Collection of specialties handled by the service site. This is more of a medical term.

Control 0..*
Terminology Binding Practice Setting Code Value Set ( Preferred )
Type CodeableConcept
Summary true
HealthcareService.location
Element Id HealthcareService.location
Definition

The location(s) where this healthcare service may be provided.

Control 0..*
Type Reference ( Location )
Summary true
HealthcareService.name
Element Id HealthcareService.name
Definition

Further description of the service as it would be presented to a consumer while searching.

Control 0..1
Type string
Summary true
HealthcareService.comment
Element Id HealthcareService.comment
Definition

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.

Control 0..1
Type string
Summary true
Comments

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.

HealthcareService.extraDetails
Element Id HealthcareService.extraDetails
Definition

Extra details about the service that can't be placed in the other fields.

Control 0..1
Type string
HealthcareService.photo
Element Id HealthcareService.photo
Definition

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.

Control 0..1
Type Attachment
Summary true
HealthcareService.telecom
Element Id HealthcareService.telecom
Definition

List of contacts related to this specific healthcare service.

Control 0..*
Type ContactPoint
Comments

If this is empty, then refer to the location's contacts.

HealthcareService.coverageArea
Element Id HealthcareService.coverageArea
Definition

The location(s) that this service is available to (not where the service is provided).

Control 0..*
Type Reference ( Location )
Comments

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".

HealthcareService.serviceProvisionCode
Element Id HealthcareService.serviceProvisionCode
Definition

The code(s) that detail the conditions under which the healthcare service is available/offered.

Control 0..*
Terminology Binding ServiceProvisionConditions ( Example )
Type CodeableConcept
Comments

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.

HealthcareService.eligibility
Element Id HealthcareService.eligibility
Definition

Does this service have specific eligibility requirements that need to be met in order to use the service?

Control 0..1
Terminology Binding ServiceEligibility :
Type CodeableConcept
HealthcareService.eligibilityNote
Element Id HealthcareService.eligibilityNote
Definition

Describes the eligibility conditions for the service.

Control 0..1
Type string
Comments

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.

HealthcareService.programName
Element Id HealthcareService.programName
Definition

Program Names that can be used to categorize the service.

Control 0..*
Type string
Comments

Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….

HealthcareService.characteristic
Element Id HealthcareService.characteristic
Definition

Collection of characteristics (attributes).

Control 0..*
Terminology Binding ServiceCharacteristic :
Type CodeableConcept
Comments

These could be such things as is wheelchair accessible.

HealthcareService.referralMethod
Element Id HealthcareService.referralMethod
Definition

Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

Control 0..*
Terminology Binding ReferralMethod ( Example )
Type CodeableConcept
HealthcareService.appointmentRequired
Element Id HealthcareService.appointmentRequired
Definition

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.

Control 0..1
Type boolean
HealthcareService.availableTime
Element Id HealthcareService.availableTime
Definition

A collection of times that the Service Site is available.

Control 0..*
Comments

More detailed availability information may be provided in associated Schedule/Slot resources.

HealthcareService.availableTime.daysOfWeek
Element Id HealthcareService.availableTime.daysOfWeek
Definition

Indicates which days of the week are available between the start and end Times.

Control 0..*
Terminology Binding DaysOfWeek ( Required )
Type code
HealthcareService.availableTime.allDay
Element Id HealthcareService.availableTime.allDay
Definition

Is this always available? (hence times are irrelevant) e.g. 24 hour service.

Control 0..1
Type boolean
HealthcareService.availableTime.availableStartTime
Element Id HealthcareService.availableTime.availableStartTime
Definition

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

Control 0..1
Type time
Comments

The timezone time zone is expected to be for where this HealthcareService is provided at.

HealthcareService.availableTime.availableEndTime
Element Id HealthcareService.availableTime.availableEndTime
Definition

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

Control 0..1
Type time
Comments

The timezone time zone is expected to be for where this HealthcareService is provided at.

HealthcareService.notAvailable
Element Id HealthcareService.notAvailable
Definition

The HealthcareService is not available during this period of time due to the provided reason.

Control 0..*
HealthcareService.notAvailable.description
Element Id HealthcareService.notAvailable.description
Definition

The reason that can be presented to the user as to why this time is not available.

Control 1..1
Type string
HealthcareService.notAvailable.during
Element Id HealthcareService.notAvailable.during
Definition

Service is not available (seasonally or for a public holiday) from this date.

Control 0..1
Type Period
HealthcareService.availabilityExceptions
Element Id HealthcareService.availabilityExceptions
Definition

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.

Control 0..1
Type string
HealthcareService.endpoint
Element Id HealthcareService.endpoint
Definition

Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

Control 0..*
Type Reference ( Endpoint )
Requirements

Organizations may have different systems covering different services at the different locations and need to be able to define the technical connection details for how to connect to them, and for what purpose.