Please note:
- This version of the UK Core is a development copy.
- This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
- This version is not yet reviewed 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
Examples Index
Examples Usage
Whilst every effort has been made to ensure that the examples are correct and useful, they are not a normative part of the specification.Profile Examples
id | Description |
---|---|
UKCore-AllergyIntolerance-Amoxicillin-Example | An example to illustrate an allergy to Amoxicillin |
UKCore-AllergyIntolerance-EnteredInError-Example | An example to illustrate an allergy that was entered in error |
UKCore-Appointment-OrthopaedicSurgery-Example | An example to illustrate n orthopaedic surgery appointment |
UKCore-AuditEvent-Query-Example | An example to illustrate an event made for purposes of maintaining a security log for a query search |
UKCore-BodyStructure-MedianCubitalVein-Example | An example to illustrate a body structure of a vein |
UKCore-Bundle-AllergyList-Example | |
UKCore-Bundle-Batch-Example | |
UKCore-Bundle-BatchPOST-Example | |
UKCore-Bundle-NEWS2Observations-Example | |
UKCore-CarePlan-WellnessPlan-Example | An example to illustrate a wellness plan for the management of Type 2 diabetes |
UKCore-CareTeam-WeightManagementTeam-Example | An example to illustrate a weight management care team |
UKCore-Communication-FirstMMRVaccination-Example | An example to illustrate a communication to notify that a patient has had their first MMR Vaccination |
UKCore-Composition-Discharge-Example | An example to illustrate a composition containing a discharge summary |
UKCore-Condition-BleedingFromEar-Example | An example to illustrate a patient bleeding from their ear |
UKCore-Condition-HipReplacement-Example | An example to illustrate a patient with an issue with their hip replacement |
UKCore-Consent-ForInformationAccess-Example | An example to illustrate consent given for information access |
UKCore-Device-BloodPressure-Sphygmomanometer-Example | An example to illustrate recording a specific blood pressure device |
UKCore-Device-BloodSpotContainer-Example | An example to illustrate a simple device instance, with type being a snomed ct code for a Capillary blood collection tube. |
UKCore-Device-ColostomyBag-Example | An example to illustrate the use of a colostomy bag as a device in the provision of healthcare |
UKCore-Device-SoftwareAsAMedicalDevice-Example | An example to illustrate software as a medical device |
UKCore-DiagnosticReport-CTChestScan-Example | An example to illustrate a diagnostic report for a CT scan |
UKCore-DiagnosticReport-DiagnosticStudiesReport-Example | An example to illustrate a diagnostic study for a patient, including the status, type of report, patient details, date, and conclusion. It indicates a mild soft tissue injury with slight bruising and no evidence of fracture or dislocation. |
UKCore-DiagnosticReport-ECG-Example | An example to illustrate a diagnostic report in PDF, for an ECG |
UKCore-DiagnosticReport-Lab-DiagnosticStudiesReport-Example | An example to illustrate a lab diagnostic report with a group observation reference |
UKCore-DocumentReference-CarePlanReportPDF-Example | An example to illustratea document reference for a care plan report PDF |
UKCore-DocumentReference-ECG-Example | An example to illustrate a DocumentReference to an ECG report |
UKCore-Encounter-InpatientEncounter-Example | An example to illustrate an inpatient encounter |
UKCore-EpisodeOfCare-SmokingCessationTherapy-Example | An example to illustrate an episode of care for smoking cessation therapy |
UKCore-FamilyMemberHistory-FatherDiabetes-Example | An example to illustrate a family member with a condition |
UKCore-Flag-FoodAllergy-Example | An example to illustrate a flag regarding a food allergy |
UKCore-HealthcareService-OrthopaedicService-Example | An example to illustrate information about an orthopaedic service within a HealthcareService resource |
UKCore-ImagingStudy-CTChestScan-Example | An example to illustrate the images produced by a CT chest scan |
UKCore-Immunization-InfluenzaVaccine-Example | An example to illustrate a vaccination for flu |
UKCore-List-EmptyList-Example | An example to illustrate an empty list |
UKCore-Location-CardiologySJUH-Example | An example to illustrate a clinical unit within a hospital |
UKCore-Location-GeneralPracticeNurseClinic-Example | An example to illustrate a GP clinic location |
UKCore-Location-HospitalSJUH-Example | An example to illustrate a hospital location |
UKCore-Location-NeoNatalLGI-Example | This is a FHIR Location resource describing the Neonatal Medicine Unit at Leeds General Infirmary. It includes its ODS site code, phone number, address, and specifies that it's a pediatric neonatal intensive care unit managed by Leeds Teaching Hospitals NHS Trust. |
UKCore-MedicationAdministration-CiprofloxacinIV-Example | An example to illustrate the administration of Ciprofloxacin via IV when prescribing multiple routes |
UKCore-MedicationAdministration-TimoptolEyeDrops-Example | An example to illustrate an administration of Timoptol eye drops |
UKCore-Medication-COVID-Vaccine-Example | An example to illustrate the batch element via a COVID-19 vaccine |
UKCore-MedicationDispense-Amoxicillin-Example | An example to illustrate the despensing of Amoxicillin when prescribing multiple routes |
UKCore-MedicationDispense-CiprofloxacinIV-Example | An example to illustrate the despensing of Ciprofloxacin via IV when prescribing multiple routes |
UKCore-MedicationDispense-CiprofloxacinOral-Example | An example to illustrate the despensing of Ciprofloxacin orally when prescribing multiple routes |
UKCore-MedicationDispense-EyeDrops-Example | An example to illustrate a medication dispense of eye drops |
UKCore-MedicationDispense-ParacetamolOral-Example | An example to illustrate the despensing of Paracetamol orally when prescribing multiple routes |
UKCore-MedicationRequest-Amoxicillin-Example | An example to illustrate the option for Amoxicillin when prescribing multiple routes |
UKCore-MedicationRequest-CiprofloxacinIV-Example | An example to illustrate the option for Ciprofloxacin via IV when prescribing multiple routes |
UKCore-MedicationRequest-CiprofloxacinOral-Example | An example to illustrate the option for Ciprofloxacin orally when prescribing multiple routes |
UKCore-MedicationRequest-Clarithromycin-Example | An example to illustrate the option for Clarithromycin when prescribing multiple routes |
UKCore-MedicationRequest-Doxycycline-Example | An example to illustrate he option for Doxycycline when prescribing multiple routes |
UKCore-MedicationRequest-EyeDrops-Example | An example to illustrate a medication request for eye drops |
UKCore-MedicationRequest-ParacetamolIV-Example | An example to illustrate the option for Paracetamol via IV when prescribing multiple routes |
UKCore-MedicationRequest-ParacetamolOral-Example | An example to illustrate the option for Paracetamol orally when prescribing multiple routes |
UKCore-MedicationStatement-Amoxicillin-Example | An example to illustrate a medication statement for Amoxicillin |
UKCore-Medication-TimololVTM-Example | An example to illustrate the form element with VTM via Timolol medicine |
UKCore-Medication-TimoptolEyeDrops-Example | An example to illustrate Timoptol eye drops medication |
UKCore-MessageHeader-Discharge-Example | An example to illustrate a message header for a discharge summary |
UKCore-Observation-24HourBloodPressure-Example | An example to illustrate an average blood pressure over 24 hours |
UKCore-Observation-AwarenessOfDiagnosis-Example | An example to illustrate an observation of the awareness of diagnosis |
UKCore-Observation-BreathingNormally-Example | An example to illustrate an observation of a patient breathing room air |
UKCore-Observation-DrugUse-Example | An example to illustrate an observation of the patient's illicit drug use |
UKCore-Observation-FastingTest-Example | An example to illustrate a blood glucose reading after fasting |
UKCore-Observation-FingerJointInflamed-Example | An example to illustrate a finger joint inflammation observation |
UKCore-Observation-Group-FullBloodCount-Example | An example to illustrate a full blood count using multiple lab observation references |
UKCore-Observation-HeavyDrinker-Example | An example to illustrate a patient who is a heavy drinker |
UKCore-Observation-Lab-Albumin-Example | This is a FHIR Observation representing a laboratory test for a patient's serum albumin level. It includes test codes from UK reference sets, the measured value, the performing laboratory, the date of issue, and a reference range to interpret the result. |
UKCore-Observation-Lab-RedCellCount-Example | An example to illustrate the observation of a red cell count for a blood specimen |
UKCore-Observation-Lab-WhiteCellCount-Example | An example to illustrate the observation of a white cell count for a blood specimen |
UKCore-Observation-NPEWSTotal-Example | An example to illustrate a NPEWS Total Score |
UKCore-Observation-OxygenTherapy-Example | An example to illustrate an observation of a patient being assisted by oxygen therapy |
UKCore-Observation-PatientConsciousness-Example | An example to illustrate a patient's consciousness level |
UKCore-Observation-PipeSmoker-Example | An example to illustrate the observation of a patient who smokes a pipe |
UKCore-Observation-VitalSigns-BloodPressure-Example | An example to illustrate a blood pressure measurement vital signs observation |
UKCore-Observation-VitalSigns-BMI-Example | An example to illustrate a body mass index vital sign |
UKCore-Observation-VitalSigns-BodyHeight-Example | An example to illustrate a body height vital sign |
UKCore-Observation-VitalSigns-BodyTemperature-Example | An example to illustrate a body temperature vital sign |
UKCore-Observation-VitalSigns-BodyWeight-Example | An example to illustrate a body weight vital sign |
UKCore-Observation-VitalSigns-HeadCircumference-Example | An example to illustrate a head circumference vital sign |
UKCore-Observation-VitalSigns-HeartRate-Example | An example to illustrate a heart rate vital sign |
UKCore-Observation-VitalSigns-OxygenSaturation-Example | An example to illustrate an oxygen saturation vital sign |
UKCore-Observation-VitalSigns-RespiratoryRate-Example | An example to illustrate a respiration rate vital signs observation |
UKCore-OperationOutcome-DateError-Example | An example to illustrate an error returned from an API call, due to an error in a date |
UKCore-Organization-LeedsTeachingHospital-Example | An example to illustrate an NHS Trust organisation |
UKCore-Organization-WhiteRoseMedicalCentre-Example | An example to illustrate an organization |
UKCore-Patient-BabyPatient-Example | An example to illustrate a patient that is a baby |
UKCore-Patient-RichardSmith-Example | An example to illustrate a generic patient |
UKCore-Practitioner-ConsultantSandraGose-Example | An example to illustrate a practitioner who is a consultant |
UKCore-Practitioner-DoctorPaulRastall-Example | An example to illustrate a practitioner who is a doctor |
UKCore-Practitioner-PharmacistJimmyChuck-Example | An example to illustrate a pharmacist practitioner |
UKCore-PractitionerRole-GeneralPractitioner-Example | An example to illustrate a practitioner with the GP role |
UKCore-Procedure-ExaminationOfSkin-Example | An example to illustrate a skin examination procedure |
UKCore-Provenance-RARecordConsent-Example | An example to illustrate provenance for a consent scenario |
UKCore-Questionnaire-EOLPlan-Example | An example to illustrate an end of life plan questionnaire |
UKCore-Questionnaire-FitnessForWork-Example | An example to illustrate a fitness for work form questions |
UKCore-Questionnaire-InpatientSurvey-Example | An example to illustrate an in-patient questionnaire |
UKCore-QuestionnaireResponse-BabyPatientSurvey-Example | An example to illustrate a questionnaire response for a birth registration form |
UKCore-QuestionnaireResponse-EOLPlan-Example | An example to illustrate a questionnaire response for an end of life survey |
UKCore-QuestionnaireResponse-FitnessForWork-Example | An example to illustrate a questionnaire response for a fitness to work form |
UKCore-QuestionnaireResponse-InpatientSurvey-Example | An example to illustrate a questionnaire response for an in-patient survey |
UKCore-RelatedPerson-JoySmith-Example | An example to illustrate a person who is related to the patient |
UKCore-RequestGroup-Ciprofloxacin-Example | An example to illustrate the options for Ciprofloxacin when prescribing multiple routes |
UKCore-RequestGroup-MultipleAntibiotics-Example | An example to illustrate the options for multiple antibiotics when prescribing multiple routes |
UKCore-RequestGroup-Paracetamol-Example | An example to illustrate the options for Paracetamol when prescribing multiple routes |
UKCore-Schedule-Immunization-Example | An example to illustrate a schedule for immunization appointments |
UKCore-ServiceRequest-ColonoscopyRequest-Example | An example to illustrate a GP referral for a colonoscopy |
UKCore-ServiceRequest-CTChestScan-Example | An example to illustrate a request for a CT chest scan due to a suspected blood clot |
UKCore-ServiceRequest-ECG-Example | An example to illustrate service request for an ECG due to an elevated heart rate |
UKCore-ServiceRequest-HipReplacement-Example | An example to illustrate annual review request triggered automatically |
UKCore-ServiceRequest-Lab-CReactiveProtein-Example | An example to illustrate a request for a lab test |
UKCore-Slot-AvailableWalkInVisit-Example | An example to illustrate a free / available slot for a walk in vaccination |
UKCore-Specimen-BloodSpecimen-Example | An example to illustrate a blood specimen that was taken by a finger prick |
UKCore-Specimen-UrineSpecimen-Example | An example to illustrate a urine sample |
UKCore-Task-Colonoscopy-Example | An example to illustrate a task for a colonoscopy request |
UKCore-VitalSigns-Observation-OxygenSaturation-Example | An example to illustrate an oxygen saturation vital sign |
Extension Examples
id | Description |
---|---|
Extension-UKCore-AdditionalContact-Example | An example to illustrate sending a reference to an additional contact with a service request |
Extension-UKCore-AddressKey-Example | An example to illustrate the use of an address key used with the address datatype |
Extension-UKCore-AdmissionMethod-Example | An example to illustrate the extension for an encounter to support the method by which an individual was admitted into hospital |
Extension-UKCore-AllergyIntolEnd-Example | An example to illustrate the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid |
Extension-UKCore-AssociatedEncounter-Example | An example to illustrate sending an associated encounter with family member history |
Extension-UKCore-BirthPlace-Example | An example to illustrate the registered place of birth of the patient using the core-defined extension |
Extension-UKCore-BirthSex-Example | An example to illustrate the extension for a patient's birth sex |
Extension-UKCore-BirthTime-Example | An example to illustrate the patient's birth time using the core-defined extension |
Extension-UKCore-BodySiteReference-Example | An example to illustrate the use of the BodySiteReference extension |
Extension-UKCore-BookingOrganization-Example | An example to illustrate the booking organization extension associated with an appointment |
Extension-UKCore-CadavericDonor-Example | An example to illustrate whether the patient authorised the donation of body parts after death using the core-defined extension |
Extension-UKCore-CareSettingType-Example | An example to illustrate the care setting of a FHIR document |
Extension-UKCore-CodingSCT-CodeUnknown-Example | An example to illustrate the use of the CodeableConcept.text field only if the coding system and code is unknown |
Extension-UKCore-CodingSCTDescId-Example | An example to illustrate the extension which adds a SNOMED CT description ID to CodeableConcept |
Extension-UKCore-CodingSCT-Heart-Example | An example to illustrate the use of an extension to represent a SNOMED CT concept with a specific Description ID — typically to preserve or specify which synonym or preferred term was originally used in a clinical system |
Extension-UKCore-CodingSCT-IllicitDrugs-Example | An example to illustrate the use of two extensions, one to represent a SNOMED CT concept with a specific Description ID, the other to represent the associated SNOMED CT Term (text description) — typically to preserve or specify which synonym or preferred term was originally used in a clinical system |
Extension-UKCore-CodingSCT-MoleOfSkin-Example | This is a FHIR Condition resource recording that the patient has a benign mole (melanocytic naevus) on the skin. It includes both CTV3 and SNOMED codes, along with user-facing text "Moles". |
Extension-UKCore-CodingSCT-Myocardial-Example | This FHIR Condition resource records that the patient has had a myocardial infarction (heart attack), using the SNOMED code 22298006 with user-selected terminology. |
Extension-UKCore-CodingSCT-Potassium-Example | An example to illustrate the use of two extensions, one to represent a SNOMED CT concept with a specific Description ID, the other to represent the associated SNOMED CT Term (text description) — typically to preserve or specify which synonym or preferred term was originally used in a clinical system |
Extension-UKCore-CodingSCT-Weight-Example | An example to illustrate the use of an extension to represent a SNOMED CT concept with a specific Description ID — typically to preserve or specify which synonym or preferred term was originally used in a clinical system |
Extension-UKCore-CompositionReference-Example | An example to illustrate referencing a composition within a diagnostic report |
Extension-UKCore-ConditionEpisode-Example | An example to illustrate the extension which is used to indicate the episodicity status of a condition |
Extension-UKCore-ContactPreference-Example | An example to illustrate the extension for a patient's contact preferences |
Extension-UKCore-ContactRank-Example | An example to illustrate the extension for the patient's contact ranking |
Extension-UKCore-CopyCorrespondenceIndicator-Example | An example to illustrate the extension for copy correspondence indicators |
Extension-UKCore-Coverage-Example | An example to illustrate sending an NHS or Private funding category with a service request |
Extension-UKCore-CuffSize-Example | An example to illustrate recording a blood pressure device with a large cuff |
Extension-UKCore-DeathNotificationStatus-Example | An example to illustrate the extension to indicate the death notification status of the patient |
Extension-UKCore-DeliveryChannel-Example | An example to illustrate the delivery channel associated with an appointment |
Extension-UKCore-DeviceReference-Example | An example to illustrate a device performing a diagnostic report |
Extension-UKCore-DiagnosticReportMediaLinkR5-Example | An example to illustrate the backport extension to allow referencing a DocumentReference instance within DiagnosticReport.media.link |
Extension-UKCore-DischargeMethod-Example | An example to illustrate the extension for an encounter to support the method of discharge from a hospital |
Extension-UKCore-EffectivePeriod-Example | An example to illustrate the recording of effective start and end dates for any resource |
Extension-UKCore-EmergencyCareDischargeStatus-Example | An example to illustrate the extension which is used to indicate the status of an individual on discharge from an Emergency Care Department |
Extension-UKCore-EthnicCategory-Example | An example to illustrate the extension which shows the ethnic category for a patient |
Extension-UKCore-Evidence-Example | An example to illustrate a reference to results of investigations that confirmed the certainty of the diagnosis for an allergy or intolerance |
Extension-UKCore-InterpreterRequired-Example | An example to illustrate the core-defined extension which is used to indicate that a person requires an interpreter |
Extension-UKCore-LegalStatus-Example | An example to illustrate the extension which is used to indicate a patient's legal status on admission or discharge |
Extension-UKCore-ListWarningCode-Example | An example to illustrate a warning being provided in a list resource |
Extension-UKCore-MainLocation-Example | An example to illustrate the extension which shows an organisation's main location |
Extension-UKCore-MedicalApplianceSupplier-Example | An example to illustrate the extension to record the patients nominated medical appliance supplier |
Extension-UKCore-MedicationChangeSummary-Example | An example to illustrate the extension that describes the change information of a medication item |
Extension-UKCore-MedicationPrescribingOrganizationType-Example | An example to illustrate the type of organisation or setting responsible for authorising and issuing a medication, but not the organisation or setting delivering the patient care |
Extension-UKCore-MedicationStatementLastIssueDate-Example | An example to illustrate the date the medication were last issued |
Extension-UKCore-MedicationTradeFamily-Example | An example to illustrate the use of a trade family or brand |
Extension-UKCore-NHSNumberUnavailableReason-Example | An example to illustrate the extension which states the reason a patient does not have a NHS number |
Extension-UKCore-NHSNumberVerificationStatus-Example | An example to illustrate the extension which states the patient's NHS number verification status |
Extension-UKCore-Note-Example | An example to illustrate sending a note with a diagnostic report |
Extension-UKCore-OtherContactSystem-Example | An example to illustrate the extension to indicate other contact system(s) for a patient Richard Smith |
Extension-UKCore-OutcomeOfAttendance-Example | An example to illustrate the extension which is used to indicate the outcome of an outpatient attendance |
Extension-UKCore-OverseasVisitorChargingCategory-Example | An example to illustrate a patients charging category |
Extension-UKCore-ParentPresent-Example | An example to illustrate the extension for a vaccination procedure where the parent of the patient is present |
Extension-UKCore-Participant-Example | An example to illustrate sending the participant involved in recording the activities relating to this family member history |
Extension-UKCore-Period-Example | An example to illustrate sending a period |
Extension-UKCore-PharmacistVerifiedIndicator-Example | An example to illustrate whether a pharmacist verified a medication |
Extension-UKCore-PreferredDispenserOrganization-Example | An example to illustrate a preferred dispenser |
Extension-UKCore-PriorityReason-Example | An example to illustrate sending a priority reason for an urgent ServiceRequest, using a SNOMED CT concept |
Extension-UKCore-PriorityReason-SendingAsText-Example | An example to illustrate sending a priority reason for an urgent ServiceRequest, using plain text |
Extension-UKCore-RecordingSetting-Example | An example to illustrate sending the setting a vital signs observation was recorded in |
Extension-UKCore-RepeatInformation-Example | An example to illustrate the specific repeat information of a medication item |
Extension-UKCore-ResidentialStatus-Example | An example to illustrate the extension to show the patient's residential status |
Extension-UKCore-ResponseRequest-Example | An example to illustrate the HL7 extension ResponseRequest |
Extension-UKCore-SampleCategory-Example | An example to illustrate the use of the Sample Category extension |
Extension-UKCore-SampleCategory-PheobeSmitham-Example | An example to illustrate the use of the Sample Category extension |
Extension-UKCore-SourceOfServiceRequest-Example | An example to illustrate the source of service request extension associated with a service request |
Extension-UKCore-SpecialHandling-Example | An example to illustrate the use of the HL7 core-defined Extension specimen-specialHandling |
Extension-UKCore-SpecimenCollectionCollector-Example | An example to illustrate the pre-adopted R5 element via an extension, which is used to reference a Patient or RelatedPerson within Specimen.collection.collector |
Extension-UKCore-SpecimenContainerDeviceBackport-Example | An example to illustrate the use of the backport Specimen.container.device to allow for referencing a Device Instance |
Extension-UKCore-SubscriptionParameters-Example | An example to illustrate identification and provision of API parameters in R4 Subscription. |
Extension-UKCore-Translation-Example | An example to illustrate the translation extension from one language to another |
Extension-UKCore-TriggeredBy-Example | An example to illustration observation triggered by another observation |
Extension-UKCore-VaccinationProcedure-COVID-Example | An example to illustrate the extension for a vaccination procedure for COVID-19 |
Extension-UKCore-VaccinationProcedure-Example | An example to illustrate the extension for a vaccination procedure |