Introduction

This profile is used to represent de-identified AllergyIntolerance information. The de-identification process has to remove all data elements not explicitly identified as "SUPPORTED" in the profile.

The HHS De-identification Guidance is to be followed to ensure appropriate level of de-identification is performed.

According to the HHS guidance, dates should not have a precision of more than the year. This means month and day cannot be included. This includes AllergyIntolerance.recorded and onset elements.

In FHIR Resources, text elements and reference.display elements which provide human readable information to the providers may be generated using programs and tools from the data present within the resource. For e.g a AllergyIntolerance resource text element may contain information such as the AllergyIntolerance dates, patient information. This type of information will enable identification of the individuals. In order to avoid inadvertent revealing of PII/PHI, text elements cannot be included in the De-identified FHIR resource and the submission will be rejected when text elements are present by the validation process.

Ids and References

The original AllergyIntolerance resource id should not be included in the De-identified AllergyIntolerance instance. Instead a new id should be created and provided as part of the FHIR resource. The Data Submitter should be capable of using the generated id to relink the data to the original AllergyIntolerance. All resource references to the AllergyIntolerance submitted as part of the UDS+ report should refer to newly generated id.

Resource references cannot contain text element as it may contain PHI/PII. The text element for following references are not allowed

• patient

Date Truncation

The Data Submitter has to truncate the following dates to only have a precision of year

• onset
• recordedDate

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	De-Identified UDS Plus AllergyIntolerance Constraints: ait-1, ait-2
AllergyIntolerance.id	S This element must be supported. Σ This element is included in summaries.	0..1	id	The de-identified AllergyIntolerance identifier created by the health center to send data to UDS+ Data Receiver
AllergyIntolerance.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
AllergyIntolerance.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
AllergyIntolerance.clinicalStatus	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries. C	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries. C	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
AllergyIntolerance.type	S This element must be supported. Σ This element is included in summaries.	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
AllergyIntolerance.category	S This element must be supported. Σ This element is included in summaries.	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality	S This element must be supported. Σ This element is included in summaries.	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
AllergyIntolerance.code	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations (extensible): The set of codes indicating the allergy or intolerance
AllergyIntolerance.patient	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(De-Identified UDS Plus Patient)	Who the sensitivity is for
AllergyIntolerance.onset[x]	S This element must be supported. C	0..1		When allergy or intolerance was identified Constraints: uds-plus-all-1, uds-plus-all-1a, uds-plus-all-1b
AllergyIntolerance.onset[x].onsetDateTime			dateTime
AllergyIntolerance.onset[x].onsetAge			Age
AllergyIntolerance.recordedDate	S This element must be supported. C	0..1	dateTime	Date first version of the resource instance was recorded Constraints: uds-plus-all-2, uds-plus-all-2a, uds-plus-all-2b
AllergyIntolerance.lastOccurrence	C	0..1	dateTime	Date(/time) of last known occurrence of a reaction Constraints: uds-plus-all-3, uds-plus-all-3a, uds-plus-all-3b
AllergyIntolerance.reaction	S This element must be supported.	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.manifestation	S This element must be supported.	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
AllergyIntolerance.reaction.onset	C	0..1	dateTime	Date(/time) when manifestations showed Constraints: uds-plus-all-4, uds-plus-all-4a, uds-plus-all-4b
AllergyIntolerance.reaction.severity	S This element must be supported.	0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.type	Base	required	AllergyIntoleranceType	📍4.0.1	FHIR Std.
AllergyIntolerance.category	Base	required	AllergyIntoleranceCategory	📍4.0.1	FHIR Std.
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	extensible	Common substances for allergy and intolerance documentation including refutations	📦20210622	VSAC v0.15
AllergyIntolerance.reaction.​manifestation	Base	example	SNOMED CT Clinical Findings	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	AllergyIntolerance	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
uds-plus-all-1	error	AllergyIntolerance.onset[x]	All dateTime data elements should be truncated to a year only for de-identified resources.	$this.toString().length() = 4
uds-plus-all-1a	error	AllergyIntolerance.onset[x]	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-1b	error	AllergyIntolerance.onset[x]	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-2	error	AllergyIntolerance.recordedDate	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-2a	error	AllergyIntolerance.recordedDate	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-2b	error	AllergyIntolerance.recordedDate	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-3	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-3a	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-3b	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-4	error	AllergyIntolerance.reaction.onset	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-4a	error	AllergyIntolerance.reaction.onset	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-4b	error	AllergyIntolerance.reaction.onset	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'

This structure is derived from AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance		0..*	AllergyIntolerance	De-Identified UDS Plus AllergyIntolerance
AllergyIntolerance.id	S This element must be supported.	0..1	id	The de-identified AllergyIntolerance identifier created by the health center to send data to UDS+ Data Receiver
AllergyIntolerance.text		0..0		Cannot include any text in the resource as part of the de-identified data.
AllergyIntolerance.contained		0..0		Cannot include any contained resources in the resource as part of the de-identified data.
AllergyIntolerance.clinicalStatus	S This element must be supported.	0..1	CodeableConcept	active | inactive | resolved
AllergyIntolerance.verificationStatus	S This element must be supported.	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error
AllergyIntolerance.type	S This element must be supported.	0..1	code	allergy | intolerance - Underlying mechanism (if known)
AllergyIntolerance.category	S This element must be supported.	0..*	code	food | medication | environment | biologic
AllergyIntolerance.criticality	S This element must be supported.	0..1	code	low | high | unable-to-assess
AllergyIntolerance.code	S This element must be supported.	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations (extensible): The set of codes indicating the allergy or intolerance
AllergyIntolerance.patient	S This element must be supported.	1..1	Reference(De-Identified UDS Plus Patient)	Who the sensitivity is for
AllergyIntolerance.patient.display		0..0		Text alternative for the resource
AllergyIntolerance.encounter
AllergyIntolerance.encounter.display		0..0		Text alternative for the resource
AllergyIntolerance.onset[x]	S This element must be supported. C	0..1		When allergy or intolerance was identified Constraints: uds-plus-all-1, uds-plus-all-1a, uds-plus-all-1b
AllergyIntolerance.onset[x].onsetDateTime			dateTime
AllergyIntolerance.onset[x].onsetAge			Age
AllergyIntolerance.recordedDate	S This element must be supported. C	0..1	dateTime	Date first version of the resource instance was recorded Constraints: uds-plus-all-2, uds-plus-all-2a, uds-plus-all-2b
AllergyIntolerance.recorder
AllergyIntolerance.recorder.display		0..0		Text alternative for the resource
AllergyIntolerance.asserter
AllergyIntolerance.asserter.display		0..0		Text alternative for the resource
AllergyIntolerance.lastOccurrence	C	0..1	dateTime	Date(/time) of last known occurrence of a reaction Constraints: uds-plus-all-3, uds-plus-all-3a, uds-plus-all-3b
AllergyIntolerance.note		0..0		Additional text not captured in other fields
AllergyIntolerance.reaction	S This element must be supported.	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.manifestation	S This element must be supported.	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event
AllergyIntolerance.reaction.onset	C	0..1	dateTime	Date(/time) when manifestations showed Constraints: uds-plus-all-4, uds-plus-all-4a, uds-plus-all-4b
AllergyIntolerance.reaction.severity	S This element must be supported.	0..1	code	mild | moderate | severe (of event as a whole)
AllergyIntolerance.reaction.note		0..0		Text about event not captured in other fields
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.code	Base	extensible	Common substances for allergy and intolerance documentation including refutations	📦20210622	VSAC v0.15

Constraints

Id	Grade	Path(s)	Description	Expression
uds-plus-all-1	error	AllergyIntolerance.onset[x]	All dateTime data elements should be truncated to a year only for de-identified resources.	$this.toString().length() = 4
uds-plus-all-1a	error	AllergyIntolerance.onset[x]	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-1b	error	AllergyIntolerance.onset[x]	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-2	error	AllergyIntolerance.recordedDate	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-2a	error	AllergyIntolerance.recordedDate	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-2b	error	AllergyIntolerance.recordedDate	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-3	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-3a	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-3b	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-4	error	AllergyIntolerance.reaction.onset	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-4a	error	AllergyIntolerance.reaction.onset	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-4b	error	AllergyIntolerance.reaction.onset	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	De-Identified UDS Plus AllergyIntolerance Constraints: ait-1, ait-2
AllergyIntolerance.id	S This element must be supported. Σ This element is included in summaries.	0..1	id	The de-identified AllergyIntolerance identifier created by the health center to send data to UDS+ Data Receiver
AllergyIntolerance.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
AllergyIntolerance.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
AllergyIntolerance.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
AllergyIntolerance.extension		0..*	Extension	Additional content defined by implementations
AllergyIntolerance.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
AllergyIntolerance.identifier	Σ This element is included in summaries.	0..*	Identifier	External ids for this item
AllergyIntolerance.clinicalStatus	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries. C	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries. C	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
AllergyIntolerance.type	S This element must be supported. Σ This element is included in summaries.	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
AllergyIntolerance.category	S This element must be supported. Σ This element is included in summaries.	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality	S This element must be supported. Σ This element is included in summaries.	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
AllergyIntolerance.code	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations (extensible): The set of codes indicating the allergy or intolerance
AllergyIntolerance.patient	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(De-Identified UDS Plus Patient)	Who the sensitivity is for
AllergyIntolerance.patient.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.patient.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.patient.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
AllergyIntolerance.patient.type	Σ This element is included in summaries.	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
AllergyIntolerance.patient.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
AllergyIntolerance.encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
AllergyIntolerance.encounter.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.encounter.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.encounter.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
AllergyIntolerance.encounter.type	Σ This element is included in summaries.	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
AllergyIntolerance.encounter.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
AllergyIntolerance.onset[x]	S This element must be supported. C	0..1		When allergy or intolerance was identified Constraints: uds-plus-all-1, uds-plus-all-1a, uds-plus-all-1b
AllergyIntolerance.onset[x].onsetDateTime			dateTime
AllergyIntolerance.onset[x].onsetAge			Age
AllergyIntolerance.recordedDate	S This element must be supported. C	0..1	dateTime	Date first version of the resource instance was recorded Constraints: uds-plus-all-2, uds-plus-all-2a, uds-plus-all-2b
AllergyIntolerance.recorder		0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
AllergyIntolerance.recorder.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.recorder.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.recorder.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
AllergyIntolerance.recorder.type	Σ This element is included in summaries.	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
AllergyIntolerance.recorder.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
AllergyIntolerance.asserter	Σ This element is included in summaries.	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Source of the information about the allergy
AllergyIntolerance.asserter.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.asserter.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.asserter.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
AllergyIntolerance.asserter.type	Σ This element is included in summaries.	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
AllergyIntolerance.asserter.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
AllergyIntolerance.lastOccurrence	C	0..1	dateTime	Date(/time) of last known occurrence of a reaction Constraints: uds-plus-all-3, uds-plus-all-3a, uds-plus-all-3b
AllergyIntolerance.reaction	S This element must be supported.	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.reaction.extension		0..*	Extension	Additional content defined by implementations
AllergyIntolerance.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
AllergyIntolerance.reaction.manifestation	S This element must be supported.	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
AllergyIntolerance.reaction.description		0..1	string	Description of the event as a whole
AllergyIntolerance.reaction.onset	C	0..1	dateTime	Date(/time) when manifestations showed Constraints: uds-plus-all-4, uds-plus-all-4a, uds-plus-all-4b
AllergyIntolerance.reaction.severity	S This element must be supported.	0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
AllergyIntolerance.reaction.exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.type	Base	required	AllergyIntoleranceType	📍4.0.1	FHIR Std.
AllergyIntolerance.category	Base	required	AllergyIntoleranceCategory	📍4.0.1	FHIR Std.
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	extensible	Common substances for allergy and intolerance documentation including refutations	📦20210622	VSAC v0.15
AllergyIntolerance.patient.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
AllergyIntolerance.encounter.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
AllergyIntolerance.recorder.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
AllergyIntolerance.asserter.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​substance	Base	example	Substance Code	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​manifestation	Base	example	SNOMED CT Clinical Findings	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​exposureRoute	Base	example	SNOMED CT Route Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	AllergyIntolerance	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
uds-plus-all-1	error	AllergyIntolerance.onset[x]	All dateTime data elements should be truncated to a year only for de-identified resources.	$this.toString().length() = 4
uds-plus-all-1a	error	AllergyIntolerance.onset[x]	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-1b	error	AllergyIntolerance.onset[x]	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-2	error	AllergyIntolerance.recordedDate	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-2a	error	AllergyIntolerance.recordedDate	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-2b	error	AllergyIntolerance.recordedDate	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-3	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-3a	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-3b	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-4	error	AllergyIntolerance.reaction.onset	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-4a	error	AllergyIntolerance.reaction.onset	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-4b	error	AllergyIntolerance.reaction.onset	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	De-Identified UDS Plus AllergyIntolerance Constraints: ait-1, ait-2
AllergyIntolerance.id	S This element must be supported. Σ This element is included in summaries.	0..1	id	The de-identified AllergyIntolerance identifier created by the health center to send data to UDS+ Data Receiver
AllergyIntolerance.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
AllergyIntolerance.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
AllergyIntolerance.clinicalStatus	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries. C	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries. C	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
AllergyIntolerance.type	S This element must be supported. Σ This element is included in summaries.	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
AllergyIntolerance.category	S This element must be supported. Σ This element is included in summaries.	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality	S This element must be supported. Σ This element is included in summaries.	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
AllergyIntolerance.code	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations (extensible): The set of codes indicating the allergy or intolerance
AllergyIntolerance.patient	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(De-Identified UDS Plus Patient)	Who the sensitivity is for
AllergyIntolerance.onset[x]	S This element must be supported. C	0..1		When allergy or intolerance was identified Constraints: uds-plus-all-1, uds-plus-all-1a, uds-plus-all-1b
AllergyIntolerance.onset[x].onsetDateTime			dateTime
AllergyIntolerance.onset[x].onsetAge			Age
AllergyIntolerance.recordedDate	S This element must be supported. C	0..1	dateTime	Date first version of the resource instance was recorded Constraints: uds-plus-all-2, uds-plus-all-2a, uds-plus-all-2b
AllergyIntolerance.lastOccurrence	C	0..1	dateTime	Date(/time) of last known occurrence of a reaction Constraints: uds-plus-all-3, uds-plus-all-3a, uds-plus-all-3b
AllergyIntolerance.reaction	S This element must be supported.	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.manifestation	S This element must be supported.	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
AllergyIntolerance.reaction.onset	C	0..1	dateTime	Date(/time) when manifestations showed Constraints: uds-plus-all-4, uds-plus-all-4a, uds-plus-all-4b
AllergyIntolerance.reaction.severity	S This element must be supported.	0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.type	Base	required	AllergyIntoleranceType	📍4.0.1	FHIR Std.
AllergyIntolerance.category	Base	required	AllergyIntoleranceCategory	📍4.0.1	FHIR Std.
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	extensible	Common substances for allergy and intolerance documentation including refutations	📦20210622	VSAC v0.15
AllergyIntolerance.reaction.​manifestation	Base	example	SNOMED CT Clinical Findings	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	AllergyIntolerance	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
uds-plus-all-1	error	AllergyIntolerance.onset[x]	All dateTime data elements should be truncated to a year only for de-identified resources.	$this.toString().length() = 4
uds-plus-all-1a	error	AllergyIntolerance.onset[x]	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-1b	error	AllergyIntolerance.onset[x]	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-2	error	AllergyIntolerance.recordedDate	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-2a	error	AllergyIntolerance.recordedDate	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-2b	error	AllergyIntolerance.recordedDate	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-3	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-3a	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-3b	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-4	error	AllergyIntolerance.reaction.onset	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-4a	error	AllergyIntolerance.reaction.onset	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-4b	error	AllergyIntolerance.reaction.onset	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'

