3.0.0-alpha - ci-build
Publication Build: This will be filled in by the publication tooling
Official URL: http://hl7.no/fhir/StructureDefinition/no-basis-AllergyIntolerance | Version: 3.0.0-alpha | |||
Active as of 2019-07-03 | Computable Name: NoBasisAllergyIntolerance |
Basis profile for allergy intolerance, to be used in Norway. The profile is adapted to support the norwegian standard for critical information (KI standard).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
sourceofinformation | 0..* | (Complex) | Source of information for Allergy intolerance URL: http://hl7.no/fhir/StructureDefinition/no-basis-sourceofinformation | |
clinicalStatus | 0..1 | CodeableConcept | active | inactive | resolved | |
verificationStatus | 0..1 | CodeableConcept | unconfirmed | presumed | confirmed | refuted | entered-in-error | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification | |
code | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:ATC | 0..* | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.whocc.no/atc | |
coding:FESTSubstance | 0..* | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ehelse.no/FESTSubstance | |
coding:FESTMedication | 0..* | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ehelse.no/FESTMedication | |
patient | 1..1 | Reference(no-basis-Patient) | Who the allergy or intolerance is for | |
reaction | 1..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
manifestation | 1..1 | CodeableReference(Observation) | Clinical symptoms/signs associated with the Event | |
concept | ||||
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:uid:2.16.578.1.12.4.1.1.7497 | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
severity | 0..1 | code | mild | moderate | severe (of event as a whole) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
sourceofinformation | 0..* | (Complex) | Source of information for Allergy intolerance URL: http://hl7.no/fhir/StructureDefinition/no-basis-sourceofinformation | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
clinicalStatus | ?!Σ | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
verificationStatus | ?!Σ | 0..1 | CodeableConcept | unconfirmed | presumed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
patient | Σ | 1..1 | Reference(no-basis-Patient) | Who the allergy or intolerance is for |
reaction | 1..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
manifestation | 1..1 | CodeableReference(Observation) | 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. | |
severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | |
Documentation for this format |
Path | Conformance | ValueSet |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatus |
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindings |
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
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: AllLanguages (required): IETF language tag for a human language | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
sourceofinformation | 0..* | (Complex) | Source of information for Allergy intolerance URL: http://hl7.no/fhir/StructureDefinition/no-basis-sourceofinformation | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External ids for this item |
clinicalStatus | ?!Σ | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
verificationStatus | ?!Σ | 0..1 | CodeableConcept | unconfirmed | presumed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
id | 0..1 | id | 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 | id | 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://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | ΣC | 0..1 | code | Symbol in syntax defined by the system |
display | ΣC | 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 |
type | ΣTU | 0..1 | CodeableConcept | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (preferred): 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 | Σ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: SubstanceProductAndConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:ATC | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.whocc.no/atc |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | ΣC | 0..1 | code | Symbol in syntax defined by the system |
display | ΣC | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
coding:FESTSubstance | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://ehelse.no/FESTSubstance |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | ΣC | 0..1 | code | Symbol in syntax defined by the system |
display | ΣC | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
coding:FESTMedication | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://ehelse.no/FESTMedication |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | ΣC | 0..1 | code | Symbol in syntax defined by the system |
display | ΣC | 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 |
patient | Σ | 1..1 | Reference(no-basis-Patient) | Who the allergy or intolerance is for |
encounter | 0..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 allergy or intolerance was first recorded | |
participant | Σ | 0..* | BackboneElement | Who or what participated in the activities related to the allergy or intolerance and how they were involved |
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 |
function | Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipationRoleType (extensible) |
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization | CareTeam) | Who or what participated in the activities related to the allergy or intolerance |
lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
note | 0..* | Annotation | Additional text not captured in other fields | |
reaction | 1..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
substance | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products). | |
manifestation | 1..1 | CodeableReference(Observation) | 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 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
concept | Σ | 0..1 | CodeableConcept | Reference to a concept (by class) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:uid:2.16.578.1.12.4.1.1.7497 |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | ΣC | 1..1 | code | Symbol in syntax defined by the system |
display | ΣC | 1..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 |
reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) |
description | 0..1 | string | Description of the event as a whole | |
onset | 0..1 | dateTime | Date(/time) when manifestations showed | |
severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | |
exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of exposure to a substance. | |
note | 0..* | Annotation | Text about event not captured in other fields | |
Documentation for this format |
Path | Conformance | ValueSet |
AllergyIntolerance.language | required | AllLanguages |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatus |
AllergyIntolerance.type | preferred | AllergyIntoleranceType |
AllergyIntolerance.category | required | AllergyIntoleranceCategory |
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality |
AllergyIntolerance.code | example | SubstanceProductAndConditionAndNegationCodes |
AllergyIntolerance.participant.function | extensible | ParticipationRoleType |
AllergyIntolerance.reaction.substance | example | SubstanceCode |
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindings |
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodes |
Id | Grade | Path(s) | Details | Requirements |
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: 1 element (7 nested mandatory elements)
Fixed Value: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
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) | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
sourceofinformation | 0..* | (Complex) | Source of information for Allergy intolerance URL: http://hl7.no/fhir/StructureDefinition/no-basis-sourceofinformation | |
clinicalStatus | 0..1 | CodeableConcept | active | inactive | resolved | |
verificationStatus | 0..1 | CodeableConcept | unconfirmed | presumed | confirmed | refuted | entered-in-error | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification | |
code | ||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:ATC | 0..* | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.whocc.no/atc | |
coding:FESTSubstance | 0..* | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ehelse.no/FESTSubstance | |
coding:FESTMedication | 0..* | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ehelse.no/FESTMedication | |
patient | 1..1 | Reference(no-basis-Patient) | Who the allergy or intolerance is for | |
reaction | 1..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
manifestation | 1..1 | CodeableReference(Observation) | Clinical symptoms/signs associated with the Event | |
concept | ||||
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: urn:uid:2.16.578.1.12.4.1.1.7497 | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
severity | 0..1 | code | mild | moderate | severe (of event as a whole) | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
sourceofinformation | 0..* | (Complex) | Source of information for Allergy intolerance URL: http://hl7.no/fhir/StructureDefinition/no-basis-sourceofinformation | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
clinicalStatus | ?!Σ | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
verificationStatus | ?!Σ | 0..1 | CodeableConcept | unconfirmed | presumed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
patient | Σ | 1..1 | Reference(no-basis-Patient) | Who the allergy or intolerance is for |
reaction | 1..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
manifestation | 1..1 | CodeableReference(Observation) | 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. | |
severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | |
Documentation for this format |
Path | Conformance | ValueSet |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatus |
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindings |
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
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: AllLanguages (required): IETF language tag for a human language | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
sourceofinformation | 0..* | (Complex) | Source of information for Allergy intolerance URL: http://hl7.no/fhir/StructureDefinition/no-basis-sourceofinformation | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External ids for this item |
clinicalStatus | ?!Σ | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
verificationStatus | ?!Σ | 0..1 | CodeableConcept | unconfirmed | presumed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatus (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
id | 0..1 | id | 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 | id | 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://terminology.hl7.org/CodeSystem/allergyintolerance-verification |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | ΣC | 0..1 | code | Symbol in syntax defined by the system |
display | ΣC | 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 |
type | ΣTU | 0..1 | CodeableConcept | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (preferred): 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 | Σ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: SubstanceProductAndConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:ATC | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.whocc.no/atc |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | ΣC | 0..1 | code | Symbol in syntax defined by the system |
display | ΣC | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
coding:FESTSubstance | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://ehelse.no/FESTSubstance |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | ΣC | 0..1 | code | Symbol in syntax defined by the system |
display | ΣC | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
coding:FESTMedication | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://ehelse.no/FESTMedication |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | ΣC | 0..1 | code | Symbol in syntax defined by the system |
display | ΣC | 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 |
patient | Σ | 1..1 | Reference(no-basis-Patient) | Who the allergy or intolerance is for |
encounter | 0..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 allergy or intolerance was first recorded | |
participant | Σ | 0..* | BackboneElement | Who or what participated in the activities related to the allergy or intolerance and how they were involved |
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 |
function | Σ | 0..1 | CodeableConcept | Type of involvement Binding: ParticipationRoleType (extensible) |
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device | Organization | CareTeam) | Who or what participated in the activities related to the allergy or intolerance |
lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
note | 0..* | Annotation | Additional text not captured in other fields | |
reaction | 1..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
substance | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products). | |
manifestation | 1..1 | CodeableReference(Observation) | 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 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
concept | Σ | 0..1 | CodeableConcept | Reference to a concept (by class) |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:uid:2.16.578.1.12.4.1.1.7497 |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | ΣC | 1..1 | code | Symbol in syntax defined by the system |
display | ΣC | 1..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 |
reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) |
description | 0..1 | string | Description of the event as a whole | |
onset | 0..1 | dateTime | Date(/time) when manifestations showed | |
severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | |
exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of exposure to a substance. | |
note | 0..* | Annotation | Text about event not captured in other fields | |
Documentation for this format |
Path | Conformance | ValueSet |
AllergyIntolerance.language | required | AllLanguages |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatus |
AllergyIntolerance.type | preferred | AllergyIntoleranceType |
AllergyIntolerance.category | required | AllergyIntoleranceCategory |
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality |
AllergyIntolerance.code | example | SubstanceProductAndConditionAndNegationCodes |
AllergyIntolerance.participant.function | extensible | ParticipationRoleType |
AllergyIntolerance.reaction.substance | example | SubstanceCode |
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindings |
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodes |
Id | Grade | Path(s) | Details | Requirements |
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: 1 element (7 nested mandatory elements)
Fixed Value: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron