StructureDefinition-UKCore-HealthcareService

Canonical_URLCurrent_VersionLast_UpdatedDescription
https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService1.2.02022-12-16

This profile defines the UK constraints and extensions on the International FHIR resource HealthcareService.


Profile_Purpose

This profile is used to describe a single healthcare service or category of services that are provided by an organisation at a location, including a virtual location.

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ ?!0..1boolean
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
categoryΣ0..*CodeableConcept
typeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
nameΣ0..1string
commentΣ0..1string
extraDetails0..1markdown
photoΣ I0..1Attachment
telecomI0..*ContactPoint
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
serviceProvisionCode0..*CodeableConcept
code0..1CodeableConcept
comment0..1markdown
program0..*CodeableConcept
characteristic0..*CodeableConcept
communication0..*CodeableConceptBinding
referralMethod0..*CodeableConcept
appointmentRequired0..1boolean
daysOfWeek0..*codeBinding
allDay0..1boolean
availableStartTime0..1time
availableEndTime0..1time
description1..1string
duringI0..1Period
availabilityExceptions0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

Table View

HealthcareService..
HealthcareService.identifier..
HealthcareService.identifier.assignerReference(UK Core Organization)..
HealthcareService.providedByReference(UK Core Organization)..
HealthcareService.providedBy.identifier..
HealthcareService.providedBy.identifier.assignerReference(UK Core Organization)..
HealthcareService.specialty..
HealthcareService.locationReference(UK Core Location)..
HealthcareService.location.identifier..
HealthcareService.location.identifier.assignerReference(UK Core Organization)..
HealthcareService.coverageAreaReference(UK Core Location)..
HealthcareService.coverageArea.identifier..
HealthcareService.coverageArea.identifier.assignerReference(UK Core Organization)..
HealthcareService.communication..
HealthcareService.endpoint..
HealthcareService.endpoint.identifier..
HealthcareService.endpoint.identifier.assignerReference(UK Core Organization)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-HealthcareService" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService" />
    <version value="1.2.0" />
    <name value="UKCoreHealthcareService" />
    <title value="UK Core HealthcareService" />
    <status value="active" />
    <date value="2022-12-16" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [HealthcareService](https://hl7.org/fhir/R4/HealthcareService.html)." />
    <purpose value="This profile is used to describe a single healthcare service or category of services that are provided by an organisation at a location, including a virtual location." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <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.identifier.assigner">
            <path value="HealthcareService.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="HealthcareService.providedBy">
            <path value="HealthcareService.providedBy" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="HealthcareService.providedBy.identifier.assigner">
            <path value="HealthcareService.providedBy.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="HealthcareService.specialty">
            <path value="HealthcareService.specialty" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" />
            </binding>
        </element>
        <element id="HealthcareService.location">
            <path value="HealthcareService.location" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" />
            </type>
        </element>
        <element id="HealthcareService.location.identifier.assigner">
            <path value="HealthcareService.location.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="HealthcareService.coverageArea">
            <path value="HealthcareService.coverageArea" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" />
            </type>
        </element>
        <element id="HealthcareService.coverageArea.identifier.assigner">
            <path value="HealthcareService.coverageArea.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="HealthcareService.communication">
            <path value="HealthcareService.communication" />
            <binding>
                <strength value="extensible" />
                <description value="A ValueSet that identifies the language used by a person." />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-HumanLanguage" />
            </binding>
        </element>
        <element id="HealthcareService.endpoint.identifier.assigner">
            <path value="HealthcareService.endpoint.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-HealthcareService",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService",
    "version": "1.2.0",
    "name": "UKCoreHealthcareService",
    "title": "UK Core HealthcareService",
    "status": "active",
    "date": "2022-12-16",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [HealthcareService](https://hl7.org/fhir/R4/HealthcareService.html).",
    "purpose": "This profile is used to describe a single healthcare service or category of services that are provided by an organisation at a location, including a virtual location.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "HealthcareService",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/HealthcareService",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "HealthcareService.identifier.assigner",
                "path": "HealthcareService.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "HealthcareService.providedBy",
                "path": "HealthcareService.providedBy",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "HealthcareService.providedBy.identifier.assigner",
                "path": "HealthcareService.providedBy.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "HealthcareService.specialty",
                "path": "HealthcareService.specialty",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode"
                }
            },
            {
                "id": "HealthcareService.location",
                "path": "HealthcareService.location",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location"
                        ]
                    }
                ]
            },
            {
                "id": "HealthcareService.location.identifier.assigner",
                "path": "HealthcareService.location.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "HealthcareService.coverageArea",
                "path": "HealthcareService.coverageArea",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location"
                        ]
                    }
                ]
            },
            {
                "id": "HealthcareService.coverageArea.identifier.assigner",
                "path": "HealthcareService.coverageArea.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "HealthcareService.communication",
                "path": "HealthcareService.communication",
                "binding": {
                    "strength": "extensible",
                    "description": "A ValueSet that identifies the language used by a person.",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-HumanLanguage"
                }
            },
            {
                "id": "HealthcareService.endpoint.identifier.assigner",
                "path": "HealthcareService.endpoint.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

Orthopaedic Service - An example to illustrate information about an orthopaedic service within a HealthcareService resource.
Example UKCore-HealthcareService-OrthopaedicService

Usage

This Profile has the following derived profiles:


This Profile is referenced in the following Extensions:


This Profile is referenced in the following Profiles:
idtargetProfile
UKCore-Appointmenthttps://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure; http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Slot; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner; https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole; https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device; https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization
UKCore-PractitionerRolehttps://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization
UKCore-Schedulehttps://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device; https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner; https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole; https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization
UKCore-ServiceRequesthttps://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-CarePlan; https://fhir.hl7.org.uk/StructureDefinition/UKCore-MedicationRequest; https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; http://hl7.org/fhir/StructureDefinition/Group; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner; https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole; https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-CareTeam; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device; https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner; https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole; https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition; https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport; https://fhir.hl7.org.uk/StructureDefinition/UKCore-DocumentReference; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Specimen; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Provenance; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization
UKCore-Taskhttps://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Task; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner; https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole; https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-CareTeam; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Device; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner; https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole; https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson; https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Provenance; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner; https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole; https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson; http://hl7.org/fhir/StructureDefinition/Group; https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization

Example Usage Scenarios

The following are example usage scenarios for the UK Core HealthcareService profile:

  • Query for details of a healthcare service
  • Exchange healthcare service information within a FHIR document or message.

Profile Specific Implementation Guidance:

Minimum Viable Content

A minimum viable content that all provider and consumer systems SHALL support are the following elements.

Element Reason
HealthcareService.providedBy The organization that provides this healthcare service.

Bindings (differential)

More information about the bindings to UK Core ValueSets can be found below.

Context Strength Link
HealthcareService.communication Extensible ValueSet UKCore-HumanLanguage
HealthcareService.specialty Extensible ValueSet UKCore-PracticeSettingCode

providedBy

The resource being referenced SHALL conform to the Profile UKCore-Organization.


location

The resource being referenced SHALL conform to the Profile UKCore-Location.


telecom

A contact detail for the person using the ContactPoint data type.


coverageArea

The resource being referenced SHALL conform to the Profile UKCore-Location.