An example to illustrate an orthopaedic surgery appointment

Table View

Appointment.id[0]UKCore-Appointment-OrthopaedicSurgery-Example
Appointment.text[0].status[0]additional
Appointment.text[0].div[0]<div xmlns="http://www.w3.org/1999/xhtml">An example to illustrate n orthopaedic surgery appointment</div>
Appointment.extension[0].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization
Appointment.extension[0].value[0].reference[0]Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example
Appointment.extension[0].value[0].type[0]Organization
Appointment.extension[1].url[0]https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel
Appointment.extension[1].value[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-DeliveryChannel
Appointment.extension[1].value[0].coding[0].code[0]In-person
Appointment.extension[1].value[0].coding[0].display[0]In person
Appointment.identifier[0].system[0]https://tools.ietf.org/html/rfc4122
Appointment.identifier[0].value[0]e7c54d06-c5b5-4ecb-91c3-5c1e68d3b923
Appointment.status[0]booked
Appointment.serviceCategory[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/service-category
Appointment.serviceCategory[0].coding[0].code[0]31
Appointment.serviceCategory[0].coding[0].display[0]Specialist Surgical
Appointment.serviceType[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/service-type
Appointment.serviceType[0].coding[0].code[0]218
Appointment.serviceType[0].coding[0].display[0]Orthopaedic Surgery
Appointment.specialty[0].coding[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-PracticeSettingCode
Appointment.specialty[0].coding[0].code[0]110
Appointment.specialty[0].coding[0].display[0]Trauma and Orthopaedics
Appointment.appointmentType[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/v2-0276
Appointment.appointmentType[0].coding[0].code[0]FOLLOWUP
Appointment.appointmentType[0].coding[0].display[0]A follow up visit from a previous appointment
Appointment.reasonReference[0].reference[0]Condition/UKCore-Condition-HipReplacement-Example
Appointment.reasonReference[0].display[0]Pain in both hips
Appointment.priority[0]1
Appointment.description[0]Appointment to investigate the pain in both hips
Appointment.start[0]2022-03-11T10:46:00+00:00
Appointment.end[0]2022-03-11T13:20:00+00:00
Appointment.created[0]2022-02-14
Appointment.comment[0]Further expand on the results of the X-ray and determine the next actions that may be appropriate.
Appointment.patientInstruction[0]Please do not eat anything for 1 hour prior to the appointment.
Appointment.basedOn[0].reference[0]ServiceRequest/UKCore-ServiceRequest-HipReplacement-Example
Appointment.participant[0].actor[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Appointment.participant[0].actor[0].display[0]Richard Smith
Appointment.participant[0].required[0]required
Appointment.participant[0].status[0]accepted
Appointment.participant[1].type[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/v3-ParticipationType
Appointment.participant[1].type[0].coding[0].code[0]ATND
Appointment.participant[1].actor[0].reference[0]Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example
Appointment.participant[1].actor[0].display[0]Dr Sandra Gose
Appointment.participant[1].required[0]required
Appointment.participant[1].status[0]accepted
Appointment.participant[2].actor[0].reference[0]Location/UKCore-Location-HospitalSJUH-Example
Appointment.participant[2].actor[0].display[0]Orthopaedic Trauma Department, St James' University Hospital, Leeds
Appointment.participant[2].required[0]required
Appointment.participant[2].status[0]accepted

Tree View

Appointment

XML View

<Appointment xmlns="http://hl7.org/fhir">
    <id value="UKCore-Appointment-OrthopaedicSurgery-Example" />
    <text>
        <status value="additional" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <!-- This supports the recording of the organisation booking the appointment. -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization">
        <valueReference>
            <reference value="Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example" />
            <type value="Organization" />
        </valueReference>
    </extension>
    <!-- This describes the delivery channel of a scheduled appointment. -->
    <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-DeliveryChannel" />
                <code value="In-person" />
                <display value="In person" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <identifier>
        <system value="https://tools.ietf.org/html/rfc4122" />
        <value value="e7c54d06-c5b5-4ecb-91c3-5c1e68d3b923" />
    </identifier>
    <status value="booked" />
    <serviceCategory>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/service-category" />
            <code value="31" />
            <display value="Specialist Surgical" />
        </coding>
    </serviceCategory>
    <serviceType>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/service-type" />
            <code value="218" />
            <display value="Orthopaedic Surgery" />
        </coding>
    </serviceType>
    <specialty>
        <coding>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PracticeSettingCode" />
            <code value="110" />
            <display value="Trauma and Orthopaedics" />
        </coding>
    </specialty>
    <appointmentType>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v2-0276" />
            <code value="FOLLOWUP" />
            <display value="A follow up visit from a previous appointment" />
        </coding>
    </appointmentType>
    <reasonReference>
        <reference value="Condition/UKCore-Condition-HipReplacement-Example" />
        <display value="Pain in both hips" />
    </reasonReference>
    <priority value="1" />
    <description value="Appointment to investigate the pain in both hips" />
    <start value="2022-03-11T10:46:00+00:00" />
    <end value="2022-03-11T13:20:00+00:00" />
    <created value="2022-02-14" />
    <comment value="Further expand on the results of the X-ray and determine the next actions that may be appropriate." />
    <patientInstruction value="Please do not eat anything for 1 hour prior to the appointment." />
    <basedOn>
        <reference value="ServiceRequest/UKCore-ServiceRequest-HipReplacement-Example" />
    </basedOn>
    <participant>
        <actor>
            <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
            <display value="Richard Smith" />
        </actor>
        <required value="required" />
        <status value="accepted" />
    </participant>
    <participant>
        <type>
            <coding>
                <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType" />
                <code value="ATND" />
            </coding>
        </type>
        <actor>
            <reference value="Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example" />
            <display value="Dr Sandra Gose" />
        </actor>
        <required value="required" />
        <status value="accepted" />
    </participant>
    <participant>
        <actor>
            <reference value="Location/UKCore-Location-HospitalSJUH-Example" />
            <display value="Orthopaedic Trauma Department, St James&#39; University Hospital, Leeds" />
        </actor>
        <required value="required" />
        <status value="accepted" />
    </participant>
</Appointment>

JSON View

{
    "resourceType": "Appointment",
    "id": "UKCore-Appointment-OrthopaedicSurgery-Example",
    "text": {
        "status": "additional",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization",
            "valueReference": {
                "reference": "Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example",
                "type": "Organization"
            }
        },
        {
            "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-DeliveryChannel",
                        "code": "In-person",
                        "display": "In person"
                    }
                ]
            }
        }
    ],
    "identifier":  [
        {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "e7c54d06-c5b5-4ecb-91c3-5c1e68d3b923"
        }
    ],
    "status": "booked",
    "serviceCategory":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/service-category",
                    "code": "31",
                    "display": "Specialist Surgical"
                }
            ]
        }
    ],
    "serviceType":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/service-type",
                    "code": "218",
                    "display": "Orthopaedic Surgery"
                }
            ]
        }
    ],
    "specialty":  [
        {
            "coding":  [
                {
                    "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PracticeSettingCode",
                    "code": "110",
                    "display": "Trauma and Orthopaedics"
                }
            ]
        }
    ],
    "appointmentType": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/v2-0276",
                "code": "FOLLOWUP",
                "display": "A follow up visit from a previous appointment"
            }
        ]
    },
    "reasonReference":  [
        {
            "reference": "Condition/UKCore-Condition-HipReplacement-Example",
            "display": "Pain in both hips"
        }
    ],
    "priority": 1,
    "description": "Appointment to investigate the pain in both hips",
    "start": "2022-03-11T10:46:00+00:00",
    "end": "2022-03-11T13:20:00+00:00",
    "created": "2022-02-14",
    "comment": "Further expand on the results of the X-ray and determine the next actions that may be appropriate.",
    "patientInstruction": "Please do not eat anything for 1 hour prior to the appointment.",
    "basedOn":  [
        {
            "reference": "ServiceRequest/UKCore-ServiceRequest-HipReplacement-Example"
        }
    ],
    "participant":  [
        {
            "actor": {
                "reference": "Patient/UKCore-Patient-RichardSmith-Example",
                "display": "Richard Smith"
            },
            "required": "required",
            "status": "accepted"
        },
        {
            "type":  [
                {
                    "coding":  [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                            "code": "ATND"
                        }
                    ]
                }
            ],
            "actor": {
                "reference": "Practitioner/UKCore-Practitioner-ConsultantSandraGose-Example",
                "display": "Dr Sandra Gose"
            },
            "required": "required",
            "status": "accepted"
        },
        {
            "actor": {
                "reference": "Location/UKCore-Location-HospitalSJUH-Example",
                "display": "Orthopaedic Trauma Department, St James' University Hospital, Leeds"
            },
            "required": "required",
            "status": "accepted"
        }
    ]
}

back to top