Release 4B Ballot #1

This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Patient Administration Work GroupMaturity Level: 2 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the HealthcareService resource.

HealthcareService
Element IdHealthcareService
Definition

The details of a healthcare service available at a location.

Cardinality0..*
TypeDomainResource
Summaryfalse
HealthcareService.identifier
Element IdHealthcareService.identifier
Definition

External identifiers for this item.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
HealthcareService.active
Element IdHealthcareService.active
Definition

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 for this.

Cardinality0..1
Typeboolean
Is Modifiertrue (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)
Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
Summarytrue
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 IdHealthcareService.providedBy
Definition

The organization that provides this healthcare service.

Cardinality0..1
TypeReference(Organization)
Summarytrue
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 IdHealthcareService.category
Definition

Identifies the broad category of service being performed or delivered.

Cardinality0..*
Terminology BindingServiceCategory (Example)
TypeCodeableConcept
Alternate Namesservice category
Summarytrue
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 IdHealthcareService.type
Definition

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

Cardinality0..*
Terminology BindingServiceType (Example)
TypeCodeableConcept
Alternate Namesservice type
Summarytrue
HealthcareService.specialty
Element IdHealthcareService.specialty
Definition

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

Cardinality0..*
Terminology BindingPractice Setting Code Value Set (Preferred)
TypeCodeableConcept
Summarytrue
HealthcareService.location
Element IdHealthcareService.location
Definition

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

Cardinality0..*
TypeReference(Location)
Summarytrue
HealthcareService.name
Element IdHealthcareService.name
Definition

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

Cardinality0..1
Typestring
Summarytrue
HealthcareService.comment
Element IdHealthcareService.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.

Cardinality0..1
Typestring
Summarytrue
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 IdHealthcareService.extraDetails
Definition

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

Cardinality0..1
Typemarkdown
Summaryfalse
HealthcareService.photo
Element IdHealthcareService.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.

Cardinality0..1
TypeAttachment
Summarytrue
HealthcareService.telecom
Element IdHealthcareService.telecom
Definition

List of contacts related to this specific healthcare service.

Cardinality0..*
TypeContactPoint
Summaryfalse
Comments

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

HealthcareService.coverageArea
Element IdHealthcareService.coverageArea
Definition

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

Cardinality0..*
TypeReference(Location)
Summaryfalse
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 IdHealthcareService.serviceProvisionCode
Definition

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

Cardinality0..*
Terminology BindingServiceProvisionConditions (Example)
TypeCodeableConcept
Summaryfalse
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 IdHealthcareService.eligibility
Definition

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

Cardinality0..*
Summaryfalse
HealthcareService.eligibility.code
Element IdHealthcareService.eligibility.code
Definition

Coded value for the eligibility.

Cardinality0..1
Terminology BindingServiceEligibility:
TypeCodeableConcept
Summaryfalse
HealthcareService.eligibility.comment
Element IdHealthcareService.eligibility.comment
Definition

Describes the eligibility conditions for the service.

Cardinality0..1
Typemarkdown
Summaryfalse
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.program
Element IdHealthcareService.program
Definition

Programs that this service is applicable to.

Cardinality0..*
Terminology BindingProgram (Example)
TypeCodeableConcept
Summaryfalse
Comments

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

HealthcareService.characteristic
Element IdHealthcareService.characteristic
Definition

Collection of characteristics (attributes).

Cardinality0..*
Terminology BindingServiceCharacteristic:
TypeCodeableConcept
Summaryfalse
Comments

These could be such things as is wheelchair accessible.

HealthcareService.communication
Element IdHealthcareService.communication
Definition

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.

Cardinality0..*
Terminology BindingCommon Languages (Preferred but limited to All Languages)
TypeCodeableConcept
Summaryfalse
Comments

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.

HealthcareService.referralMethod
Element IdHealthcareService.referralMethod
Definition

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

Cardinality0..*
Terminology BindingReferralMethod (Example)
TypeCodeableConcept
Summaryfalse
HealthcareService.appointmentRequired
Element IdHealthcareService.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.

Cardinality0..1
Typeboolean
Summaryfalse
HealthcareService.availableTime
Element IdHealthcareService.availableTime
Definition

A collection of times that the Service Site is available.

Cardinality0..*
Summaryfalse
Comments

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

HealthcareService.availableTime.daysOfWeek
Element IdHealthcareService.availableTime.daysOfWeek
Definition

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

Cardinality0..*
Terminology BindingDaysOfWeek (Required)
Typecode
Summaryfalse
HealthcareService.availableTime.allDay
Element IdHealthcareService.availableTime.allDay
Definition

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

Cardinality0..1
Typeboolean
Summaryfalse
HealthcareService.availableTime.availableStartTime
Element IdHealthcareService.availableTime.availableStartTime
Definition

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

Cardinality0..1
Typetime
Summaryfalse
Comments

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

HealthcareService.availableTime.availableEndTime
Element IdHealthcareService.availableTime.availableEndTime
Definition

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

Cardinality0..1
Typetime
Summaryfalse
Comments

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

HealthcareService.notAvailable
Element IdHealthcareService.notAvailable
Definition

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

Cardinality0..*
Summaryfalse
HealthcareService.notAvailable.description
Element IdHealthcareService.notAvailable.description
Definition

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

Cardinality1..1
Typestring
Summaryfalse
HealthcareService.notAvailable.during
Element IdHealthcareService.notAvailable.during
Definition

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

Cardinality0..1
TypePeriod
Summaryfalse
HealthcareService.availabilityExceptions
Element IdHealthcareService.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.

Cardinality0..1
Typestring
Summaryfalse
HealthcareService.endpoint
Element IdHealthcareService.endpoint
Definition

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

Cardinality0..*
TypeReference(Endpoint)
Summaryfalse