Work in progress.
This section of the Implementation Guide is subject to change.

Profile EEBaseHealthcareService


Profile Purpose

HealthcareService resource describes the details of a single healthcare service or category of services that are provided by an organization at a location. The location of the services could be virtual, as with telemedicine services.

Example Usage Scenarios

  • Query for healthcare services that are active at specific location using the query parameter HealthcareService.active
  • Query for healthcare services based on specific speciality using the query parameter Encounter.class
  • Exchange healthcare service information within a FHIR document or message


Snapshot View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
activeΣ ?!0..1boolean
providedByΣ I0..1Reference(EEBase Organization)
categoryΣ0..*CodeableConcept
typeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
locationΣ I0..*Reference(EEBase Location)
nameΣ0..1string
commentΣ0..1string
extraDetails0..1markdown
photoΣ I0..1Attachment
telecomI0..*ContactPoint
coverageAreaI0..*Reference(EEBase Location)
serviceProvisionCode0..*CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
code0..1CodeableConcept
comment0..1markdown
program0..*CodeableConcept
characteristic0..*CodeableConcept
communication0..*CodeableConceptBinding
referralMethod0..*CodeableConcept
appointmentRequired0..1boolean
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
daysOfWeek0..*codeBinding
allDay0..1boolean
availableStartTime0..1time
availableEndTime0..1time
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
description1..1string
duringI0..1Period
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)

Differential View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
activeΣ ?!0..1boolean
providedByΣ I0..1Reference(EEBase Organization)
categoryΣ0..*CodeableConcept
typeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
locationΣ I0..*Reference(EEBase Location)
nameΣ0..1string
commentΣ0..1string
extraDetails0..1markdown
photoΣ I0..1Attachment
telecomI0..*ContactPoint
coverageAreaI0..*Reference(EEBase Location)
serviceProvisionCode0..*CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
code0..1CodeableConcept
comment0..1markdown
program0..*CodeableConcept
characteristic0..*CodeableConcept
communication0..*CodeableConceptBinding
referralMethod0..*CodeableConcept
appointmentRequired0..1boolean
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
daysOfWeek0..*codeBinding
allDay0..1boolean
availableStartTime0..1time
availableEndTime0..1time
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
description1..1string
duringI0..1Period
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)

Hybrid View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
activeΣ ?!0..1boolean
providedByΣ I0..1Reference(EEBase Organization)
categoryΣ0..*CodeableConcept
typeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
locationΣ I0..*Reference(EEBase Location)
nameΣ0..1string
commentΣ0..1string
extraDetails0..1markdown
photoΣ I0..1Attachment
telecomI0..*ContactPoint
coverageAreaI0..*Reference(EEBase Location)
serviceProvisionCode0..*CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
code0..1CodeableConcept
comment0..1markdown
program0..*CodeableConcept
characteristic0..*CodeableConcept
communication0..*CodeableConceptBinding
referralMethod0..*CodeableConcept
appointmentRequired0..1boolean
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
daysOfWeek0..*codeBinding
allDay0..1boolean
availableStartTime0..1time
availableEndTime0..1time
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
description1..1string
duringI0..1Period
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)

Table View

