Please note:
- This version of the UK Core is for C&TA Sprint 7 Review.
- This version is not suitable for implementation. Other versions are available on the UK Core Version History Guide
- Please follow the guidance on the Contact Us page if you need any assistance.
- A summary of changes is available on the STU3 Sequence Change Log
An example to illustrate the booking organization extension associated with an appointment
Table View
| Appointment.id[0] | UKCore-Extension-BookingOrganization-Example |
| 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[0].value[0].identifier[0].use[0] | official |
| Appointment.extension[0].value[0].identifier[0].type[0].coding[0].system[0] | http://terminology.hl7.org/CodeSystem/v2-0203 |
| Appointment.extension[0].value[0].identifier[0].type[0].coding[0].code[0] | PRN |
| Appointment.extension[0].value[0].identifier[0].type[0].coding[0].display[0] | Provider number |
| Appointment.extension[0].value[0].identifier[0].system[0] | https://fhir.nhs.uk/Id/ods-site-code |
| Appointment.extension[0].value[0].identifier[0].value[0] | GP8D7 |
| Appointment.extension[0].value[0].identifier[0].period[0].start[0] | 2022-03-11T10:46:00+00:00 |
| Appointment.extension[0].value[0].identifier[0].period[0].end[0] | 2022-03-11T13:20:00+00:00 |
| Appointment.status[0] | booked |
| Appointment.start[0] | 2022-03-11T10:46:00+00:00 |
| Appointment.end[0] | 2022-03-11T13:20:00+00:00 |
| 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 |
XML View
<Appointment xmlns="http://hl7.org/fhir"> <id value="UKCore-Extension-BookingOrganization-Example" /> <!-- ***************extension start*************** --> <extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization"> <valueReference> <reference value="Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example" /> <type value="Organization" /> <identifier> <use value="official" /> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v2-0203" /> <code value="PRN" /> <display value="Provider number" /> </coding> </type> <system value="https://fhir.nhs.uk/Id/ods-site-code" /> <value value="GP8D7" /> <period> <start value="2022-03-11T10:46:00+00:00" /> <end value="2022-03-11T13:20:00+00:00" /> </period> </identifier> </valueReference> </extension> <!-- **************extension end ****************** --> <status value="booked" /> <start value="2022-03-11T10:46:00+00:00" /> <end value="2022-03-11T13:20:00+00:00" /> <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' University Hospital, Leeds" /> </actor> <required value="required" /> <status value="accepted" /> </participant> </Appointment>
JSON View
{ "resourceType": "Appointment", "id": "UKCore-Extension-BookingOrganization-Example", "extension": [ { "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization", "valueReference": { "reference": "Organization/UKCore-Organization-WhiteRoseMedicalCentre-Example", "type": "Organization", "identifier": { "use": "official", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "PRN", "display": "Provider number" } ] }, "system": "https://fhir.nhs.uk/Id/ods-site-code", "value": "GP8D7", "period": { "start": "2022-03-11T10:46:00+00:00", "end": "2022-03-11T13:20:00+00:00" } } } } ], "status": "booked", "start": "2022-03-11T10:46:00+00:00", "end": "2022-03-11T13:20:00+00:00", "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" } ] }