FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Patient Administration icon Work GroupMaturity Level: 4 Trial UseSecurity Category: Business Compartments: No 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.

Short DisplayThe details of a healthcare service available at a location
Cardinality0..*
TypeDomainResource
Summaryfalse
HealthcareService.identifier
Element IdHealthcareService.identifier
Definition

External identifiers for this item.

Short DisplayExternal 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.

Short DisplayWhether this HealthcareService record is in active use
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.

Short DisplayOrganization that provides this 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.offeredIn
Element IdHealthcareService.offeredIn
Definition

When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service.

Short DisplayThe service within which this service is offered
Cardinality0..*
TypeReference(HealthcareService)
Summaryfalse
Comments

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.

HealthcareService.category
Element IdHealthcareService.category
Definition

Identifies the broad category of service being performed or delivered.

Short DisplayBroad category of service being performed or delivered
Cardinality0..*
Terminology BindingService Category (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.

Short DisplayType of service that may be delivered or performed
Cardinality0..*
Terminology BindingService Type (Example)
TypeCodeableConcept
Alternate Namesservice type
Summarytrue
HealthcareService.specialty
Element IdHealthcareService.specialty
Definition

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

Short DisplaySpecialties handled by the HealthcareService
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.

Short DisplayLocation(s) where 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.

Short DisplayDescription of service as 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.

Short DisplayAdditional description and/or any specific issues not covered elsewhere
Cardinality0..1
Typemarkdown
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.

Short DisplayExtra 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.

Short DisplayFacilitates quick identification of the service
Cardinality0..1
TypeAttachment
Summarytrue
HealthcareService.contact
Element IdHealthcareService.contact
Definition

The contact details of communication devices available relevant to the specific HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

Short DisplayOfficial contact details for the HealthcareService
Cardinality0..*
TypeExtendedContactDetail
Requirements

Need to keep track of both simple contact details and also assigned contacts within larger organizations.

Summaryfalse
Comments

The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the HealthcareService itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc.

If this is empty (or the type of interest is empty), 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).

Short DisplayLocation(s) service is intended for/available to
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.

Short DisplayConditions under which service is available/offered
Cardinality0..*
Terminology BindingService Provision Conditions (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?

Short DisplaySpecific eligibility requirements required to use the service
Cardinality0..*
Summaryfalse
Invariants
Defined on this element
hcs-1Rule To use an eligibility value a code must also be provided to determine the type of eligibility the value applies to.value.exists() implies code.exists()
HealthcareService.eligibility.code
Element IdHealthcareService.eligibility.code
Definition

Coded value for the eligibility.

Short DisplayCoded value for the eligibility
Cardinality0..1
Terminology BindingEligibility Characteristics (Example)
TypeCodeableConcept
Summaryfalse
HealthcareService.eligibility.value[x]
Element IdHealthcareService.eligibility.value[x]
Definition

Sometimes an eligibility code requires additional data to calculate the eligibility rules.

Short DisplayValue associated with the eligibility code
Cardinality0..1
TypeCodeableConcept|boolean|Quantity|Range|Reference
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
Comments

The example binding could utilize the value where the eligibility code is not sufficient alone.

  • pediatric-patients (with value age range)
  • existing-patients (bool value)
  • new-patients (bool value)
  • low-income-patients (maybe codeableconcept for ranges)
  • uninsured-patients (bool value)
  • renal-patients (e.g., for dialysis services)
  • speciailist-referral-required (value codeableconcept for type of referral)
  • assessment-required (bool/codeableconcept value)
HealthcareService.eligibility.comment
Element IdHealthcareService.eligibility.comment
Definition

Describes the eligibility conditions for the service.

Short DisplayDescribes 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.eligibility.period
Element IdHealthcareService.eligibility.period
Definition

The period that this eligibility rule is a requirement for this service.

Short DisplayThe period this eligibility rule applies
Cardinality0..1
Typemarkdown
Summaryfalse
HealthcareService.program
Element IdHealthcareService.program
Definition

Programs that this service is applicable to.

Short DisplayPrograms 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).

Short DisplayCollection of characteristics (attributes)
Cardinality0..*
Terminology BindingService Mode (Example)
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.

Short DisplayThe language that this service is offered in
Cardinality0..*
Terminology BindingAll Languages (Required)
Additional BindingsPurpose
Common LanguagesStarter Set
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.

Short DisplayWays that the service accepts referrals
Cardinality0..*
Terminology BindingReferral Method (Example)
TypeCodeableConcept
Summaryfalse
HealthcareService.referralRequired
Element IdHealthcareService.referralRequired
Definition

Indicates whether or not a prospective consumer will require a referral for a particular service at a site to be provided by the Organization.

Short DisplayA referral is required for access to this service
Cardinality0..1
Typeboolean
Summaryfalse
Comments

If more than just a general referral is required then you can combine this with the eligibility property to specify additional requirements, such as using the sample code specialist-referral-required or other textual details provided in the eligibility comment.

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.

Short DisplayAn appointment is required for access to this service
Cardinality0..1
Typeboolean
Summaryfalse
HealthcareService.availability
Element IdHealthcareService.availability
Definition

A collection of times that the healthcare service is available.

Short DisplayTimes the healthcare service is available (including exceptions)
Cardinality0..1
TypeAvailability
Summaryfalse
Comments

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

Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm".

The NotAvailableTime(s) included indicate the general days/periods where the service is not available (for things such as public holidays).

HealthcareService.endpoint
Element IdHealthcareService.endpoint
Definition

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

Short DisplayTechnical endpoints providing access to electronic services operated for the healthcare service
Cardinality0..*
TypeReference(Endpoint)
Summaryfalse