Implementation guide for interoperable medicines

This guidance is under active development by NHS England and content may be added or updated on a regular basis.

Profile: AllergyIntolerance

Under discussion with the Digital Medicines Community of Interest group...

Additional guidance based on the UKCore AllergyIntolerance resource, for which the tree view of the profiled resource is shown below.

In this context, used to share patient allergy records with an Automated Dispensing Cabinet (ADC) system. These records may come from either the Trust EPMA or PAS systems.

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
evidenceC0..*Extension(Reference(DiagnosticReport))
modifierExtension?! C0..*Extension
identifierΣ0..*Identifier
id0..1string
allergyIntoleranceEndC0..1Extension(Complex)
codingΣ0..*Coding
textΣ0..1string
verificationStatusS Σ ?! C0..1CodeableConceptBinding
typeΣ0..1codeBinding
categoryΣ0..*codeBinding
criticalityΣ0..1codeBinding
codeS Σ1..1CodeableConceptBinding
patientS Σ C1..1Reference(Patient)
encounterC0..1Reference(Encounter)
onsetAgeAge
onsetDateTimedateTime
onsetPeriodPeriod
onsetRangeRange
onsetStringstring
recordedDate0..1dateTime
recorderC0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)
asserterΣ C0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)
lastOccurrence0..1dateTime
note0..*Annotation
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
substance0..1CodeableConceptBinding
manifestation1..*CodeableConcept
description0..1string
onset0..1dateTime
severityS0..1codeBinding
exposureRoute0..1CodeableConceptBinding
note0..*Annotation

Note: Where the cardinality in the table below states "required" this relates to the element being part of the UKCore Minimum Viable Content.

Element Cardinality Guidance
clinicalStatus Required Include active allergy records.
Exclude inactive and resolved allergy records.
An edge case will be where where the ADC has been notified of an active allergy but during the episode of care the allergy has been verified as either inactive or resolved. The ADC should be notified that the clinical status has changed and cleared from the ADC console display.
verificationStatus Required Can be omitted if this data is not available within the provider system. In the absence of a verification status, the allergy should be assumed to be confirmed.
code Mandatory See the preferred UKCore binding for the allergy code. Source systems that hold allergy records should be striving to record allergies against dm+d VTM, VMP or AMP concepts or SNOMED substance concepts. The UKCore binding supports legacy coding systems and free-text records.
patient Mandatory Reference to a Patient resource. Likely that two identifiers will be used; the NHS number (when known) and the local MRN (hospital number).
reaction Required ADCs may vary for if they show reaction data to end users through the ADC console. If not supported by the ADC this element may be omitted.

Examples

Allergy recorded using a coded dm+d concept

{
    "resourceType": "AllergyIntolerance",
    "id": "UKCore-AllergyIntolerance-Amoxicillin-Example",
    "clinicalStatus": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                "code": "active",
                "display": "Active"
            }
        ]
    },
    "code": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "774586009",
                "display": "Amoxicillin"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}

Allergy recorded using a SNOMED substance code

{
    "resourceType": "AllergyIntolerance",
    "id": "UKCore-AllergyIntolerance-Shrimp-Example",
    "clinicalStatus": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                "code": "active",
                "display": "Active"
            }
        ]
    },
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "42048111000001105",
                "display": "Shrimp allergen extract (substance)"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}

Allergy recorded uncoded as text

{
    "resourceType": "AllergyIntolerance",
    "id": "UKCore-AllergyIntolerance-Latex-Example",
    "clinicalStatus": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                "code": "active",
                "display": "Active"
            }
        ]
    },
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "196471000000108",
                "display": "Transfer-degraded non-drug allergy (record artifact)"
            }
        ],
        "text": "Latex"
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}

Allergy recorded using an unrecognised or legacy coding system

{
    "resourceType": "AllergyIntolerance",
    "id": "UKCore-AllergyIntolerance-Septrin-Example",
    "clinicalStatus": {
        "coding":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                "code": "active",
                "display": "Active"
            }
        ]
    },
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "196461000000101",
                "display": "Transfer-degraded drug allergy (record artifact)"
            }
        ],
        "text": "9339101000001105 | Septrin"
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    }
}


back to top