Important: All content in this FHIR Implementation Guide is under development

DataStandardsWales-AllergyList

The List resource is a curated collection of resources. The Allergy List profile is intended to provide a snapshot view of a patient's allergies.

The DataStandardsWales-AllergyList profile is derived from the UK Core List Profile. It defines additional rules for use within health and care organisations in Wales.

Formal Views of Profile Content

careSettingTypeI0..1Extension(CodeableConcept)
listWarningCodeI0..*Extension(code)
relatedProblemHeaderI0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusS Σ ?!1..1codeBinding
modeS Σ ?!1..1codeBinding
titleΣ0..1string
codeS Σ0..1CodeableConceptBindingFixed Value
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
dateΣ0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
orderedBy0..1CodeableConceptBinding
authorStringstring
authorReferenceReference(UK Core Patient | UK Core Organization | UK Core Practitioner | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
flag0..1CodeableConcept
deleted?! I0..1boolean
date0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding
careSettingTypeI0..1Extension(CodeableConcept)
listWarningCodeI0..*Extension(code)
relatedProblemHeaderI0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusS Σ ?!1..1codeBinding
modeS Σ ?!1..1codeBinding
titleΣ0..1string
codeS Σ0..1CodeableConceptBindingFixed Value
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
dateΣ0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
orderedBy0..1CodeableConceptBinding
authorStringstring
authorReferenceReference(UK Core Patient | UK Core Organization | UK Core Practitioner | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
flag0..1CodeableConcept
deleted?! I0..1boolean
date0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding
careSettingTypeI0..1Extension(CodeableConcept)
listWarningCodeI0..*Extension(code)
relatedProblemHeaderI0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusS Σ ?!1..1codeBinding
modeS Σ ?!1..1codeBinding
titleΣ0..1string
codeS Σ0..1CodeableConceptBindingFixed Value
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
dateΣ0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
orderedBy0..1CodeableConceptBinding
authorStringstring
authorReferenceReference(UK Core Patient | UK Core Organization | UK Core Practitioner | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
flag0..1CodeableConcept
deleted?! I0..1boolean
date0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding

Mandatory and Must Support Data Elements

When an element is mandatory (min=1), the data is expected to always be present. Elements marked with an S must be supported by both producing and receiving systems and SHOULD be populated if the data exists.

Each Allergy List must have:

  1. A status
  2. A mode
  3. A fixed SNOMED CT code of value of 886921000000105|'Allergies and adverse reactions'
  4. A subject (patient)

Each Allergy list must support:

  1. An encounter
  2. A source to indicate who defined the list contents

Implementation Guidance

  • The mode is always expected to indicate the list represents a snapshot of an allergy information that is potentially derived from another source.

  • The List.code field SHALL be snomed coded to 'allergies and adverse reactions'.

  • The resource SHALL include a reference to the subject (patient).

Example Allergy Lists

The following examplesare provided within this guide: Example List - with Allergies, Example List - empty list, Example List - with no known Allergies.

Mandatory Search Parameters

For systems that provide a FHIR API for allergies, the following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching using a combination of the code and patient and search parameters:
    GET [base]/List?code={http://snomed.info/sct|}886921000000105&patient={system|}[code]
    
    Example:
    1. GET [base]/List?code=http://snomed.info/sct|886921000000105&patient=23
    2. GET [base]/List?code=http://snomed.info/sct|886921000000105&patient.identifier=https://fhir.nhs.uk/Id/nhs-number|1192335566

      Implementation Notes: Fetches a bundle of allergy lists for the specified code and patient (how to search by token and how to search by reference).