type: resource-definitionsresource: HealthcareService

HealthcareService Definitions

HealthcareService

The details of a healthcare service available at a location

Definition: The details of a healthcare service available at a location.

Cardinality: 0..*

Mappings: rim=act[classCode=ACT][moodCode=DEF]; interface=Participant; w5=administrative.group

HealthcareService.identifier

External identifiers for this item

Definition: External identifiers for this item.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier; rim=.id; interface=Participant.identifier

HealthcareService.active

Whether this HealthcareService record is in active use

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.

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

Meaning if Missing: This resource is generally assumed to be active if no value is provided for the active element

Cardinality: 0..1

Type: boolean

Summary: true

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)

Mappings: w5=FiveWs.status; rim=.statusCode; interface=Participant.active

HealthcareService.providedBy

Organization that provides this service

Definition: The organization that provides this healthcare service.

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.

Cardinality: 0..1

Type: Reference(Organization)

Summary: true

Mappings: rim=.scopingRole.Organization

HealthcareService.offeredIn

The service within which this service is offered

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

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.

Cardinality: 0..*

Type: Reference(HealthcareService)

HealthcareService.category

Broad category of service being performed or delivered

Definition: Identifies the broad category of service being performed or delivered.

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

Aliases: service category

Cardinality: 0..*

Type: CodeableConcept

Binding: example:service-category

Summary: true

Mappings: w5=FiveWs.class; rim=.code

HealthcareService.type

Type of service that may be delivered or performed

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

Aliases: service type

Cardinality: 0..*

Type: CodeableConcept

Binding: example:service-type

Summary: true

Mappings: rim=.actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code

HealthcareService.specialty

Specialties handled by the HealthcareService

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

Cardinality: 0..*

Type: CodeableConcept

Binding: example:c80-practice-codes

Summary: true

Mappings: rim=.actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].code

HealthcareService.location

Location(s) where service may be provided

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

Cardinality: 0..*

Type: Reference(Location)

Summary: true

Mappings: w5=FiveWs.where[x]; rim=.location.role[classCode=SDLOC]

HealthcareService.name

Description of service as presented to a consumer while searching

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

Cardinality: 0..1

Type: string

Summary: true

Mappings: rim=.name; interface=Participant.name

HealthcareService.comment

Additional description and/or any specific issues not covered elsewhere

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.

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.

Cardinality: 0..1

Type: markdown

Summary: true

Mappings: rim=.location.role[classCode=SDLOC].desc

HealthcareService.extraDetails

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

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

Cardinality: 0..1

Type: markdown

Mappings: rim=.actrelationship[typeCode=COMP.act[classCode=ACT][moodCode=DEF].text

HealthcareService.photo

Facilitates quick identification of the service

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.

Cardinality: 0..1

Type: Attachment

Summary: true

Mappings: rim=.actrelationship[typeCode=SBJ].observation.value

HealthcareService.contact

Official contact details for the HealthcareService

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.

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.

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

Cardinality: 0..*

Type: ExtendedContactDetail

HealthcareService.coverageArea

Location(s) service is intended for/available to

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

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

Cardinality: 0..*

Type: Reference(Location)

Mappings: rim=.location.role[classCode=SDLOC].subjectOf.A_SpatialCoordinate

HealthcareService.serviceProvisionCode

Conditions under which service is available/offered

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

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.

Cardinality: 0..*

Type: CodeableConcept

Binding: example:service-provision-conditions

Mappings: rim=.actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT]

HealthcareService.eligibility

Specific eligibility requirements required to use the service

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

Cardinality: 0..*

Type: BackboneElement

Constraints: hcs-1 | error | 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

Coded value for the eligibility

Definition: Coded value for the eligibility.

Conditions: hcs-1

Cardinality: 0..1

Type: CodeableConcept

Binding: example:eligibility

Mappings: rim=N/A

HealthcareService.eligibility.value[x]

Value associated with the eligibility code

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

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)

Conditions: hcs-1

Cardinality: 0..1

Type: CodeableConcept, boolean, Quantity, Range, Reference

Mappings: rim=.actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text

HealthcareService.eligibility.comment

Describes the eligibility conditions for the service

Definition: Describes the eligibility conditions for the service.

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.

Cardinality: 0..1

Type: markdown

Mappings: rim=.actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text

HealthcareService.eligibility.period

The period this eligibility rule applies

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

Cardinality: 0..1

Type: Period

Mappings: rim=.actrelationship[typeCode=PRCN].observation[moodCode=EVN.CRT].text

HealthcareService.program

Programs that this service is applicable to

Definition: Programs that this service is applicable to.

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

Cardinality: 0..*

Type: CodeableConcept

Binding: example:program

Mappings: rim=.actrelationship[typeCode=PERT].observation

HealthcareService.characteristic

Collection of characteristics (attributes)

Definition: Collection of characteristics (attributes).

Comments: These could be such things as is wheelchair accessible.

Cardinality: 0..*

Type: CodeableConcept

Binding: example:service-mode

Mappings: rim=.actrelationship[typeCode=PERT].observation

HealthcareService.communication

The language that this service is offered in

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.

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.

Cardinality: 0..*

Type: CodeableConcept

Binding: required:all-languages

HealthcareService.referralMethod

Ways that the service accepts referrals

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

Cardinality: 0..*

Type: CodeableConcept

Binding: example:service-referral-method

Mappings: rim=.actrelationship[typeCode=PERT].observation

HealthcareService.referralRequired

A referral is required for access to this service

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.

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.

Cardinality: 0..1

Type: boolean

Mappings: rim=N/A

HealthcareService.appointmentRequired

An appointment is required for access to this service

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.

Cardinality: 0..1

Type: boolean

Mappings: rim=.actrelationship[typeCode=PERT].observation

HealthcareService.availability

Times the healthcare service is available (including exceptions)

Definition: A collection of times that the healthcare service is available.

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

Cardinality: 0..1

Type: Availability

Mappings: rim=.effectiveTime

HealthcareService.endpoint

Technical endpoints providing access to electronic services operated for the healthcare service

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

Cardinality: 0..*

Type: Reference(Endpoint)

Mappings: rim=n/a