AllergyIntolerance Profile¶
| Canonical | ../StructureDefinition/nexus-emr-core-allergyintolerance |
|---|---|
| Status | draft · 1.26.0 |
| Base | AllergyIntolerance (constraint) |
| Source | FSH · JSON |
Defines the Nexus EMR standard for AllergyIntolerance resources, based on CA-Core+. Includes instance-specific Nexus EMR identifiers, references via identifier (CII E01).
Elements / Snapshot
The full effective definition: base AllergyIntolerance with this profile's constraints applied.
| Element | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | 0..* | Nexus EMR Allergy Intolerance Core i Invariants: ait-1, ait-2, dom-2, dom-3, dom-4, dom-5, dom-6, nexus-note-extension-not-where-native |
||
| id | 0..1 | http://hl7.org/fhirpath/System.String | Logical id of this artifact i | |
| meta | 0..1 | Meta | Metadata about the resource Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| versionId | 0..1 | id | Version specific identifier i Invariants: ele-1 |
|
| lastUpdated | 0..1 | instant | When the resource version last changed i Invariants: ele-1 |
|
| source | S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from i Invariants: ele-1 |
| profile | 0..* | canonical | Profiles this resource claims to conform to i Invariants: ele-1 |
|
| security | 0..* | Coding | Security Labels applied to this resource i Binding: security-labels ( extensible)Invariants: ele-1 |
|
| tag | 0..* | Coding | Tags applied to this resource i Binding: common-tags ( example)Invariants: ele-1 |
|
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| language | 0..1 | code | Language of the resource content i Binding: languages ( preferred)Invariants: ele-1 |
|
| text | S | 0..1 | Narrative | Narrative i Invariants: ele-1 |
| contained | 0..* | Resource | Contained, inline Resources i | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored i Invariants: ele-1, ext-1 |
| identifier | S | 0..* | Identifier | Business identifier(s) for allergyintolerance i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| use | ?! | 0..1 | code | usual | official | temp | secondary | old (If known) i Binding: identifier-use ( required)Invariants: ele-1 |
| type | 0..1 | CodeableConcept | Description of identifier i Binding: identifier-type ( extensible)Invariants: ele-1 |
|
| system | 1..1 | uri | The namespace for the identifier value i Invariants: ele-1 |
|
| value | 1..1 | string | The value that is unique i Invariants: ele-1 |
|
| period | 0..1 | Period | Time period when id is/was valid for use Invariants: ele-1 |
|
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) i Invariants: ele-1 |
|
| clinicalStatus | S ?! | 0..1 | CodeableConcept | Whether the allergy is still current i Binding: allergyintolerance-clinical ( required)Invariants: ele-1 |
| verificationStatus | ?! | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error i Binding: allergyintolerance-verification ( required)Invariants: ele-1 |
| type | 0..1 | code | Whether the reaction is immune-mediated (allergy) or not (intolerance) i Binding: allergy-intolerance-type ( required)Invariants: ele-1 |
|
| category | 0..* | code | The kind of substance the reaction is to i Binding: allergy-intolerance-category ( required)Invariants: ele-1 |
|
| criticality | 0..1 | code | The risk that a future exposure causes serious harm i Binding: allergy-intolerance-criticality ( required)Invariants: ele-1 |
|
| code | S | 1..1 | CodeableConcept | Allergen/substance with raw code support i Binding: allergyintolerance-code ( example)Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| coding | 0..* | Coding | Code defined by a terminology system i Slicing: value:system (open) Invariants: ele-1 |
|
| coding:ccdd | S | 0..* | Coding | CCDD coding -- the ingredient-level drug allergen (system slot only; codes not enumerated) i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| system | 1..1 | uri | Identity of the terminology system i Fixed: http://terminology.hl7.org/CodeSystem/hc-CCDDInvariants: ele-1 |
|
| version | 0..1 | string | Version of the system - if relevant i Invariants: ele-1 |
|
| code | 1..1 | code | Symbol in syntax defined by the system Invariants: ele-1 |
|
| display | 0..1 | string | Representation defined by the system Invariants: ele-1 |
|
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user i Invariants: ele-1 |
|
| coding:atc | S | 0..* | Coding | ATC coding -- coarser ingredient-level allergen grouping (system slot only; codes not enumerated) i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| system | 1..1 | uri | Identity of the terminology system i Fixed: http://www.whocc.no/atcInvariants: ele-1 |
|
| version | 0..1 | string | Version of the system - if relevant i Invariants: ele-1 |
|
| code | 1..1 | code | Symbol in syntax defined by the system Invariants: ele-1 |
|
| display | 0..1 | string | Representation defined by the system Invariants: ele-1 |
|
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user i Invariants: ele-1 |
|
| coding:aigc | S | 0..* | Coding | DPD active-ingredient group CODE (AIGC, 5 digits) -- strength dropped, which is what an allergy means i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| system | 1..1 | uri | Identity of the terminology system i Fixed: http://terminology.hl7.org/CodeSystem/v3-hc-aigcInvariants: ele-1 |
|
| version | 0..1 | string | Version of the system - if relevant i Invariants: ele-1 |
|
| code | 1..1 | code | Symbol in syntax defined by the system Invariants: ele-1 |
|
| display | 0..1 | string | Representation defined by the system Invariants: ele-1 |
|
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user i Invariants: ele-1 |
|
| text | S | 1..1 | string | Human-readable allergen description (required) i Invariants: ele-1 |
| patient | S | 1..1 | Reference(Patient) | Who the allergy or intolerance is for i Invariants: ele-1 |
| encounter | S | 0..1 | Reference(Encounter) | Encounter when allergy was recorded i Invariants: ele-1 |
| onset[x] | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified Invariants: ele-1 |
|
| recordedDate | S | 1..1 | dateTime | Date allergy was first recorded i Invariants: ele-1 |
| recorder | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity Invariants: ele-1 |
|
| asserter | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy i Invariants: ele-1 |
|
| lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction i Invariants: ele-1 |
|
| note | S | 0..* | Annotation | Clinical comments on the allergy or intolerance -- one whole comment per repeat i Invariants: ele-1 |
| reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| substance | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event i Binding: substance-code ( example)Invariants: ele-1 |
|
| manifestation | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event i Binding: clinical-findings ( example)Invariants: ele-1 |
|
| description | 0..1 | string | Description of the event as a whole i Invariants: ele-1 |
|
| onset | 0..1 | dateTime | Date(/time) when manifestations showed Invariants: ele-1 |
|
| severity | 0..1 | code | How severe the reaction event was overall i Binding: reaction-event-severity ( required)Invariants: ele-1 |
|
| exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance i Binding: route-codes ( example)Invariants: ele-1 |
|
| note | 0..* | Annotation | Text about event not captured in other fields i Invariants: ele-1 |