HL7 FHIR® UK Core
4.0.0 - CI Build
HL7 FHIR® UK Core - Local Development build (v4.0.0). See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These define constraints on FHIR resources that need to be complied with by conformant implementations
| UKCoreDocumentReference | Defines the UK Core constraints and extensions on the DocumentReference resource. |
| UKCoreServiceRequest | Defines the UK Core constraints and extensions on the ServiceRequest resource for the minimal set of data to query and retrieve service request information. |
| UKCoreProcedure | Defines the UK Core constraints and extensions on the Procedure resource for the minimal set of data to query and retrieve the patient’s procedure information. |
| UKCoreLocation | Defines the UK Core constraints and extensions on the Location resource for the minimal set of data to query and retrieve location information. |
| UKCorePractitioner | Defines the UK Core constraints and extensions on the Practitioner resource for the minimal set of data to query and retrieve practitioner information. |
| UKCoreImmunization | Defines the UK Core constraints and extensions on the Immunization resource for the minimal set of data to query and retrieve an individual’s immunisation information. |
| UKCoreCareTeam | Defines the UK Core constraints and extensions on the CareTeam resource for the minimal set of data to query and retrieve an individual’s care team. |
| UKCoreCondition | Defines the UK Core constraints and extensions on the Condition resource for the minimal set of data to query and retrieve problems and health concerns information. |
| UKCoreList | Defines the UK Core constraints and extensions on the List resource for the minimal set of data to query and retrieve a list of information. |
| UKCoreMedicationRequest | Defines the UK Core constraints and extensions on the MedicationRequest resource for the minimal set of data to query and retrieve prescription information. |
| UKCoreEncounter | Defines the UK Core constraints and extensions on the Encounter resource for the minimal set of data to query and retrieve encounter information. |
| UKCoreObservation | Defines the UK Core constraints and extensions on the observation resource for the minimal set of data to query and retrieve generic observation information. |
| UKCorePractitionerRole | Defines the UK Core constraints and extensions on the PractitionerRole resource for the minimal set of data to query and retrieve practitioner role information. |
| UKCorePatient | Defines the UK Core constraints and extensions on the Patient resource for the minimal set of data to query and retrieve an individual’s demographic information. |
| UKCoreMedicationStatement | Defines the UK Core constraints and extensions on the MedicationStatement resource for the minimal set of data to query and retrieve medication statement information. |
| UKCoreMedication | Defines the UK Core constraints and extensions on the Medication resource for the minimal set of data to query and retrieve medication information. |
| UKCoreAllergyIntolerance | Defines the UK Core constraints and extensions on the AllergyIntolerance resource for the minimal set of data to query and retrieve allergy information. |
| UKCoreOrganization | Defines the UK Core constraints and extensions on the Organization resource for the minimal set of data to query and retrieve organisation information. |
| UKCoreRelatedPerson | Defines the UK Core constraints and extensions on the RelatedPerson resource for the minimal set of data to query and retrieve related person information. |
| UKCoreSpecimen | Defines the UK Core constraints and extensions on the Specimen resource for the minimal set of data to query and retrieve specimen information. |
| UKCoreCarePlan | Defines the UK Core constraints and extensions on the CarePlan resource for the minimal set of data to query and retrieve a patient’s Care Plan. |
| UKCoreDiagnosticReport | Defines the UK Core constraints and extensions on the DiagnosticReport resource for the minimal set of data to query and retrieve diagnostic report information. |
| UKCoreMedicationDispense | Defines the UK Core constraints and extensions on the MedicationDispense resource for the minimal set of data to query and retrieve dispensed medication information. |
These define constraints on FHIR data types that need to be complied with by conformant implementations
| ExtensionUKCoreAdmissionMethod | An extension to support the method by which an individual was admitted into hospital. |
| ExtensionUKCoreAddressKey | To support recording of Address Keys within addresses |
| ExtensionUKCoreEmergencyCareDischargeStatus | An extension to support the status of an individual on discharge from an Emergency Care Department. |
| ExtensionUKCoreMainLocation | An extension to support a reference to the main location for an organisation. |
| ExtensionUKCoreCopyCorrespondenceIndicator | To indicate correspondence must be copied to the contact or RelatedPerson |
| ExtensionUKCoreMedicationStatementLastIssueDate | |
| ExtensionUKCoreParentPresent | This Extension resource is constrained to indicate whether a parent was present at the Immunization. |
| ExtensionUKCoreDischargeMethod | An extension to support the method of discharge from a hospital. |
| ExtensionUKCoreContactRank | Extension UK Core ContactRank |
| ExtensionUKCoreMedicationDosageLastChanged | |
| ExtensionUKCoreVaccinationProcedure | An extension to hold an immunization procedure code. |
| ExtensionUKCoreContactPreference | UKCore Contact preferences for Patient, Patient.contact or RelatedPerson |
| ExtensionUKCoreAnaestheticIssues | An extension to support recording of details of any adverse reaction to any anaesthetic agents including local anaesthesia and problematic intubation, transfusion reaction, etc. |
| ExtensionUKCoreEffectivePeriod | To record effective start and end dates |
| ExtensionUKCoreEncounterTransport | An extension to support the transport used by the individual who is the subject of an encounter. |
| ExtensionUKCoreMedicationChangeSummary | |
| ExtensionUKCoreReligiousAffiliation | An extension to support the religious affiliation of an individual. |
| ExtensionUKCoreMedicationRepeatInformation | Indicates the specific repeat information of a medication item. |
| ExtensionUKCoreAllergyIntoleranceEnd | An extension to support the date and/or reason that the allergy or intolerance was no longer valid. |
| ExtensionUKCoreEvidence | An extension to support a reference to results of investigations that confirmed the certainty of the diagnosis. Examples might include results of skin prick allergy tests. |
| ExtensionUKCoreListWarningCode | An extension to support warnings that a list may be incomplete as data has been excluded due to confidentiality or may be missing due to data being in transit. |
| ExtensionUKCorePrescriptionType | To record the type of prescription. |
| ExtensionUKCoreResidentialStatus | An extension to support the residential status of an individual. |
| ExtensionUKCoreMedicationQuantityText | This Extension resource is constrained to support the textual representation of a medication structured quantity. |
| ExtensionUKCoreDeathNotificationStatus | An extension to support death notification for an individual. For example, as held on Personal Demographics Service (PDS). |
| ExtensionUKCoreOutcomeOfAttendance | An extension to support the outcome of an Outpatient attendance. |
| ExtensionUKCoreTreatmentCategory | An extension to support an individual’s treatment category. |
| ExtensionUKCoreNominatedPharmacy | An extension to support an individual’s nominated pharmacy. |
| ExtensionUKCoreNHSCommunication | An extension to support the communication preferences for an individual. |
| ExtensionUKCoreNHSNumberVerificationStatus | An extension to support the verification status of an NHS number. |
| ExtensionUKCoreEthnicCategory | An extension to support the ethnic category of an individual. |
| ExtensionUKCoreClinicalSetting | An extension to support the clinical setting associated with a list. |
| ExtensionUKCoreConditionEpisode | An extension to support the episodicity status of a condition. |
| ExtensionUKCoreMedicationPrescribingAgency |
These define sets of codes used by systems conforming with this implementation guide
| UKCoreBodySite | A code from the SNOMED Clinical Terminology UK with the expression (<<442083009 |anatomical or acquired body structure|). |
| UKCoreConditionCategory | A ValueSet to identify the category of a condition. |
| UKCoreConditionEpisodicity | A ValueSet to identify the episodicity of a condition. |
| UKCoreLanguageAbilityMode | A ValueSet that identifies the mode the patient can communicate in, representing the method of expression of the language. |
| UKCoreVaccinationProcedure | A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure. |
| NHSDataModelandDictionaryDischargeMethod | The method of discharge from a Hospital Provider Spell. |
| UKCoreProcedureCode | A code from the SNOMED Clinical Terminology UK with the expression (<<71388002 |Procedure|<<129125009 |Procedure with explicit context|). |
| NHSDataModelandDictionaryPersonMaritalStatusCode | An indicator to identify the legal marital status of a Person. |
| UKCorePreferredWrittenCommunicationFormat | A ValueSet to identify the preferred written communication format of a Patient, contact or RelatedPerson. |
| UKCoreAllergyManifestation | A code from the SNOMED Clinical Terminology UK hierarchy with concept id '404684003' to record an allergy manifestation or a value from the HL7 FHIR nullFlavors code system. |
| UKCoreReasonImmunizationNotAdministered | A ValueSet to identify the reason why an immunization was not administered. |
| UKCoreListCode | A ValueSet to identify the purpose of a list. |
| UKCoreNHSNumberVerificationStatus | A ValueSet that identifies the trace status of the NHS number. The CodeSystem is comprised of codes from the NHS Data Model and Dictionary: NHS Number Status Indicator Code. |
| UKCoreMedicationDosageRoute | A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration. Any code from the SNOMED CT UK 'NHS e-Prescribing route of administration subset' with subset original id 30201000001137; the corresponding SNOMED CT UK Refset FSN is 'ePrescribing route of administration simple reference set (foundation metadata concept)' with Refset Id 999000051000001100. |
| UKCoreMedicationForm | A code from the SNOMED Clinical Terminology UK coding system that describes a medication dose form. |
| NHSDataModelandDictionaryDischargeDestination | The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. |
| UKCoreListEmptyReasonCode | A ValueSet to identify the reason a list may be empty. |
| UKCoreDocumentType | A code from the SNOMED Clinical Terminology UK coding system that describes a clinical document type. |
| UKCoreResidentialStatus | A ValueSet that identifies the residential status of a patient. |
| UKCoreHumanLanguage | A ValueSet that identifies the language used by a person. |
| UKCoreAllergyCertainty | A code from the SNOMED Clinical Terminology UK coding system that describes the certainty of an allergy. |
| NHSDataModelandDictionaryAdmissionMethod | The method of admission to a Hospital Provider Spell. |
| NHSDataModelandDictionarySourceOfAdmission | The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. |
| UKCoreSpecimenType | A code from the SNOMED Clinical Terminology UK coding system to record a specimen type. |
| UKCoreEthnicCategory | A ValueSet to identify the ethnicity of a Person, as specified by the Person. This vocabulary describes a person's ethnic category, it is an extension of the Ethnic Category Code described in the NHS Data Model and Dictionary. |
| UKCoreMedicationSupplyType | A ValueSet to identify the type of medication supply. |
| UKCoreTreatmentCategory | A ValueSet that identifies the treatment category for a patient. |
| UKCorePrescriptionType | A ValueSet to identify the type of prescription. |
| UKCoreListWarningCode | A ValueSet to identify the reason a list may be incomplete. |
| UKCoreConditionCode | A code from the SNOMED Clinical Terminology UK with the expression (< 404684003 |Clinical finding| OR < 413350009 |Finding with explicit context| OR < 272379006 |Event|). |
| UKCoreDeathNotificationStatus | A ValueSet to identify the type of death notice as held on Personal Demographics Service (PDS). |
| NHSDataModelandDictionaryPersonStatedGenderCode | The gender of a Person. Person Stated Gender Code is self declared or inferred by observation for those unable to declare their Person Stated Gender. |
| UKCoreConditionEpisode | A code from the SNOMED Clinical Terminology UK coding system that describes the episodicity of a Condition. |
| UKCoreEncounterType | A code from the SNOMED Clinical Terminology UK coding system that describes an encounter between a care professional and the patient (or patient's record). |
| UKCoreFindingCode | A code from the SNOMED Clinical Terminology UK coding system to record a finding code. |
| UKCoreObservationType | A code from the SNOMED Clinical Terminology UK with the expression (<<363787002 | Observable entity|). |
| UKCoreReportCodeSnCT | A code from the SNOMED Clinical Terminology UK coding system that describes a diagnostic report. |
| UKCoreAllergyExposureRoute | A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration. Any code from the SNOMED CT UK 'NHS e-Prescribing route of administration subset' with subset original id 30201000001137; the corresponding SNOMED CT UK Refset FSN is 'ePrescribing route of administration simple reference set (foundation metadata concept)' with Refset Id 999000051000001100. |
| UKCoreAllergyCode | A code from the SNOMED Clinical Terminology UK with the expression (<105590001 |Substance OR <373873005 |Pharmaceutical / biologic product| OR <716186003 |No known allergy| OR 196461000000101 |Transfer-degraded drug allergy| OR 196471000000108 |Transfer-degraded non-drug allergy), or a code from the v3 Code System NullFlavor specifying why a valid value is not present. |
| UKCoreCareSettingType | A code from the SNOMED Clinical Terminology UK coding system that describes a correspondence care setting type. Any code from the SNOMED CT UK 'Correspondence Care setting type' subset with subset original id 43971000000130; the corresponding SNOMED CT UK Refset fully specified name is 'Correspondence care setting type simple reference set (foundation metadata concept)' with Refset Id 999000381000000107 |
| UKCoreEmergencyCareDischargeStatus | A code from the SNOMED Clinical Terminology UK coding system that describes the status of the Patient on discharge from an Emergency Care Department. Captures whether treatment took place within the ED, if the patient was streamed to another service or if the patient left before treatment was complete. Any code from the SNOMED CT UK 'Emergency care discharge status' subset with subset original id 75041000000135; the corresponding SNOMED CT UK Refset fully specified name is 'Emergency care discharge status simple reference set (foundation metadata concept)' with Refset Id 999003021000000104. |
| UKCoreAllergySeverity | A code from the SNOMED Clinical Terminology UK coding system that describes the severity of an allergy. |
| UKCoreMedicationCode | A code from the SNOMED Clinical Terminology UK coding system to identify the medication. |
| UKCoreAddressKeyType | A ValueSet to identify the type of Address Key recorded. |
| UKCoreLanguageAbilityProficiency | A ValueSet to identify the level of proficiency in communicating a language. |
| UKCoreSpecimenBodySite | A code from the SNOMED Clinical Terminology UK coding system to record a specimen body site. |
| UKCoreSDSJobRoleName | A ValueSet that identifies the job role associated with the person on the smart card. This consists of a set of Role Based Access Control (RBAC) codes. This code list is externally maintained. |
| UKCoreImmunizationExplanationReason | A code from the SNOMED Clinical Terminology UK coding system that represents the clinical indication or reason for administering the vaccine. |
| UKCorePreferredContactMethod | A ValueSet to identify the preferred Contact Method of a Patient, contact or RelatedPerson. |
| NHSDataModelandDictionaryOutcomeOfAttendance | This records the outcome of an Out-Patient Attendance Consultant. |
| UKCoreVaccineCode | A code from the SNOMED Clinical Terminology UK coding system to record a vaccine or a null flavor value. |
| UKCoreReligiousAffiliation | A code from the SNOMED Clinical Terminology UK coding system that describes the religious or other belief system affiliation of a person. Any code from the SNOMED CT UK 'Religious Affiliation SnCT' subset with subset original id 10791000000130; the corresponding SNOMED CT UK Refset fully specified name is 'Religious or other belief system affiliation simple reference set (foundation metadata concept)' with Refset Id 999000531000000100. |
These define new code systems used by systems conforming with this implementation guide
| UKCoreListWarningCode | A CodeSystem to identify the reason a list may be incomplete. |
| UKCorePreferredWrittenCommunicationFormat | A CodeSystem to identify the preferred written communication format of a Patient, contact or RelatedPerson. |
| NHSDataModelandDictionaryPersonStatedGenderCode | The gender of a Person. Person Stated Gender Code is self declared or inferred by observation for those unable to declare their Person Stated Gender. |
| NHSDataModelandDictionarySourceOfAdmission | The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. |
| NHSDataModelandDictionaryDischargeDestination | The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. |
| UKCoreMedicationSupplyType | A CodeSystem to identify the type of medication supply. |
| UKCoreLanguageAbilityProficiency | A CodeSystem to identify the level of proficiency in communicating a language. |
| NHSDataModelandDictionaryAdmissionMethod | The method of admission to a Hospital Provider Spell. |
| UKCoreDeathNotificationStatus | A CodeSystem to identify the type of death notice as held on Personal Demographics Service (PDS). |
| NHSDataModelandDictionaryPersonMaritalStatusCode | An indicator to identify the legal marital status of a Person. |
| NHSDataModelandDictionaryDischargeMethod | The method of discharge from a Hospital Provider Spell. |
| UKCoreResidentialStatus | A CodeSystem that identifies the residential status of a patient. |
| UKCoreSDSJobRoleName | A CodeSystem that identifies the job role associated with the person on the smart card. This consists of a set of Role Based Access Control (RBAC) codes. This code list is externally maintained. |
| UKCoreAdditionalRelatedPersonRole | A CodeSystem to identify the additional relationship roles for RelatedPerson resources. |
| UKCoreConditionEpisodicity | A CodeSystem to identify the episodicity of a condition. |
| UKCoreListEmptyReasonCode | A CodeSystem to identify the reason a list may be empty. |
| UKCoreNHSNumberVerificationStatus | A CodeSystem that identifies the trace status of the NHS number. This CodeSystem is comprised of codes from the NHS Data Model and Dictionary: NHS Number Status Indicator Code. |
| UKCorePreferredContactMethod | A CodeSystem to identify the preferred Contact Method of a Patient, contact or RelatedPerson. |
| UKCoreTreatmentCategory | A CodeSystem that identifies the treatment category for a patient. |
| UKCoreAddressKeyType | A CodeSystem to identify the type of Address Key recorded. |
| UKCoreEthnicCategory | A CodeSystem to identify the ethnicity of a Person, as specified by the Person. This vocabulary describes a persons ethnic category, it is an extension of the Ethnic Category Code described in the NHS Data Model and Dictionary. |
| UKCoreLanguageAbilityMode | A CodeSystem that identifies the mode the patient can communicate in, representing the method of expression of the language. |
| UKCoreHumanLanguage | A CodeSystem that identifies the language used by a person. |
| UKCoreConsentUpdateMode | A CodeSystem to identify the whether this is the original or an amended resource. |
| UKCorePrescriptionType | A CodeSystem to identify the type of prescription. |
| NHSDataModelandDictionaryOutcomeofAttendance | This records the outcome of an Out-Patient Attendance Consultant. |
These define transformations to convert between codes by systems conforming with this implementation guide
| ConceptMapUKCoreAllergySeverity | A Concept Map from the HL7 FHIR ValueSet Reaction Event Severity to Allergy Severity to aid interpretation. |
| ConceptMapUKCoreAdministrativeGender | A Concept Map from ValueSet Administrative Gender to NHS Data Dictionary Person Stated Gender to aid interpretation. |
| ConceptMapUKCoreConditionEpisodicity | A Concept Map from ValueSet Condition Episodicity Severity to equivalent Snomed CT codes |
| ConceptMapUKCoreMaritalStatus | A Concept Map from ValueSet Marital Status to NHS Data Dictionary Person Marital Status to aid interpretation. |
| ConceptMapUKCoreAllergyVerificationStatus | A Concept Map from the HL7 FHIR ValueSet Allergy Verification Status to Allergy Certainity to aid interpretation. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like