HL7 PT FHIR Implementation Guide: Community Health, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AnaCeciliaCoimbra/community-health-ig/ and changes regularly. See the Directory of published versions

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

Resource Profile: AllergyIntolerance - Alergia do paciente registada

Este perfil representa as restrições aplicadas ao recurso AllergyIntolerance pelo Guia de Implementação FHIR do Sistema Clínico de Triagem e Aconselhamento (TCCS). Descreve as expectativas mínimas para o recurso AllergyIntolerance quando utilizado na composição do sistema ou em um dos recursos referidos.

Usage:

• Examples for this Resource Profile: AllergyIntolerance/example-allergyIntolerance

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 (generally: Risk of adverse reaction to a substance)
clinicalStatus	S	1..1	CodeableConcept	active | inactive | resolved
verificationStatus	S	1..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error
type	S	1..1	code	allergy | intolerance - Underlying mechanism (if known)
category	S	1..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required)
criticality		0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required)
code	S	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: https://ehr.p5.pt/terminology/ValueSet/snomedct (required)
encounter		1..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
substance	S	0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event
coding
system		0..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
manifestation	S	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event
coding
system		0..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
severity		0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required)
exposureRoute
coding
system		0..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality from the FHIR Standard
AllergyIntolerance.code	required	https://ehr.p5.pt/terminology/ValueSet/snomedct https://ehr.p5.pt/terminology/ValueSet/snomedct
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
clinicalStatus	?!SΣC	1..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. ele-1: All FHIR elements must have a @value or children
verificationStatus	?!SΣC	1..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. ele-1: All FHIR elements must have a @value or children
type	SΣ	1..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. ele-1: All FHIR elements must have a @value or children
category	SΣ	1..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required) ele-1: All FHIR elements must have a @value or children
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required) ele-1: All FHIR elements must have a @value or children
code	SΣ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: https://ehr.p5.pt/terminology/ValueSet/snomedct (required) ele-1: All FHIR elements must have a @value or children
patient	Σ	1..1	Reference(Patient)	Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
encounter		1..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted ele-1: All FHIR elements must have a @value or children
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
substance	S	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). ele-1: All FHIR elements must have a @value or children
manifestation	S	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. ele-1: All FHIR elements must have a @value or children
severity		0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) ele-1: All FHIR elements must have a @value or children
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 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality from the FHIR Standard
AllergyIntolerance.code	required	https://ehr.p5.pt/terminology/ValueSet/snomedct https://ehr.p5.pt/terminology/ValueSet/snomedct
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 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 (generally: Risk of adverse reaction to a substance) 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	?!SΣC	1..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!SΣC	1..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.
type	SΣ	1..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category	SΣ	1..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required)
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required)
code	SΣ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: https://ehr.p5.pt/terminology/ValueSet/snomedct (required)
patient	Σ	1..1	Reference(Patient)	Who the sensitivity is for
encounter		1..1	Reference(Encounter)	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(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
asserter	Σ	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Source of the information about the allergy
lastOccurrence		0..1	dateTime	Date(/time) of last known occurrence of a reaction
note		0..*	Annotation	Additional text not captured in other fields
reaction	S	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	S	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).
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
manifestation	S	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.
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
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)
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.
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
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 http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality from the FHIR Standard
AllergyIntolerance.code	required	https://ehr.p5.pt/terminology/ValueSet/snomedct https://ehr.p5.pt/terminology/ValueSet/snomedct
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 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: 6 elements
Must-Support: 8 elements
Fixed: 3 elements

Differential View

This structure is derived from AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance		0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
clinicalStatus	S	1..1	CodeableConcept	active | inactive | resolved
verificationStatus	S	1..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error
type	S	1..1	code	allergy | intolerance - Underlying mechanism (if known)
category	S	1..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required)
criticality		0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required)
code	S	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: https://ehr.p5.pt/terminology/ValueSet/snomedct (required)
encounter		1..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
substance	S	0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event
coding
system		0..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
manifestation	S	1..*	CodeableConcept	Clinical symptoms/signs associated with the Event
coding
system		0..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
severity		0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required)
exposureRoute
coding
system		0..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality from the FHIR Standard
AllergyIntolerance.code	required	https://ehr.p5.pt/terminology/ValueSet/snomedct https://ehr.p5.pt/terminology/ValueSet/snomedct
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity from the FHIR Standard

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
clinicalStatus	?!SΣC	1..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. ele-1: All FHIR elements must have a @value or children
verificationStatus	?!SΣC	1..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. ele-1: All FHIR elements must have a @value or children
type	SΣ	1..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. ele-1: All FHIR elements must have a @value or children
category	SΣ	1..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required) ele-1: All FHIR elements must have a @value or children
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required) ele-1: All FHIR elements must have a @value or children
code	SΣ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: https://ehr.p5.pt/terminology/ValueSet/snomedct (required) ele-1: All FHIR elements must have a @value or children
patient	Σ	1..1	Reference(Patient)	Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
encounter		1..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted ele-1: All FHIR elements must have a @value or children
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
substance	S	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). ele-1: All FHIR elements must have a @value or children
manifestation	S	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. ele-1: All FHIR elements must have a @value or children
severity		0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required) ele-1: All FHIR elements must have a @value or children
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 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality from the FHIR Standard
AllergyIntolerance.code	required	https://ehr.p5.pt/terminology/ValueSet/snomedct https://ehr.p5.pt/terminology/ValueSet/snomedct
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 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 (generally: Risk of adverse reaction to a substance) 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	?!SΣC	1..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!SΣC	1..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.
type	SΣ	1..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category	SΣ	1..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required)
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required)
code	SΣ	1..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: https://ehr.p5.pt/terminology/ValueSet/snomedct (required)
patient	Σ	1..1	Reference(Patient)	Who the sensitivity is for
encounter		1..1	Reference(Encounter)	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(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
asserter	Σ	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	Source of the information about the allergy
lastOccurrence		0..1	dateTime	Date(/time) of last known occurrence of a reaction
note		0..*	Annotation	Additional text not captured in other fields
reaction	S	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	S	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).
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
manifestation	S	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.
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
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)
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.
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
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 http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality from the FHIR Standard
AllergyIntolerance.code	required	https://ehr.p5.pt/terminology/ValueSet/snomedct https://ehr.p5.pt/terminology/ValueSet/snomedct
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 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: 6 elements
Must-Support: 8 elements
Fixed: 3 elements

Other representations of profile: CSV, Excel, Schematron