description: Base StructureDefinition for HealthcareService Resource
package_name: hl7.fhir.r2b.core
derivation: specialization
name: HealthcareService
type: null
elements:
  coverageArea:
    isModifier: false
    short: Location(s) service is inteded for/available to
    index: 11
    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".
    type: Reference
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: HealthcareService.coverageArea}
    isSummary: false
  availableTime:
    isModifier: false
    short: Times the Service Site is available
    index: 20
    comments: More detailed availability information may be provided in associated Schedule/Slot resources.
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      daysOfWeek:
        isModifier: false
        short: mon | tue | wed | thu | fri | sat | sun
        index: 21
        type: code
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: HealthcareService.availableTime.daysOfWeek}
        isSummary: false
      allDay:
        isModifier: false
        short: Always available? e.g. 24 hour service
        type: boolean
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: HealthcareService.availableTime.allDay}
        isSummary: false
        index: 22
      availableStartTime:
        isModifier: false
        short: Opening time of day (ignored if allDay = true)
        index: 23
        comments: The timezone is expected to be for where this HealthcareService is provided at.
        type: time
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: HealthcareService.availableTime.availableStartTime}
        isSummary: false
      availableEndTime:
        isModifier: false
        short: Closing time of day (ignored if allDay = true)
        index: 24
        comments: The timezone is expected to be for where this HealthcareService is provided at.
        type: time
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: HealthcareService.availableTime.availableEndTime}
        isSummary: false
    maxLength: 0
    base: {max: '*', min: 0, path: HealthcareService.availableTime}
    isSummary: false
  serviceCategory:
    isModifier: false
    short: Broad category of service being performed or delivered
    index: 2
    comments: Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.
    type: CodeableConcept
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: HealthcareService.serviceCategory}
    isSummary: true
  specialty:
    isModifier: false
    short: Specialties handled by the HealthcareService
    index: 4
    type: CodeableConcept
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: HealthcareService.specialty}
    isSummary: true
  notAvailable:
    isModifier: false
    short: Not available during this time due to provided reason
    index: 25
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      description:
        isModifier: false
        short: Reason presented to the user explaining why time not available
        index: 26
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: HealthcareService.notAvailable.description}
        isSummary: false
      during:
        isModifier: false
        short: Service not availablefrom this date
        type: Period
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: HealthcareService.notAvailable.during}
        isSummary: false
        index: 27
    maxLength: 0
    base: {max: '*', min: 0, path: HealthcareService.notAvailable}
    required: [description]
    isSummary: false
  providedBy:
    isModifier: false
    short: Organization that provides this service
    index: 1
    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.
    type: Reference
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: HealthcareService.providedBy}
    isSummary: true
  eligibility:
    isModifier: false
    short: Specific eligibility requirements required to use the service
    type: CodeableConcept
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: HealthcareService.eligibility}
    isSummary: false
    index: 13
  serviceType:
    isModifier: false
    short: Type of service that may be delivered or performed
    index: 3
    type: CodeableConcept
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: HealthcareService.serviceType}
    isSummary: true
  eligibilityNote:
    isModifier: false
    short: Describes the eligibility conditions for the service
    index: 14
    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.
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: HealthcareService.eligibilityNote}
    isSummary: false
  extraDetails:
    isModifier: false
    short: Extra details about the service that can't be placed in the other fields
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: HealthcareService.extraDetails}
    isSummary: false
    index: 8
  characteristic:
    isModifier: false
    short: Collection of characteristics (attributes)
    index: 16
    comments: These could be such things as is wheelchair accessible.
    type: CodeableConcept
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: HealthcareService.characteristic}
    isSummary: false
  publicKey:
    isModifier: false
    short: PKI Public keys to support secure communications
    index: 18
    comments: 'Note: This is a base64 encoded digital certificate.'
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: HealthcareService.publicKey}
    isSummary: false
  photo:
    isModifier: false
    short: Facilitates quick identification of the service
    type: Attachment
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: HealthcareService.photo}
    isSummary: true
    index: 9
  comment:
    isModifier: false
    short: Additional description and/or any specific issues not covered elsewhere
    index: 7
    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.
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: HealthcareService.comment}
    isSummary: true
  identifier:
    isModifier: false
    short: External identifiers for this item
    index: 0
    type: Identifier
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: HealthcareService.identifier}
    isSummary: true
  serviceProvisionCode:
    isModifier: false
    short: Conditions under which service is available/offered
    index: 12
    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.
    type: CodeableConcept
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: HealthcareService.serviceProvisionCode}
    isSummary: false
  availabilityExceptions:
    isModifier: false
    short: Description of availability exceptions
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: HealthcareService.availabilityExceptions}
    isSummary: false
    index: 28
  programName:
    isModifier: false
    short: Program Names that categorize the service
    index: 15
    comments: Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….
    type: string
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: HealthcareService.programName}
    isSummary: false
  appointmentRequired:
    isModifier: false
    short: If an appointment is required for access to this service
    type: boolean
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: HealthcareService.appointmentRequired}
    isSummary: false
    index: 19
  referralMethod:
    isModifier: false
    short: Ways that the service accepts referrals
    index: 17
    type: CodeableConcept
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: HealthcareService.referralMethod}
    isSummary: false
  telecom:
    isModifier: false
    short: Contacts related to the healthcare service
    index: 10
    comments: If this is empty, then refer to the location's contacts.
    type: ContactPoint
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: HealthcareService.telecom}
    isSummary: false
  serviceName:
    isModifier: false
    short: Description of service as presented to a consumer while searching
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: HealthcareService.serviceName}
    isSummary: true
    index: 6
  location:
    isModifier: false
    short: Location(s) where service may be provided
    index: 5
    type: Reference
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: HealthcareService.location}
    isSummary: true
package_version: 1.4.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/HealthcareService
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null