This page is part of the International Patient Summary Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
SD.40 StructureDefinition-allergyintolerance-uv-ips
This profile represents the constraints applied to the AllergyIntolerance resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an allergy or intolerance is represented in the patient summary as an instance of an AllergyIntolerance resource constrained by this profile.
It documents the relevant allergies or intolerances (conditions) for a patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy.
Conformance resource variables defined here
SD.40.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/uv/ips/StructureDefinition/allergyintolerance-uv-ips
Published on Thu Feb 15 00:57:18 AEDT 2018 as a draft by .
This profile builds on AllergyIntolerance
Summary
Mandatory: 0 element (6 nested mandatory elements)
Must-Support: 9 elements
Fixed Value: 1 element
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element AllergyIntolerance.code is sliced based on the value of value:coding.system (Closed)
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance | I | 0..* | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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 | ΣI | 0..1 | id | Logical id of this artifact ele-1: All FHIR elements must have a @value or children |
 meta | ΣI | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| language | I | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) ele-1: All FHIR elements must have a @value or children |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children |
 contained | 0..* | Resource | Contained, inline Resources | |
| identifier | ΣI | 0..* | Identifier | External ids for this item ele-1: All FHIR elements must have a @value or children |
 id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) ele-1: All FHIR elements must have a @value or children |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
 userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General': http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General': 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children |
| end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children |
 assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
 id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| clinicalStatus | ?!SΣI | 1..1 | code | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatus (required) ele-1: All FHIR elements must have a @value or children |
| verificationStatus | ?!SΣI | 1..1 | code | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatus (required) ele-1: All FHIR elements must have a @value or children |
| type | SΣI | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required) ele-1: All FHIR elements must have a @value or children |
| category | ΣI | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required) ele-1: All FHIR elements must have a @value or children |
| criticality | SΣI | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required) ele-1: All FHIR elements must have a @value or children |
 code | SΣI | CodeableConcept | Code that identifies the allergy or intolerance Slice: Unordered, Closed by value:coding.system Binding: AllergyIntolerance Substance/Product, Condition and Negation Codes (example) ele-1: All FHIR elements must have a @value or children | |
 id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
 id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
 text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | CodeableConcept-uv-ips | Code for absent or unknown allergy or intolerance Binding: IPSNoAllergiesInfo (required) ele-1: All FHIR elements must have a @value or children |
 id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
 id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: urn:oid:2.16.840.1.113883.3.1937.777.13.5.999.1 |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
 text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | CodeableConcept-uv-ips | Code that identifies the allergy or intolerance Binding: Allergyintolerancesubstancecondition (preferred) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| patient | SΣI | 1..1 | Reference(Patient) | Who the sensitivity is for ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| onsetDateTime | SI | 1..1 | dateTime | When allergy or intolerance was identified ele-1: All FHIR elements must have a @value or children |
| assertedDate | I | 0..1 | dateTime | Date record was believed accurate ele-1: All FHIR elements must have a @value or children |
| recorder | I | 0..1 | Reference(Practitioner | Patient) | Who recorded the sensitivity ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| asserter | ΣI | 0..1 | Reference(Patient | RelatedPerson | Practitioner) | Source of the information about the allergy ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| lastOccurrence | I | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction ele-1: All FHIR elements must have a @value or children |
| note | I | 0..* | Annotation | Additional text not captured in other fields ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
 author[x] | ΣI | 0..1 | Reference(Practitioner | Patient | RelatedPerson), string | Individual responsible for the annotation ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| time | ΣI | 0..1 | dateTime | When the annotation was made ele-1: All FHIR elements must have a @value or children |
| text | I | 1..1 | string | The annotation - text content ele-1: All FHIR elements must have a @value or children |
| reaction | I | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
 modifierExtension | ?!ΣI | 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 |
| substance | I | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Substance Code (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| manifestation | SI | 1..* | CodeableConcept-uv-ips | Clinical symptoms/signs associated with the Event Binding: IPSAllergyReaction (preferred) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| description | I | 0..1 | string | Description of the event as a whole ele-1: All FHIR elements must have a @value or children |
| onset | I | 0..1 | dateTime | Date(/time) when manifestations showed ele-1: All FHIR elements must have a @value or children |
| severity | SI | 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 |
| exposureRoute | I | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMED CT Route Codes (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| note | I | 0..* | Annotation | Text about event not captured in other fields ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| author[x] | ΣI | 0..1 | Reference(Practitioner | Patient | RelatedPerson), string | Individual responsible for the annotation ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| time | ΣI | 0..1 | dateTime | When the annotation was made ele-1: All FHIR elements must have a @value or children |
| text | I | 1..1 | string | The annotation - text content ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
