Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/Virtually-Healthcare-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir.virtually.healthcare/StructureDefinition/AllergyIntolerance | Version: 0.1.0-current | |||
| Draft as of 2024-11-06 | Computable Name: AllergyIntolerance | |||
Extension to UKCore AllergyIntolerance and includes elements from HL7 International Patient Access
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from UKCoreAllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance |
0..* | UKCoreAllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
  Slices for identifier |
S | 1..* | Identifier | External ids for this item Slice: Unordered, Closed by pattern:system |
   identifier:CommonResourceIdentifiers |
0..* | CommonResourceIdentifiers | Common Resource Identifiers | |
  patient |
1..1 | Reference(Patient) | Who the sensitivity is for | |
  identifier |
0..1 | NHSNumbers | An identifier intended for computation | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | UKCoreAllergyIntolerance | 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 |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| evidence |
N | 0..* | Reference(DiagnosticReport) | A reference to results of investigations that confirmed the certainty of the diagnosis. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence |
 modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| Slices for identifier |
SΣ | 1..* | Identifier | External ids for this item Slice: Unordered, Closed by pattern:system |
| identifier:CommonResourceIdentifiers |
0..* | CommonResourceIdentifiers | Common Resource Identifiers | |
| clinicalStatus |
?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
| Slices for extension |
Content/Rules for all slices | |||
| allergyIntoleranceEnd |
N | 0..1 | (Complex) | Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd |
| verificationStatus |
?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
| code |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: UK Core Allergy Code (preferred): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. |
| patient |
SΣC | 1..1 | Reference(Patient) | Who the sensitivity is for ref-1: SHALL have a contained resource if a local reference is provided |
| identifier |
0..1 | NHSNumbers | An identifier intended for computation | |
| reaction |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: UK Core Allergy Manifestation (preferred): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event. | |
| severity |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1from the FHIR Standard | |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1from the FHIR Standard | |
| AllergyIntolerance.code | preferred | UKCoreAllergyCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode | |
| AllergyIntolerance.reaction.manifestation | preferred | UKCoreAllergyManifestationhttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestation | |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | UKCoreAllergyIntolerance | 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| evidence |
N | 0..* | Reference(DiagnosticReport) | A reference to results of investigations that confirmed the certainty of the diagnosis. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence | ||||
| modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| Slices for identifier |
SΣ | 1..* | Identifier | External ids for this item Slice: Unordered, Closed by pattern:system | ||||
| identifier:CommonResourceIdentifiers |
0..* | CommonResourceIdentifiers | Common Resource Identifiers | |||||
| clinicalStatus |
?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| allergyIntoleranceEnd |
N | 0..1 | (Complex) | Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd | ||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| verificationStatus |
?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||
| type |
Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
| category |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
| criticality |
Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
| code |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: UK Core Allergy Code (preferred): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. | ||||
| patient |
SΣC | 1..1 | Reference(Patient) | Who the sensitivity is for ref-1: SHALL have a contained resource if a local reference is provided | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
0..1 | NHSNumbers | An identifier intended for computation | |||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter |
C | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted ref-1: SHALL have a contained resource if a local reference is provided | ||||
 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 |
C | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity ref-1: SHALL have a contained resource if a local reference is provided | ||||
| asserter |
ΣC | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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: UK Core Allergy Substance (preferred): Codes defining the type of the substance (including pharmaceutical products). | |||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: UK Core Allergy Manifestation (preferred): 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 |
S | 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: UK Core Substance Or Product Administration Route (preferred): 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| AllergyIntolerance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.code | preferred | UKCoreAllergyCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode | ||||
| AllergyIntolerance.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| AllergyIntolerance.reaction.substance | preferred | UKCoreAllergySubstancehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance | ||||
| AllergyIntolerance.reaction.manifestation | preferred | UKCoreAllergyManifestationhttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestation | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.reaction.exposureRoute | preferred | UKCoreSubstanceOrProductAdministrationRoutehttps://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute |
This structure is derived from UKCoreAllergyIntolerance
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from UKCoreAllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance |
0..* | UKCoreAllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
| Slices for identifier |
S | 1..* | Identifier | External ids for this item Slice: Unordered, Closed by pattern:system |
| identifier:CommonResourceIdentifiers |
0..* | CommonResourceIdentifiers | Common Resource Identifiers | |
| patient |
1..1 | Reference(Patient) | Who the sensitivity is for | |
| identifier |
0..1 | NHSNumbers | An identifier intended for computation | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | UKCoreAllergyIntolerance | 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 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| evidence |
N | 0..* | Reference(DiagnosticReport) | A reference to results of investigations that confirmed the certainty of the diagnosis. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence |
| modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| Slices for identifier |
SΣ | 1..* | Identifier | External ids for this item Slice: Unordered, Closed by pattern:system |
| identifier:CommonResourceIdentifiers |
0..* | CommonResourceIdentifiers | Common Resource Identifiers | |
| clinicalStatus |
?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
| Slices for extension |
Content/Rules for all slices | |||
| allergyIntoleranceEnd |
N | 0..1 | (Complex) | Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd |
| verificationStatus |
?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
| code |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: UK Core Allergy Code (preferred): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. |
| patient |
SΣC | 1..1 | Reference(Patient) | Who the sensitivity is for ref-1: SHALL have a contained resource if a local reference is provided |
| identifier |
0..1 | NHSNumbers | An identifier intended for computation | |
| reaction |
S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: UK Core Allergy Manifestation (preferred): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event. | |
| severity |
S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1from the FHIR Standard | |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1from the FHIR Standard | |
| AllergyIntolerance.code | preferred | UKCoreAllergyCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode | |
| AllergyIntolerance.reaction.manifestation | preferred | UKCoreAllergyManifestationhttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestation | |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | UKCoreAllergyIntolerance | 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| evidence |
N | 0..* | Reference(DiagnosticReport) | A reference to results of investigations that confirmed the certainty of the diagnosis. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Evidence | ||||
| modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| Slices for identifier |
SΣ | 1..* | Identifier | External ids for this item Slice: Unordered, Closed by pattern:system | ||||
| identifier:CommonResourceIdentifiers |
0..* | CommonResourceIdentifiers | Common Resource Identifiers | |||||
| clinicalStatus |
?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| allergyIntoleranceEnd |
N | 0..1 | (Complex) | Supports the date when the allergy or intolerance was no longer valid, and/or, the reason why the allergy or intolerance is no longer valid. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AllergyIntoleranceEnd | ||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| verificationStatus |
?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||
| type |
Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
| category |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
| criticality |
Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
| code |
SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: UK Core Allergy Code (preferred): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. | ||||
| patient |
SΣC | 1..1 | Reference(Patient) | Who the sensitivity is for ref-1: SHALL have a contained resource if a local reference is provided | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
0..1 | NHSNumbers | An identifier intended for computation | |||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter |
C | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 |
C | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity ref-1: SHALL have a contained resource if a local reference is provided | ||||
| asserter |
ΣC | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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: UK Core Allergy Substance (preferred): Codes defining the type of the substance (including pharmaceutical products). | |||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: UK Core Allergy Manifestation (preferred): 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 |
S | 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: UK Core Substance Or Product Administration Route (preferred): 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| AllergyIntolerance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.code | preferred | UKCoreAllergyCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyCode | ||||
| AllergyIntolerance.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| AllergyIntolerance.reaction.substance | preferred | UKCoreAllergySubstancehttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergySubstance | ||||
| AllergyIntolerance.reaction.manifestation | preferred | UKCoreAllergyManifestationhttps://fhir.hl7.org.uk/ValueSet/UKCore-AllergyManifestation | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.reaction.exposureRoute | preferred | UKCoreSubstanceOrProductAdministrationRoutehttps://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute |
This structure is derived from UKCoreAllergyIntolerance
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron