AllergyIntolerance

ResourceClinical · SummaryTrial useMaturity 3

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

16 of 16 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	External ids for this item
clinicalStatus?!Σ	0..1	CodeableConcept	active | inactive | resolvedBinding (required): allergyintolerance-clinical
verificationStatus?!Σ	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-errorBinding (required): allergyintolerance-verification
typeΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known)Binding (required): allergy-intolerance-type
categoryΣ	0..*	code	food | medication | environment | biologicBinding (required): allergy-intolerance-category
criticalityΣ	0..1	code	low | high | unable-to-assessBinding (required): allergy-intolerance-criticality
codeΣ	0..1	CodeableConcept	Code that identifies the allergy or intoleranceBinding (example): allergyintolerance-code
patientRequiredΣ	1..1	Reference(Patient)	Who the sensitivity is for
encounter	0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
onset[x]	0..1	dateTime | Age | Period | Range | string	When allergy or intolerance was identified
recordedDate	0..1	dateTime	Date first version of the resource instance was recorded
recorder	0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
asserterΣ	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Source of the information about the allergy
lastOccurrence	0..1	dateTime	Date(/time) of last known occurrence of a reaction
note	0..*	Annotation	Additional text not captured in other fields
reaction	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
substance	0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for eventBinding (example): substance-code
manifestationRequired	1..*	CodeableConcept	Clinical symptoms/signs associated with the EventBinding (example): clinical-findings
description	0..1	string	Description of the event as a whole
onset	0..1	dateTime	Date(/time) when manifestations showed
severity	0..1	code	mild | moderate | severe (of event as a whole)Binding (required): reaction-event-severity
exposureRoute	0..1	CodeableConcept	How the subject was exposed to the substanceBinding (example): route-codes
note	0..*	Annotation	Text about event not captured in other fields

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/AllergyIntolerance?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
asserter	reference	Source of the information about the allergy AllergyIntolerance.asserter
category	token	food | medication | environment | biologic AllergyIntolerance.category
clinical-status	token	active | inactive | resolved AllergyIntolerance.clinicalStatus
code	token	Code that identifies the allergy or intolerance AllergyIntolerance.code | AllergyIntolerance.reaction.substance
criticality	token	low | high | unable-to-assess AllergyIntolerance.criticality
date	date	Date first version of the resource instance was recorded AllergyIntolerance.recordedDate
identifier	token	External ids for this item AllergyIntolerance.identifier
last-date	date	Date(/time) of last known occurrence of a reaction AllergyIntolerance.lastOccurrence
manifestation	token	Clinical symptoms/signs associated with the Event AllergyIntolerance.reaction.manifestation
onset	date	Date(/time) when manifestations showed AllergyIntolerance.reaction.onset
patient	reference	Who the sensitivity is for AllergyIntolerance.patient
recorder	reference	Who recorded the sensitivity AllergyIntolerance.recorder
route	token	How the subject was exposed to the substance AllergyIntolerance.reaction.exposureRoute
severity	token	mild | moderate | severe (of event as a whole) AllergyIntolerance.reaction.severity
type	token	allergy | intolerance - Underlying mechanism (if known) AllergyIntolerance.type
verification-status	token	unconfirmed | confirmed | refuted | entered-in-error AllergyIntolerance.verificationStatus

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition