FHIR Core Implementation Guide (CO) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Profile: Allergy or Intolerance CO

FHIR AllergyIntolerance colombian Core profile, defined by HL7 CO.

Standardize data recording and data exchange of an allergy or intolerance - CO. [ES: Estandarizar los datos de registro e intercambo de datos de una alergia o intolerancia - CO.]

Usage:

• Refer to this Resource Profile: Profile: Family Member History CO
• Examples for this Resource Profile: AllergyIntolerance/1471a0de-59ec-43db-9f0d-2b05b9bc7433, AllergyIntolerance/4d17ba93-19d5-469e-b38b-8bcce59d4465, AllergyIntolerance/589fdad5-a036-4296-badc-15379431ae80, AllergyIntolerance/9b5c0ec6-f4d1-4961-bfba-b1a5005a38db... Show 2 more, AllergyIntolerance/bfdf7195-4c8a-4e0e-915f-d395e41c4ad9 and AllergyIntolerance/e32678f9-b295-4d79-b9b3-8bab463eca3b

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

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

This structure is derived from AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance		0..*	AllergyIntolerance	Allergy or Intolerance.
clinicalStatus		0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus		0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required)
type		0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required)
category	S	1..1	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required)
criticality		0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required)
code		1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example)
text	S	1..1	string	Textual description of the allergen
patient	S	1..1	Reference(Profile: Patient CO)	Who the sensitivity is for
encounter		0..1	Reference(Profile: Encounter Medical Consultation CO | Profile: Emergency Encounter CO | Profile: Hospitalization Encounter CO)	Encounter when the allergy or intolerance was asserted
recorder		0..1	Reference(Profile: Practitioner CO | Profile: Practitioner Role CO)	Who recorded the sensitivity
asserter		0..1	Reference(Profile: Practitioner CO | Profile: Practitioner Role CO | Profile: Patient CO)	Source of the information about the allergy
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard
AllergyIntolerance.code	example	AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes http://hl7.org/fhir/ValueSet/allergyintolerance-code from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance. ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
clinicalStatus	?!ΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus	?!ΣC	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required)
type	Σ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required)
category	SΣ	1..1	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required)
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required)
code	Σ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example)
text	SΣ	1..1	string	Textual description of the allergen
patient	SΣ	1..1	Reference(Profile: Patient CO)	Who the sensitivity is for
encounter		0..1	Reference(Profile: Encounter Medical Consultation CO | Profile: Emergency Encounter CO | Profile: Hospitalization Encounter CO)	Encounter when the allergy or intolerance was asserted
recorder		0..1	Reference(Profile: Practitioner CO | Profile: Practitioner Role CO)	Who recorded the sensitivity
asserter	Σ	0..1	Reference(Profile: Practitioner CO | Profile: Practitioner Role CO | Profile: Patient CO)	Source of the information about the allergy
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard
AllergyIntolerance.code	example	AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes http://hl7.org/fhir/ValueSet/allergyintolerance-code from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance. ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External ids for this item
clinicalStatus	?!ΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus	?!ΣC	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required)
type	Σ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required)
category	SΣ	1..1	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required)
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required)
code	Σ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	1..1	string	Textual description of the allergen
patient	SΣ	1..1	Reference(Profile: Patient CO)	Who the sensitivity is for
encounter		0..1	Reference(Profile: Encounter Medical Consultation CO | Profile: Emergency Encounter CO | Profile: Hospitalization Encounter CO)	Encounter when the allergy or intolerance was asserted
onset[x]		0..1		When allergy or intolerance was identified
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
recordedDate		0..1	dateTime	Date first version of the resource instance was recorded
recorder		0..1	Reference(Profile: Practitioner CO | Profile: Practitioner Role CO)	Who recorded the sensitivity
asserter	Σ	0..1	Reference(Profile: Practitioner CO | Profile: Practitioner Role CO | Profile: Patient CO)	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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).
manifestation		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.
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: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
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.
note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard
AllergyIntolerance.code	example	AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes http://hl7.org/fhir/ValueSet/allergyintolerance-code from the FHIR Standard
AllergyIntolerance.reaction.substance	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
AllergyIntolerance.reaction.manifestation	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard
AllergyIntolerance.reaction.exposureRoute	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from AllergyIntolerance

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

• Profile: Patient CO (http://co.fhir.guide/core/StructureDefinition/PatientCO)
• Profile: Encounter Medical Consultation CO (http://co.fhir.guide/core/StructureDefinition/EncounterConsultationCO)
• Profile: Emergency Encounter CO (http://co.fhir.guide/core/StructureDefinition/EncounterEmergencyCO)
• Profile: Hospitalization Encounter CO (http://co.fhir.guide/core/StructureDefinition/EncounterHospitalizationCO)
• Profile: Practitioner CO (http://co.fhir.guide/core/StructureDefinition/PractitionerCO)
• Profile: Practitioner Role CO (http://co.fhir.guide/core/StructureDefinition/PractitionerRoleCO)

Differential View

This structure is derived from AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance		0..*	AllergyIntolerance	Allergy or Intolerance.
clinicalStatus		0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus		0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required)
type		0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required)
category	S	1..1	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required)
criticality		0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required)
code		1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example)
text	S	1..1	string	Textual description of the allergen
patient	S	1..1	Reference(Profile: Patient CO)	Who the sensitivity is for
encounter		0..1	Reference(Profile: Encounter Medical Consultation CO | Profile: Emergency Encounter CO | Profile: Hospitalization Encounter CO)	Encounter when the allergy or intolerance was asserted
recorder		0..1	Reference(Profile: Practitioner CO | Profile: Practitioner Role CO)	Who recorded the sensitivity
asserter		0..1	Reference(Profile: Practitioner CO | Profile: Practitioner Role CO | Profile: Patient CO)	Source of the information about the allergy
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard
AllergyIntolerance.code	example	AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes http://hl7.org/fhir/ValueSet/allergyintolerance-code from the FHIR Standard

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance. ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
clinicalStatus	?!ΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus	?!ΣC	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required)
type	Σ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required)
category	SΣ	1..1	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required)
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required)
code	Σ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example)
text	SΣ	1..1	string	Textual description of the allergen
patient	SΣ	1..1	Reference(Profile: Patient CO)	Who the sensitivity is for
encounter		0..1	Reference(Profile: Encounter Medical Consultation CO | Profile: Emergency Encounter CO | Profile: Hospitalization Encounter CO)	Encounter when the allergy or intolerance was asserted
recorder		0..1	Reference(Profile: Practitioner CO | Profile: Practitioner Role CO)	Who recorded the sensitivity
asserter	Σ	0..1	Reference(Profile: Practitioner CO | Profile: Practitioner Role CO | Profile: Patient CO)	Source of the information about the allergy
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard
AllergyIntolerance.code	example	AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes http://hl7.org/fhir/ValueSet/allergyintolerance-code from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance. ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External ids for this item
clinicalStatus	?!ΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required)
verificationStatus	?!ΣC	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required)
type	Σ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required)
category	SΣ	1..1	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required)
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required)
code	Σ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	1..1	string	Textual description of the allergen
patient	SΣ	1..1	Reference(Profile: Patient CO)	Who the sensitivity is for
encounter		0..1	Reference(Profile: Encounter Medical Consultation CO | Profile: Emergency Encounter CO | Profile: Hospitalization Encounter CO)	Encounter when the allergy or intolerance was asserted
onset[x]		0..1		When allergy or intolerance was identified
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
recordedDate		0..1	dateTime	Date first version of the resource instance was recorded
recorder		0..1	Reference(Profile: Practitioner CO | Profile: Practitioner Role CO)	Who recorded the sensitivity
asserter	Σ	0..1	Reference(Profile: Practitioner CO | Profile: Practitioner Role CO | Profile: Patient CO)	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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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).
manifestation		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.
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: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
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.
note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard
AllergyIntolerance.code	example	AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes http://hl7.org/fhir/ValueSet/allergyintolerance-code from the FHIR Standard
AllergyIntolerance.reaction.substance	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
AllergyIntolerance.reaction.manifestation	example	SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard
AllergyIntolerance.reaction.exposureRoute	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from AllergyIntolerance

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

• Profile: Patient CO (http://co.fhir.guide/core/StructureDefinition/PatientCO)
• Profile: Encounter Medical Consultation CO (http://co.fhir.guide/core/StructureDefinition/EncounterConsultationCO)
• Profile: Emergency Encounter CO (http://co.fhir.guide/core/StructureDefinition/EncounterEmergencyCO)
• Profile: Hospitalization Encounter CO (http://co.fhir.guide/core/StructureDefinition/EncounterHospitalizationCO)
• Profile: Practitioner CO (http://co.fhir.guide/core/StructureDefinition/PractitionerCO)
• Profile: Practitioner Role CO (http://co.fhir.guide/core/StructureDefinition/PractitionerRoleCO)

Other representations of profile: CSV, Excel, Schematron