Nationella informationsmängder
0.1 - draft
Nationella informationsmängder - Local Development build (v0.1). See the Directory of published versions
Defining URL: | https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/NIMAllergyIntolerance |
Version: | 0.1 |
Name: | NIMAllergyIntolerance |
Title: | Överkänslighetstillstånd |
Status: | Active as of 2021-03-30T19:36:18+02:00 |
Definition: | NIM överkänslighetstillstånd används för att beskriva observationen överkänslighetstillstånd. |
Publisher: | Socialstyrelsen |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://informationsstruktur.socialstyrelsen.se/nim/hos/fhir/StructureDefinition/NIMAllergyIntolerance
Notera att kodverken inte alltid är uttömmande för alla verksamhetsbehov eller alla angelägenheter. Det finns utkast på mer specialiserade urval för de mest vanligt förekommande agens och symptom som inte visas i modellen. För att ta del av dessa urval, kontakta Socialstyrelsens förvaltning.
FHIR note has author and time as optional data on notes so multiple note entries are allowed. Is there a strict reason to restrict cardinality on “Överkänslighetstillstånd.beskrivning”?
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AllergyIntolerance
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) | |
verificationStatus | S | 0..1 | CodeableConcept | Concerning the mappings of the value set, an assumption has been made that a negation can never be suspected. If this assumption is wrong, this should be remodeled, using for example, an certainty extension |
criticality | S | 0..1 | code | ValueSet deviates from the required value set on criticality. A posibility would be to add extension for allvarlighetsgrad as well to preserve data that would have been lost otherwise. (Skadlig/besvärande) |
onset[x] | S | 0..1 | Händelsetid | |
onsetDateTime | dateTime | |||
onsetPeriod | Period | |||
note | S | 0..* | Annotation | Additional text not captured in other fields |
reaction | ||||
substance | S | 0..1 | CodeableConcept | kod från urval agens överkänslighet eller << 105590001 | substans | |
text | 0..1 | string | Fritextangivelse av överkänslighetsagens i de fall då kodat agens saknas eller behöver preciseras ytterligare | |
onset | S | 0..1 | dateTime | Note that reaction.onset only supports dateTime, not interval while NIM specifies both as alternatives. |
severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) |
note | S | 0..* | Annotation | Text about event not captured in other fields |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | I | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External ids for this item |
clinicalStatus | ?!ΣI | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
verificationStatus | ?!SΣI | 0..1 | CodeableConcept | Concerning the mappings of the value set, an assumption has been made that a negation can never be suspected. If this assumption is wrong, this should be remodeled, using for example, an certainty extension 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 | SΣ | 0..1 | code | ValueSet deviates from the required value set on criticality. A posibility would be to add extension for allvarlighetsgrad as well to preserve data that would have been lost otherwise. (Skadlig/besvärande) 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: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. |
patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for |
encounter | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |
onset[x] | S | 0..1 | Händelsetid | |
onsetDateTime | dateTime | |||
onsetPeriod | Period | |||
recordedDate | 0..1 | dateTime | Date first version of the resource instance was recorded | |
recorder | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy |
lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
note | S | 0..* | Annotation | Additional text not captured in other fields |
reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
substance | S | 0..1 | CodeableConcept | kod från urval agens överkänslighet eller << 105590001 | substans | Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products). |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | Σ | 0..1 | string | Fritextangivelse av överkänslighetsagens i de fall då kodat agens saknas eller behöver preciseras ytterligare |
manifestation | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event. | |
description | 0..1 | string | Description of the event as a whole | |
onset | S | 0..1 | dateTime | Note that reaction.onset only supports dateTime, not interval while NIM specifies both as alternatives. |
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: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |
note | S | 0..* | Annotation | Text about event not captured in other fields |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | I | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
verificationStatus | ?!ΣI | 0..1 | CodeableConcept | Concerning the mappings of the value set, an assumption has been made that a negation can never be suspected. If this assumption is wrong, this should be remodeled, using for example, an certainty extension Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
criticality | Σ | 0..1 | code | ValueSet deviates from the required value set on criticality. A posibility would be to add extension for allvarlighetsgrad as well to preserve data that would have been lost otherwise. (Skadlig/besvärande) Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. |
onset[x] | 0..1 | Händelsetid | ||
onsetDateTime | dateTime | |||
onsetPeriod | Period | |||
note | 0..* | Annotation | Additional text not captured in other fields | |
reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
substance | 0..1 | CodeableConcept | kod från urval agens överkänslighet eller << 105590001 | substans | Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products). | |
onset | 0..1 | dateTime | Note that reaction.onset only supports dateTime, not interval while NIM specifies both as alternatives. | |
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. | |
note | 0..* | Annotation | Text about event not captured in other fields | |
Documentation for this format |
This structure is derived from AllergyIntolerance
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) | |
verificationStatus | S | 0..1 | CodeableConcept | Concerning the mappings of the value set, an assumption has been made that a negation can never be suspected. If this assumption is wrong, this should be remodeled, using for example, an certainty extension |
criticality | S | 0..1 | code | ValueSet deviates from the required value set on criticality. A posibility would be to add extension for allvarlighetsgrad as well to preserve data that would have been lost otherwise. (Skadlig/besvärande) |
onset[x] | S | 0..1 | Händelsetid | |
onsetDateTime | dateTime | |||
onsetPeriod | Period | |||
note | S | 0..* | Annotation | Additional text not captured in other fields |
reaction | ||||
substance | S | 0..1 | CodeableConcept | kod från urval agens överkänslighet eller << 105590001 | substans | |
text | 0..1 | string | Fritextangivelse av överkänslighetsagens i de fall då kodat agens saknas eller behöver preciseras ytterligare | |
onset | S | 0..1 | dateTime | Note that reaction.onset only supports dateTime, not interval while NIM specifies both as alternatives. |
severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) |
note | S | 0..* | Annotation | Text about event not captured in other fields |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | I | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External ids for this item |
clinicalStatus | ?!ΣI | 0..1 | CodeableConcept | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
verificationStatus | ?!SΣI | 0..1 | CodeableConcept | Concerning the mappings of the value set, an assumption has been made that a negation can never be suspected. If this assumption is wrong, this should be remodeled, using for example, an certainty extension 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 | SΣ | 0..1 | code | ValueSet deviates from the required value set on criticality. A posibility would be to add extension for allvarlighetsgrad as well to preserve data that would have been lost otherwise. (Skadlig/besvärande) 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: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example): Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. |
patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for |
encounter | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |
onset[x] | S | 0..1 | Händelsetid | |
onsetDateTime | dateTime | |||
onsetPeriod | Period | |||
recordedDate | 0..1 | dateTime | Date first version of the resource instance was recorded | |
recorder | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy |
lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
note | S | 0..* | Annotation | Additional text not captured in other fields |
reaction | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
substance | S | 0..1 | CodeableConcept | kod från urval agens överkänslighet eller << 105590001 | substans | Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products). |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | Σ | 0..1 | string | Fritextangivelse av överkänslighetsagens i de fall då kodat agens saknas eller behöver preciseras ytterligare |
manifestation | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event. | |
description | 0..1 | string | Description of the event as a whole | |
onset | S | 0..1 | dateTime | Note that reaction.onset only supports dateTime, not interval while NIM specifies both as alternatives. |
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: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |
note | S | 0..* | Annotation | Text about event not captured in other fields |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
AllergyIntolerance.language | preferred | CommonLanguages Max Binding: AllLanguages |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes |
AllergyIntolerance.type | required | AllergyIntoleranceType |
AllergyIntolerance.category | required | AllergyIntoleranceCategory |
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality |
AllergyIntolerance.code | example | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes |
AllergyIntolerance.reaction.substance | example | SubstanceCode |
AllergyIntolerance.reaction.manifestation | example | SNOMEDCTClinicalFindings |
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodes |
Id | Path | Details | Requirements |
ait-1 | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
ait-2 | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | 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 | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | AllergyIntolerance.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | AllergyIntolerance.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | AllergyIntolerance.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | AllergyIntolerance.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | AllergyIntolerance.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.clinicalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.verificationStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.criticality | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.onset[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.recordedDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.recorder | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.asserter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.lastOccurrence | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.reaction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.reaction.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | AllergyIntolerance.reaction.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | AllergyIntolerance.reaction.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | AllergyIntolerance.reaction.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | AllergyIntolerance.reaction.substance | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.reaction.substance.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | AllergyIntolerance.reaction.substance.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | AllergyIntolerance.reaction.substance.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.reaction.substance.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.reaction.manifestation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.reaction.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.reaction.onset | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.reaction.severity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.reaction.exposureRoute | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | AllergyIntolerance.reaction.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |