- 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
Profiles and Extensions
Profiles Index
This index contains all the profiles Clinically and Technically Assured for use with UK Core.
Important
The Profiles are rendered in several formats:
- Tree View - Snapshot: a fully calculated tree view of the structure that is not dependent on any other structure
- Tree View - Differential: this tree view describes only the differences that the Profile makes relative to the structure definition (FHIR resource or profile) they constrain
- Tree View - Hybrid: a hybrid view of the snapshot and differential views, with the differences highlighted
- Detailed View: a fully calculated form of the profile in table form
- Table View: a differential view of the profile, rendered in a tabular format
- XML View: a differential view of the profile, rendered in XML format
- JSON View: a differential view of the profile, rendered in JSON format
- Examples: one or more validated example of the profile in use
- Feedback: a link to Simplifier to raise issues regarding the asset
Further information from HL7 relating to profiling is available.
Profile | Purpose | Resource |
---|---|---|
UKCore-Task | A task resource describes an activity that can be performed and tracks the state of completion of that activity. It is a representation that an activity should be or has been initiated, and eventually, represents the successful or unsuccessful completion of that activity. Note that there are a variety of processes associated with making and processing orders. Some orders may be handled immediately by automated systems but most require real world actions by one or more humans. Some orders can only be processed when other real world actions happen, such as a patient presenting themselves so that the action to be performed can actually be performed. Often these real world dependencies are only implicit in the order details. | Task |
UKCore-Subscription | This profile facilitates communication (using a push-based subscription) between a server and another system. When a subscription is registered with the server, it checks every resource that is created or updated, and if the resource meets the specified criteria, the server sends a message through the defined 'channel,' allowing the other system to take the appropriate action. | Subscription |
UKCore-Specimen | This profile allows the exchange of information about a sample to be used for analysis. | Specimen |
UKCore-Slot | Slot resources are used to provide time-slots that can be booked using an appointment. They do not provide any information about appointments that are available, just the time, and optionally what the time can be used for. These are effectively spaces of free/busy time. Slots can also be marked as busy without having appointments associated. | Slot |
UKCore-ServiceRequest-Lab | To provide implementers additional support for requesting a procedure or diagnostic or other service to be planned, proposed, or performed, with regards to a laboratory observation or a laboratory diagnostic report. | ServiceRequest |
UKCore-ServiceRequest | This profile is a record of a request for a procedure or diagnostic or other service to be planned, proposed, or performed, as distinguished by the ServiceRequest.intent field value, with or on a patient. | ServiceRequest |
UKCore-Schedule | Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked. The schedule does not provide any information about actual appointments. This separation greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available. | Schedule |
UKCore-RequestGroup | This profile is a record of a group of medication related requests, with a specific set of conditions on how they must be actioned. It is for use in hospital prescribing, where multiple routes of administration are possible. | RequestGroup |
UKCore-RelatedPerson | This profile allows exchange of information about a person that is involved in the care for an individual, but who is not the target of healthcare, nor has a formal responsibility in the care process. | RelatedPerson |
UKCore-QuestionnaireResponse | This profile describes a structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to. | QuestionnaireResponse |
UKCore-Questionnaire | This profile is used to organise a collection of questions intended to solicit information from patients, providers or other individuals involved in the healthcare domain. | Questionnaire |
UKCore-Provenance | The Provenance resource tracks information about the activity that created, revised, deleted, or signed a version of a resource, describing the entities and agents involved. | Provenance |
UKCore-Procedure | This profile allows exchange of details of current and historical procedures performed on or for an individual. A procedure is an activity that is performed on, with, or for an individual as part of the provision of care. Examples include surgical procedures, diagnostic procedures, endoscopic procedures, biopsies, counselling, physiotherapy, personal support services, adult day care services, non-emergency transportation, home modification, exercise, etc. Procedures may be performed by a healthcare professional, a service provider, a friend or relative or in some cases by themselves. | Procedure |
UKCore-PractitionerRole | This profile allows exchange of a specific set of roles, specialties and services that a practitioner may perform at an organisation for a period of time. | PractitionerRole |
UKCore-Practitioner | This profile allows exchange of information about all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities, is used for attribution of activities and responsibilities to these individuals. | Practitioner |
UKCore-Patient | This profile allows exchange of demographics and other administrative information about an individual receiving care or other health-related services. | Patient |
UKCore-OrganizationAffiliation | The purpose of this profile is to hold information about relationships between different organizations. | OrganizationAffiliation |
UKCore-Organization | This profile allows exchange of a formally or informally recognised grouping of people or organisations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc. | Organization |
UKCore-OperationOutcome | The purpose of this profile is to provide detailed information about the outcome of an attempted system operation. Operation outcomes are sets of error, warning and information messages provided as a direct system response, or part of one, and provide information about the outcome of the operation. | OperationOutcome |
UKCore-Observation-VitalSigns-RespirationRate | To provide implementers with additional support when implementing respiratory rate monitoring and to provide a consistent structure to how the data is presented. The clinical observations within scope of this profile include all patient respiration: Unaided, Oxygen Concentrators, Nasal Cannula, CPAP Devices, Endotracheal Tube, and Mechanical Ventilator. | Observation |
UKCore-Observation-VitalSigns-OxygenSaturation | To provide implementers with additional support when implementing blood oxygen saturation monitoring and to provide a consistent structure to how the data is presented. | Observation |
UKCore-Observation-VitalSigns-HeartRate | To provide implementers with additional support when implementing heart rate monitoring and to provide a consistent structure to how the data is presented. | Observation |
UKCore-Observation-VitalSigns-HeadCircumference | To provide implementers with additional support when implementing measuring of head circumference and to provide a consistent structure to how the data is presented. | Observation |
UKCore-Observation-VitalSigns-BodyWeight | To provide implementers with additional support when implementing weight measuring and to provide a consistent structure to how the data is presented. | Observation |
UKCore-Observation-VitalSigns-BodyTemperature | To provide implementers with additional support when implementing measuring body temperature and to provide a consistent structure to how the data is presented. | Observation |
UKCore-Observation-VitalSigns-BodyHeight | To provide implementers with additional support when implementing length / height measuring and to provide a consistent structure to how the data is presented. | Observation |
UKCore-Observation-VitalSigns-BMI | To provide implementers with additional support when implementing measuring and recording body mass index and to provide a consistent structure to how the data is presented. | Observation |
UKCore-Observation-VitalSigns-BloodPressure | To provide implementers with additional support when implementing blood pressure monitoring and to provide a consistent structure to how the data is presented. | Observation |
UKCore-Observation-VitalSigns | This profile allows exchange of internationally FHIR compliant vital signs information based on measurements and simple assertions made about an individual. Where a more constrained derived profile exists, it should be used instead of this profile. | Observation |
UKCore-Observation-TobaccoConsumption | To provide implementers with additional support when implementing gathering and recording the patient's tobacco consumption per day / week. This profile should not be used to record the vaping habits of a patient. | Observation |
UKCore-Observation-Lab | To provide the minimum expectations for each individual laboratory test. | Observation |
UKCore-Observation-InspiredOxygen | To provide implementers with additional support when implementing recording of whether a patient is breathing on their own, or is on oxygen. The clinical observations within scope of this profile include all patient respiration: Unaided, Oxygen Concentrators, Nasal Cannula, CPAP Devices, Endotracheal Tube, and Mechanical Ventilator. | Observation |
UKCore-Observation-Group-Lab | This profile allows the creation of a report for results borne from a single request panel, or profile, e.g. Full Blood Count, Lipid Profile, etc. allowing the results to be logically ordered according to the given profile and/or best practice guidelines. | Observation |
UKCore-Observation-EarlyWarningTotalScore | To provide implementers with additional support when implementing an Early Warning Score system such as NEWS2 or NPEWS and to provide a consistent structure to how the data is presented. | Observation |
UKCore-Observation-BloodGlucose | To provide implementers with additional support when implementing recording of a patient's blood glucose levels. | Observation |
UKCore-Observation-AverageBloodPressure | To provide implementers with additional support when implementing average blood pressure monitoring over a specific time period and to provide a consistent structure to how the data is presented. | Observation |
UKCore-Observation-AlcoholConsumption | To provide implementers with additional support when implementing gathering and recording the patient's alcohol consumption per day / week | Observation |
UKCore-Observation-ACVPU | To provide implementers with additional support when implementing gathering of a patients ACVPU (level of consciousness) status, and to provide a consistent structure to how the data is presented. | Observation |
UKCore-Observation | This profile allows exchange of information of Measurements and simple assertions made about an individual, device or other subject. Note: this profile SHALL NOT be used where a more specific UK Core profile exists. | Observation |
UKCore-MessageHeader | This profile carries the header data for a message exchange that is either requesting or responding to an action. | MessageHeader |
UKCore-MedicationStatement | This profile allows exchange of a record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the individual may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the individual, significant other (such as a family member or spouse), or a clinician. | MedicationStatement |
UKCore-MedicationRequest | An order or request for both supply of the medication and the instructions for administration of the medication to an individual. This profile covers inpatient medication orders as well as community orders (whether filled by the prescriber or by a pharmacy). It also includes orders for over-the-counter medications (e.g. Aspirin), total parenteral nutrition and diet/ vitamin supplements, and may be used to support the order of medication-related devices. It is not intended for use in prescribing particular diets, or for ordering non-medication-related items (eyeglasses, supplies, etc). | MedicationRequest |
UKCore-MedicationDispense | This profile covers the supply of medications to a patient. Examples include dispensing and pick-up from an outpatient or community pharmacy, dispensing patient-specific medications from inpatient pharmacy to ward, as well as issuing a single dose from ward stock to a patient for consumption. The medication dispense is the result of a pharmacy system responding to a medication order. | MedicationDispense |
UKCore-MedicationAdministration | The purpose of this profile is to describe the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet, or it may be a long-running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. | MedicationAdministration |
UKCore-Medication | This profile is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. | Medication |
UKCore-Location | This profile can be used to exchange details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. A location includes both incidental locations (a place which is used for healthcare without prior designation or authorisation) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages. | Location |
UKCore-List | This profile allows exchange of a flat, possibly ordered collection of records. The list profile can be used in many places, including allergies, medications, alerts, family history, medical history, etc. This list profile can be used to support individual-specific clinical lists as well as lists that manage workflows such as tracking patients, managing teaching cases, etc. The list profile supports lists that are homogeneous – consisting of only one type of resource (e.g. Allergy lists) as well as heterogeneous – containing a variety of resources (e.g. a problem list including Condition, AllergyIntolerance, Procedure, etc.). | List |
UKCore-Immunization | This profile is intended to cover the recording of current and historical administration of vaccines to individuals across all healthcare disciplines in all care settings and all regions. This profile does not support the administration of non-vaccine agents, even those that may have or claim to have immunological effects. While the terms "immunisation" and "vaccination" are not clinically identical, for the purposes of the FHIR profile, the terms are used synonymously. | Immunization |
UKCore-ImagingStudy | This profile allows exchange of the content produced in a DICOM imaging study. | ImagingStudy |
UKCore-HealthcareService | 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. | HealthcareService |
UKCore-Flag | A flag is a warning or notification of some sort presented to the user - who may be a clinician or some other person involve in patient care. It usually represents something of sufficient significance to warrant a special display of some sort - rather than just a note in the resource. A flag has a subject representing the resource that will trigger its display. This subject can be of different types, as described in the examples below:
| Flag |
UKCore-FamilyMemberHistory | This profile allows exchange of information about health events and conditions for a person related to the patient relevant in the context of care. | FamilyMemberHistory |
UKCore-EpisodeOfCare | This profile allows exchange of information about an association between a patient and an organisation / healthcare providers during which time encounters may occur. The managing organisation assumes a level of responsibility for the individual during this time. Relationship to EncounterThe EpisodeOfCare Resource contains information about an association of a Patient with a Healthcare Provider for a period of time under which related healthcare activities may occur. In many cases, this represents a period of time where the Healthcare Provider has some level of responsibility for the care of the patient regarding a specific condition or problem, even if not currently participating in an encounter. These resources are typically known in existing systems as:
| EpisodeOfCare |
UKCore-Encounter | This profile allows exchange of information about an interaction between an individual and healthcare providers for the purpose of providing healthcare services or assessing the health status of an individual. | Encounter |
UKCore-DocumentReference | This profile supports a reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any serialised object with a mime-type, so includes formal patient centric documents (CDA), clinical notes, scanned paper, and non-patient specific documents like policy text. | DocumentReference |
UKCore-DiagnosticReport-Lab | To provide implementers with additional support when implementing test result data and to provide a consistent structure to how the data is presented. | DiagnosticReport |
UKCore-DiagnosticReport | This profile allows exchange of the findings and interpretation of diagnostic tests performed on individuals, groups of individuals, devices and locations and/or specimens derived from these. The report includes clinical context such as requesting and provider information and some mix of atomic results, images, textual and coded interpretations and formatted representation of diagnostic reports. Note: this profile SHALL NOT be used where a more specific UK Core profile exists. | DiagnosticReport |
UKCore-Device-BloodPressure | The purpose of this profile is to hold information about a device used to measure blood pressure, such as the type or sphygmomanometer, and cuff size used. | Device |
UKCore-Device | The purpose of this profile is to hold information about a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. It is referenced by other resources for recording which device performed an action such as a procedure or an observation, referenced when prescribing and dispensing devices for patient use or for ordering supplies, and used to record and transmit Unique Device Identifier (UDI) information about a device such as a patient's implant. | Device |
UKCore-Consent | The purpose of this profile is to be used to express a Consent regarding Healthcare. There are four anticipated uses for the Consent Resource, all of which are written or verbal agreements by a healthcare consumer [grantor] or a personal representative, made to an authorised entity [grantee] concerning authorised or restricted actions with any limitations on purpose of use, and handling instructions to which the authorised entity SHALL comply:
| Consent |
UKCore-Condition | This profile allows recording of detailed information about a condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. The condition could be a point in time diagnosis in the context of an encounter, it could be an item on the practitioner’s problem list, or it could be a concern that doesn’t exist on the practitioner’s problem list. Often, a condition is about a clinician's assessment and assertion of a particular aspect of an individual's state of health. It can be used to record information about a disease/illness identified from the application of clinical reasoning over the pathologic and pathophysiologic findings (diagnosis), or identification of health issues/situations that a practitioner considers harmful, potentially harmful and may be investigated and managed (problem), or other health issue/situation that may require ongoing monitoring and/or management (health issue/concern). | Condition |
UKCore-Composition | This profile allows a record of a set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition SHALL be the first entry in a Bundle where | Composition |
UKCore-Communication | The purpose of this profile is to allow a record of a communication even if it is planned or has failed. A communication is a conveyance of information from one entity, a sender, to another entity, a receiver. The sender and receivers may be patients, practitioners, related persons, organisations, or devices. Communication use cases include:
| Communication |
UKCore-CareTeam | This profile allows recording of the care team which includes all the people and organisations who plan to participate in the coordination and delivery of care for an individual. This is not limited to practitioners, but may include other caregivers such as family members, guardians, the individual themselves, or others. The care team, depending on where used, may include care team members specific to a particular care plan, an episode, an encounter, or may reflect all known team members across these perspectives. An individual's care team can be dynamic over time, such that there can be transience of team members, such as a rehabilitation team. | CareTeam |
UKCore-CarePlan | This profile allows recording of care plans which are used in many areas of healthcare with a variety of scopes. They can be as simple as a general practitioner keeping track of when an individual is next due for a tetanus immunisation through to a detailed plan for an oncology patient covering diet, chemotherapy, radiation, lab work and counselling with detailed timing relationships, pre-conditions and goals. | CarePlan |
UKCore-Bundle | This profile allows a collection of resources to be exchanged as one bundle. | Bundle |
UKCore-BodyStructure | This profile allows exchange of information of body structure details, such as site, laterality, location. | BodyStructure |
UKCore-AuditEvent | The purpose of this profile is to hold information about an event made to maintain a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. | AuditEvent |
UKCore-Appointment | 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. | Appointment |
UKCore-AllergyIntolerance | This profile allows a record of a clinical assessment of an allergy or intolerance; a propensity, or a potential risk to an individual, to have an adverse reaction on future exposure to the specified substance, or class of substance. Where a propensity is identified, to record information or evidence about a reaction event that is characterised by any harmful or undesirable physiological response that is specific to the individual and triggered by exposure of an individual to the identified substance or class of substance. Substances include but are not limited to a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings. This resource is used to record physical conditions. It SHALL NOT be used to record preferences for or against types of treatment, for example on religious grounds. For such use cases consider the use of the FHIR Consent resource. | AllergyIntolerance |