Differential View

This structure is derived from AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance		0..*	AllergyIntolerance	De-Identified UDS Plus AllergyIntolerance
AllergyIntolerance.id	S This element must be supported.	0..1	id	The de-identified AllergyIntolerance identifier created by the health center to send data to UDS+ Data Receiver
AllergyIntolerance.text		0..0		Cannot include any text in the resource as part of the de-identified data.
AllergyIntolerance.contained		0..0		Cannot include any contained resources in the resource as part of the de-identified data.
AllergyIntolerance.clinicalStatus	S This element must be supported.	0..1	CodeableConcept	active | inactive | resolved
AllergyIntolerance.verificationStatus	S This element must be supported.	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error
AllergyIntolerance.type	S This element must be supported.	0..1	code	allergy | intolerance - Underlying mechanism (if known)
AllergyIntolerance.category	S This element must be supported.	0..*	code	food | medication | environment | biologic
AllergyIntolerance.criticality	S This element must be supported.	0..1	code	low | high | unable-to-assess
AllergyIntolerance.code	S This element must be supported.	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations (extensible): The set of codes indicating the allergy or intolerance
AllergyIntolerance.patient	S This element must be supported.	1..1	Reference(De-Identified UDS Plus Patient)	Who the sensitivity is for
AllergyIntolerance.patient.display		0..0		Text alternative for the resource
AllergyIntolerance.encounter
AllergyIntolerance.encounter.display		0..0		Text alternative for the resource
AllergyIntolerance.onset[x]	S This element must be supported. C	0..1		When allergy or intolerance was identified Constraints: uds-plus-all-1, uds-plus-all-1a, uds-plus-all-1b
AllergyIntolerance.onset[x].onsetDateTime			dateTime
AllergyIntolerance.onset[x].onsetAge			Age
AllergyIntolerance.recordedDate	S This element must be supported. C	0..1	dateTime	Date first version of the resource instance was recorded Constraints: uds-plus-all-2, uds-plus-all-2a, uds-plus-all-2b
AllergyIntolerance.recorder
AllergyIntolerance.recorder.display		0..0		Text alternative for the resource
AllergyIntolerance.asserter
AllergyIntolerance.asserter.display		0..0		Text alternative for the resource
AllergyIntolerance.lastOccurrence	C	0..1	dateTime	Date(/time) of last known occurrence of a reaction Constraints: uds-plus-all-3, uds-plus-all-3a, uds-plus-all-3b
AllergyIntolerance.note		0..0		Additional text not captured in other fields
AllergyIntolerance.reaction	S This element must be supported.	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.manifestation	S This element must be supported.	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event
AllergyIntolerance.reaction.onset	C	0..1	dateTime	Date(/time) when manifestations showed Constraints: uds-plus-all-4, uds-plus-all-4a, uds-plus-all-4b
AllergyIntolerance.reaction.severity	S This element must be supported.	0..1	code	mild | moderate | severe (of event as a whole)
AllergyIntolerance.reaction.note		0..0		Text about event not captured in other fields
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.code	Base	extensible	Common substances for allergy and intolerance documentation including refutations	📦20210622	VSAC v0.15