HealthcareService..
HealthcareService.providedByReference(EEBase Organization)..
HealthcareService.locationReference(EEBase Location)..
HealthcareService.coverageAreaReference(EEBase Location)..
HealthcareService.communication..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="EEBase-HealthcareService" />
    <url value="https://hl7.ee/fhir/StructureDefinition/EEBase-HealthcareService" />
    <version value="1.0.0" />
    <name value="EEBaseHealthcareService" />
    <title value="EEBase HealthcareService" />
    <status value="draft" />
    <date value="2022-11-03T15:00:09.2292085+00:00" />
    <publisher value="HL7 EE" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="HealthcareService" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/HealthcareService" />
    <derivation value="constraint" />
    <differential>
        <element id="HealthcareService.providedBy">
            <path value="HealthcareService.providedBy" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Organization" />
            </type>
        </element>
        <element id="HealthcareService.location">
            <path value="HealthcareService.location" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Location" />
            </type>
        </element>
        <element id="HealthcareService.coverageArea">
            <path value="HealthcareService.coverageArea" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Location" />
            </type>
        </element>
        <element id="HealthcareService.communication">
            <path value="HealthcareService.communication" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
                    <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" />
                </extension>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="Language" />
                </extension>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
                    <valueBoolean value="true" />
                </extension>
                <strength value="preferred" />
                <valueSet value="http://hl7.org/fhir/ValueSet/all-languages" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "EEBase-HealthcareService",
    "url": "https://hl7.ee/fhir/StructureDefinition/EEBase-HealthcareService",
    "version": "1.0.0",
    "name": "EEBaseHealthcareService",
    "title": "EEBase HealthcareService",
    "status": "draft",
    "date": "2022-11-03T15:00:09.2292085+00:00",
    "publisher": "HL7 EE",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "HealthcareService",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/HealthcareService",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "HealthcareService.providedBy",
                "path": "HealthcareService.providedBy",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "HealthcareService.location",
                "path": "HealthcareService.location",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Location"
                        ]
                    }
                ]
            },
            {
                "id": "HealthcareService.coverageArea",
                "path": "HealthcareService.coverageArea",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Location"
                        ]
                    }
                ]
            },
            {
                "id": "HealthcareService.communication",
                "path": "HealthcareService.communication",
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
                            "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
                        },
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "Language"
                        },
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
                            "valueBoolean": true
                        }
                    ],
                    "strength": "preferred",
                    "valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
                }
            }
        ]
    }
}


identifier

The business identifier(s) associated with this healthcare service.


active

Whether this HealthcareService record is in active use. This resource is generally assumed to be active if no value is provided for the active element.


providedBy

The organization that provides this healthcare service using a reference to the EEBaseOrganization.


category

Identifies the broad category of service. The ValueSet used in this case is EEBaseHealthcareServiceCategory. As this is a value set with Example binding, using this value set is not strictly expected.

Siia tuleb loend EEBase-healtcareservice-category.


type

Type of service that may be delivered or performed. The ValueSet used in this case is EEBaseHealthcareServiceType. As this is a value set with Example binding, using this value set is not strictly expected.

Siia tuleb loend EEBase-healtcareservice-type.


speciality

Collection of specialties handled by the service site. The preferred ValueSet used in this case is EEBaseHealthcareServiceSpecialty, meaning these values SHOULD be exchanged, however other ValueSets (either local or developed and published by the community) may be used if required. In that case mapping other ValueSets to EEBaseHealthcareServiceSpecialty by using the ConceptMap resource is encouraged.

Siia tuleb loend EEBase-healtcareservice-specialty.


location

The location(s) where this healthcare service may be provided using a reference to EEBaseLocation.


name

Further description of the service.


comment

Additional description and/or any specific issues not covered elsewhere.


extraDetails

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


photo

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.


telecom

List of contact points that could be used for enquiries about this healthcare service.


coverageArea

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


serviceProvisionCode

Conditions under which service is available/offered.

The ValueSet used in this case is service-provision-conditions. As this is a value set with Example binding, using this value set is not strictly expected.


eligibility

Specific eligibility requirements required to use the service.


program

Programs that this service is applicable to.

The ValueSet used in this case is program. As this is a value set with Example binding, using this value set is not strictly expected.


characteristic

Please note that the binding strength of this element is unbound, meaning that the CodeSystem/ValueSet are still in development.
Collection of characteristics (attributes).

communication

Languages the service is offered in.

The preferred ValueSet used in this case is languages, meaning these values SHOULD be exchanged, however other ValueSets (either local or developed and published by the community) may be used if required. In that case mapping other ValueSets to languages by using the ConceptMap resource is encouraged.


referralMethod

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

The ValueSet used in this case is service-referral-method. As this is a value set with Example binding, using this value set is not strictly expected.


appointmentRequired

Indicates if an appointment is required for access to the service.


availableTime

A collection of times that the Service Site is available.


notAvailable

To optionally indicate that the HealthcareService is not available during a particular period of time due to the provided reason.


availabilityExceptions

Site availability exceptions to details in the available times and not available times.


endpoint

Please note that this data element includes a reference to Endpoint resource which has not been covered (profiled) in this Implementation Guide.
Technical endpoints providing access to services operated for the healthcare services.