StructureDefinition-UKCore-Appointment

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

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


Profile_Purpose

This profile allows recording of detailed information about a planned meeting that may be in the future or past. The resource only describes a single meeting, a series of repeating visits would require multiple appointment resources to be created for each instance.

Examples include a scheduled surgery, a follow-up for a clinical visit, a scheduled conference call between clinicians to discuss a case, the reservation of a piece of diagnostic equipment for a particular use, etc. The visit scheduled by an appointment may be in person or remote (by phone, video conference, etc.) All that matters is that the time and usage of one or more individuals, locations and/or pieces of equipment is being fully or partially reserved for a designated period of time.

Snapshot View

bookingOrganizationI0..1Extension(Reference(UK Core Organization))
deliveryChannelI0..1Extension(code)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
cancelationReasonΣ0..1CodeableConcept
serviceCategoryΣ0..*CodeableConcept
serviceTypeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
appointmentTypeΣ0..1CodeableConceptBinding
reasonCodeΣ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
priority0..1unsignedInt
description0..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
startΣ0..1instant
endΣ0..1instant
minutesDuration0..1positiveInt
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
created0..1dateTime
comment0..1string
patientInstruction0..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
typeΣ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
requiredΣ0..1codeBinding
statusΣ1..1codeBinding
periodI0..1Period
requestedPeriodI0..*Period

Differential View

bookingOrganizationI0..1Extension(Reference(UK Core Organization))
deliveryChannelI0..1Extension(code)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
cancelationReasonΣ0..1CodeableConcept
serviceCategoryΣ0..*CodeableConcept
serviceTypeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
appointmentTypeΣ0..1CodeableConceptBinding
reasonCodeΣ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
priority0..1unsignedInt
description0..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
startΣ0..1instant
endΣ0..1instant
minutesDuration0..1positiveInt
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
created0..1dateTime
comment0..1string
patientInstruction0..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
typeΣ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
requiredΣ0..1codeBinding
statusΣ1..1codeBinding
periodI0..1Period
requestedPeriodI0..*Period

Hybrid View

bookingOrganizationI0..1Extension(Reference(UK Core Organization))
deliveryChannelI0..1Extension(code)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
cancelationReasonΣ0..1CodeableConcept
serviceCategoryΣ0..*CodeableConcept
serviceTypeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
appointmentTypeΣ0..1CodeableConceptBinding
reasonCodeΣ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
priority0..1unsignedInt
description0..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
startΣ0..1instant
endΣ0..1instant
minutesDuration0..1positiveInt
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
created0..1dateTime
comment0..1string
patientInstruction0..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
typeΣ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
requiredΣ0..1codeBinding
statusΣ1..1codeBinding
periodI0..1Period
requestedPeriodI0..*Period

Table View

Appointment..
Appointment.extension0..
Appointment.extensionExtension0..
Appointment.extensionExtension0..1
Appointment.identifier..
Appointment.identifier.assignerReference(UK Core Organization)..
Appointment.specialty..
Appointment.appointmentType..
Appointment.reasonReferenceReference(UK Core Condition | UK Core Observation | UK Core Procedure | ImmunizationRecommendation)..
Appointment.reasonReference.identifier..
Appointment.reasonReference.identifier.assignerReference(UK Core Organization)..
Appointment.supportingInformation..
Appointment.supportingInformation.identifier..
Appointment.supportingInformation.identifier.assignerReference(UK Core Organization)..
Appointment.slotReference(UK Core Slot)..
Appointment.slot.identifier..
Appointment.slot.identifier.assignerReference(UK Core Organization)..
Appointment.basedOnReference(UK Core ServiceRequest)..
Appointment.basedOn.identifier..
Appointment.basedOn.identifier.assignerReference(UK Core Organization)..
Appointment.participant..
Appointment.participant.actorReference(UK Core Patient | UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson | Device | UK Core HealthcareService | UK Core Location)..
Appointment.participant.actor.identifier..
Appointment.participant.actor.identifier.assignerReference(UK Core Organization)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Appointment" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment" />
    <version value="1.2.0" />
    <name value="UKCoreAppointment" />
    <title value="UK Core Appointment" />
    <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 [Appointment](https://hl7.org/fhir/R4/Appointment.html)." />
    <purpose value="This profile allows recording of detailed information about a planned meeting that may be in the future or past. The resource only describes a single meeting, a series of repeating visits would require multiple appointment resources to be created for each instance. \n\n Examples include a scheduled surgery, a follow-up for a clinical visit, a scheduled conference call between clinicians to discuss a case, the reservation of a piece of diagnostic equipment for a particular use, etc. The visit scheduled by an appointment may be in person or remote (by phone, video conference, etc.) All that matters is that the time and usage of one or more individuals, locations and/or pieces of equipment is being fully or partially reserved for a designated period of time." />
    <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" />
    <mapping>
        <identity value="workflow" />
        <uri value="http://hl7.org/fhir/workflow" />
        <name value="Workflow Pattern" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <mapping>
        <identity value="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <mapping>
        <identity value="ical" />
        <uri value="http://ietf.org/rfc/2445" />
        <name value="iCalendar" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Appointment" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Appointment" />
    <derivation value="constraint" />
    <differential>
        <element id="Appointment.extension">
            <path value="Appointment.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Appointment.extension:bookingOrganization">
            <path value="Appointment.extension" />
            <sliceName value="bookingOrganization" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="Appointment.extension:deliveryChannel">
            <path value="Appointment.extension" />
            <sliceName value="deliveryChannel" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="Appointment.identifier.assigner">
            <path value="Appointment.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Appointment.specialty">
            <path value="Appointment.specialty" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" />
            </binding>
        </element>
        <element id="Appointment.appointmentType">
            <path value="Appointment.appointmentType" />
            <binding>
                <strength value="extensible" />
                <description value="A set of codes that define an appointment reason." />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-AppointmentReasonCode" />
            </binding>
        </element>
        <element id="Appointment.reasonReference">
            <path value="Appointment.reasonReference" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Procedure" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation" />
            </type>
        </element>
        <element id="Appointment.reasonReference.identifier.assigner">
            <path value="Appointment.reasonReference.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Appointment.supportingInformation.identifier.assigner">
            <path value="Appointment.supportingInformation.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Appointment.slot">
            <path value="Appointment.slot" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Slot" />
            </type>
        </element>
        <element id="Appointment.slot.identifier.assigner">
            <path value="Appointment.slot.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Appointment.basedOn">
            <path value="Appointment.basedOn" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest" />
            </type>
        </element>
        <element id="Appointment.basedOn.identifier.assigner">
            <path value="Appointment.basedOn.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Appointment.participant.actor">
            <path value="Appointment.participant.actor" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" />
            </type>
        </element>
        <element id="Appointment.participant.actor.identifier.assigner">
            <path value="Appointment.participant.actor.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-Appointment",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment",
    "version": "1.2.0",
    "name": "UKCoreAppointment",
    "title": "UK Core Appointment",
    "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 [Appointment](https://hl7.org/fhir/R4/Appointment.html).",
    "purpose": "This profile allows recording of detailed information about a planned meeting that may be in the future or past. The resource only describes a single meeting, a series of repeating visits would require multiple appointment resources to be created for each instance. \n\n Examples include a scheduled surgery, a follow-up for a clinical visit, a scheduled conference call between clinicians to discuss a case, the reservation of a piece of diagnostic equipment for a particular use, etc. The visit scheduled by an appointment may be in person or remote (by phone, video conference, etc.) All that matters is that the time and usage of one or more individuals, locations and/or pieces of equipment is being fully or partially reserved for a designated period of time.",
    "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",
    "mapping":  [
        {
            "identity": "workflow",
            "uri": "http://hl7.org/fhir/workflow",
            "name": "Workflow Pattern"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        },
        {
            "identity": "ical",
            "uri": "http://ietf.org/rfc/2445",
            "name": "iCalendar"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Appointment",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Appointment",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Appointment.extension",
                "path": "Appointment.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Appointment.extension:bookingOrganization",
                "path": "Appointment.extension",
                "sliceName": "bookingOrganization",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Appointment.extension:deliveryChannel",
                "path": "Appointment.extension",
                "sliceName": "deliveryChannel",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Appointment.identifier.assigner",
                "path": "Appointment.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Appointment.specialty",
                "path": "Appointment.specialty",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode"
                }
            },
            {
                "id": "Appointment.appointmentType",
                "path": "Appointment.appointmentType",
                "binding": {
                    "strength": "extensible",
                    "description": "A set of codes that define an appointment reason.",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-AppointmentReasonCode"
                }
            },
            {
                "id": "Appointment.reasonReference",
                "path": "Appointment.reasonReference",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "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"
                        ]
                    }
                ]
            },
            {
                "id": "Appointment.reasonReference.identifier.assigner",
                "path": "Appointment.reasonReference.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Appointment.supportingInformation.identifier.assigner",
                "path": "Appointment.supportingInformation.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Appointment.slot",
                "path": "Appointment.slot",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Slot"
                        ]
                    }
                ]
            },
            {
                "id": "Appointment.slot.identifier.assigner",
                "path": "Appointment.slot.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Appointment.basedOn",
                "path": "Appointment.basedOn",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest"
                        ]
                    }
                ]
            },
            {
                "id": "Appointment.basedOn.identifier.assigner",
                "path": "Appointment.basedOn.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Appointment.participant.actor",
                "path": "Appointment.participant.actor",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "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/Device",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location"
                        ]
                    }
                ]
            },
            {
                "id": "Appointment.participant.actor.identifier.assigner",
                "path": "Appointment.participant.actor.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

Orthopaedic Surgery - An example to illustrate an Orthopaedic Surgery appointment.
Example UKCore-Appointment-OrthopaedicSurgery

Booking Organization - An example to illustrate the booking organization extension associated with an appointment.
Example UKCore-Appointment-Extension-BookingOrganization

Delivery Channel - An example to illustrate the delivery channel associated with an appointment.
Example UKCore-Appointment-Extension-DeliveryChannel

Example Usage Scenarios

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

  • Query for appointment information for a given Patient
  • Exchange appointment 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
Appointment.status The overall status of the appointment.
Appointment.specialty The specialty of a practitioner that would be required to perform the service requested in this appointment
Appointment.appointmentType The type of appointment or patient that has been booked in the slot
Appointment.reasonCode Reason for the appointment
Appointment.reasonReference Reference to the Observation, Condition, Procedure, or ImmunizationRecommendation that is the reason for the appointment
Appointment.start Start time of the appointment
Appointment.end End time of the appointment
Appointment.basedOn The service request this appointment is allocated to assess
Appointment.basedOn.identifier Logical reference, when literal reference is not known
Appointment.participant List of participants involved in the appointment.
Appointment.participant.actor A Person, Location, HealthcareService, or Device that is participating in the appointment.

Extensions

More information about the extensions can be found using the links below.

Extension Context Link
bookingOrganisation Appointment Extension UKCore-BookingOrganization
deliveryChannel Appointment Extension UKCore-DeliveryChannel

Bindings (differential)

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

Context Strength Link
Appointment.extension:deliveryChannel Extensible ValueSet UKCore-DeliveryChannel
Appointment.appointmentType Extensible ValueSet UKCore-AppointmentReasonCode
Appointment.specialty Extensible ValueSet UKCore-PracticeSettingCode

reasonReference

The resource being referenced SHALL conform to one of the following:


supportingInformation

Where a UK Core profile exists the resource being referenced SHALL conform to the profile.


slot

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


basedOn

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


participant

A list of participants involved in the appointment.

participant.type

Optional role of participant in the appointment that uses the following values which may be extended. The binding is to the International FHIR ValueSet encounter-participant-type, which is shown expanded here due to the complexity of included codes and systems.

Code System Display Definition
ADM http://terminology.hl7.org/CodeSystem/v3-ParticipationType admitter The practitioner who is responsible for admitting a patient to a patient encounter.
ATND http://terminology.hl7.org/CodeSystem/v3-ParticipationType attender The practitioner that has responsibility for overseeing a patient's care during a patient encounter.
CALLBCK http://terminology.hl7.org/CodeSystem/v3-ParticipationType callback contact A person or organization who should be contacted for follow-up questions about the act in place of the author.
CON http://terminology.hl7.org/CodeSystem/v3-ParticipationType consultant An advisor participating in the service by performing evaluations and making recommendations.
DIS http://terminology.hl7.org/CodeSystem/v3-ParticipationType discharger The practitioner who is responsible for the discharge of a patient from a patient encounter.
ESC http://terminology.hl7.org/CodeSystem/v3-ParticipationType escort Only with Transportation services. A person who escorts the patient.
REF http://terminology.hl7.org/CodeSystem/v3-ParticipationType referrer A person having referred the subject of the service to the performer (referring physician). Typically, a referring physician will receive a report.
SPRF http://terminology.hl7.org/CodeSystem/v3-ParticipationType secondary performer A person assisting in an act through his substantial presence and involvement This includes: assistants, technicians, associates, or whatever the job titles may be.
PPRF http://terminology.hl7.org/CodeSystem/v3-ParticipationType primary performer The principal or primary performer of the act.
PART http://terminology.hl7.org/CodeSystem/v3-ParticipationType Participation Indicates that the target of the participation is involved in some manner in the act, but does not qualify how.
translator http://terminology.hl7.org/CodeSystem/participant-type Translator A translator who is facilitating communication with the patient during the encounter.
emergency http://terminology.hl7.org/CodeSystem/participant-type Emergency A person to be contacted in case of an emergency during the encounter.

participant.actor

Optional Person, Location/HealthcareService or Device that is participating in the appointment.

The resource being referenced SHALL conform to one of the following:


back to top