Constraints

Id	Grade	Path(s)	Description	Expression
uds-plus-all-1	error	AllergyIntolerance.onset[x]	All dateTime data elements should be truncated to a year only for de-identified resources.	$this.toString().length() = 4
uds-plus-all-1a	error	AllergyIntolerance.onset[x]	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-1b	error	AllergyIntolerance.onset[x]	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-2	error	AllergyIntolerance.recordedDate	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-2a	error	AllergyIntolerance.recordedDate	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-2b	error	AllergyIntolerance.recordedDate	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-3	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-3a	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-3b	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-4	error	AllergyIntolerance.reaction.onset	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-4a	error	AllergyIntolerance.reaction.onset	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-4b	error	AllergyIntolerance.reaction.onset	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	AllergyIntolerance	De-Identified UDS Plus AllergyIntolerance Constraints: ait-1, ait-2
AllergyIntolerance.id	S This element must be supported. Σ This element is included in summaries.	0..1	id	The de-identified AllergyIntolerance identifier created by the health center to send data to UDS+ Data Receiver
AllergyIntolerance.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
AllergyIntolerance.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
AllergyIntolerance.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
AllergyIntolerance.extension		0..*	Extension	Additional content defined by implementations
AllergyIntolerance.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
AllergyIntolerance.identifier	Σ This element is included in summaries.	0..*	Identifier	External ids for this item
AllergyIntolerance.clinicalStatus	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries. C	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
AllergyIntolerance.verificationStatus	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries. C	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
AllergyIntolerance.type	S This element must be supported. Σ This element is included in summaries.	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
AllergyIntolerance.category	S This element must be supported. Σ This element is included in summaries.	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
AllergyIntolerance.criticality	S This element must be supported. Σ This element is included in summaries.	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
AllergyIntolerance.code	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: Common substances for allergy and intolerance documentation including refutations (extensible): The set of codes indicating the allergy or intolerance
AllergyIntolerance.patient	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(De-Identified UDS Plus Patient)	Who the sensitivity is for
AllergyIntolerance.patient.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.patient.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.patient.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
AllergyIntolerance.patient.type	Σ This element is included in summaries.	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
AllergyIntolerance.patient.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
AllergyIntolerance.encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
AllergyIntolerance.encounter.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.encounter.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.encounter.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
AllergyIntolerance.encounter.type	Σ This element is included in summaries.	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
AllergyIntolerance.encounter.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
AllergyIntolerance.onset[x]	S This element must be supported. C	0..1		When allergy or intolerance was identified Constraints: uds-plus-all-1, uds-plus-all-1a, uds-plus-all-1b
AllergyIntolerance.onset[x].onsetDateTime			dateTime
AllergyIntolerance.onset[x].onsetAge			Age
AllergyIntolerance.recordedDate	S This element must be supported. C	0..1	dateTime	Date first version of the resource instance was recorded Constraints: uds-plus-all-2, uds-plus-all-2a, uds-plus-all-2b
AllergyIntolerance.recorder		0..1	Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
AllergyIntolerance.recorder.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.recorder.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.recorder.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
AllergyIntolerance.recorder.type	Σ This element is included in summaries.	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
AllergyIntolerance.recorder.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
AllergyIntolerance.asserter	Σ This element is included in summaries.	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Source of the information about the allergy
AllergyIntolerance.asserter.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.asserter.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
AllergyIntolerance.asserter.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
AllergyIntolerance.asserter.type	Σ This element is included in summaries.	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
AllergyIntolerance.asserter.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
AllergyIntolerance.lastOccurrence	C	0..1	dateTime	Date(/time) of last known occurrence of a reaction Constraints: uds-plus-all-3, uds-plus-all-3a, uds-plus-all-3b
AllergyIntolerance.reaction	S This element must be supported.	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
AllergyIntolerance.reaction.id		0..1	string	Unique id for inter-element referencing
AllergyIntolerance.reaction.extension		0..*	Extension	Additional content defined by implementations
AllergyIntolerance.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
AllergyIntolerance.reaction.substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
AllergyIntolerance.reaction.manifestation	S This element must be supported.	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
AllergyIntolerance.reaction.description		0..1	string	Description of the event as a whole
AllergyIntolerance.reaction.onset	C	0..1	dateTime	Date(/time) when manifestations showed Constraints: uds-plus-all-4, uds-plus-all-4a, uds-plus-all-4b
AllergyIntolerance.reaction.severity	S This element must be supported.	0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
AllergyIntolerance.reaction.exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.type	Base	required	AllergyIntoleranceType	📍4.0.1	FHIR Std.
AllergyIntolerance.category	Base	required	AllergyIntoleranceCategory	📍4.0.1	FHIR Std.
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	extensible	Common substances for allergy and intolerance documentation including refutations	📦20210622	VSAC v0.15
AllergyIntolerance.patient.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
AllergyIntolerance.encounter.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
AllergyIntolerance.recorder.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
AllergyIntolerance.asserter.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​substance	Base	example	Substance Code	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​manifestation	Base	example	SNOMED CT Clinical Findings	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​exposureRoute	Base	example	SNOMED CT Route Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error	verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	AllergyIntolerance	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
uds-plus-all-1	error	AllergyIntolerance.onset[x]	All dateTime data elements should be truncated to a year only for de-identified resources.	$this.toString().length() = 4
uds-plus-all-1a	error	AllergyIntolerance.onset[x]	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-1b	error	AllergyIntolerance.onset[x]	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-2	error	AllergyIntolerance.recordedDate	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-2a	error	AllergyIntolerance.recordedDate	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-2b	error	AllergyIntolerance.recordedDate	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-3	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-3a	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-3b	error	AllergyIntolerance.lastOccurrence	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'
uds-plus-all-4	error	AllergyIntolerance.reaction.onset	All dateTime data elements should be truncated to a year only for de-identified resources.	$this is DateTime implies $this.toString().length() = 4
uds-plus-all-4a	error	AllergyIntolerance.reaction.onset	All dateTime data elements should have valid year > 1900	$this is DateTime implies $this.toString() >= '1900'
uds-plus-all-4b	error	AllergyIntolerance.reaction.onset	All dateTime data elements should have valid year < 2030	$this is DateTime implies $this.toString() <= '2030'

This structure is derived from AllergyIntolerance

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 13 elements
Prohibited: 8 elements

Structures

This structure refers to these other structures:

• De-Identified UDS Plus Patient (http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/de-identified-uds-plus-patient)

Maturity: 2