LK NEHR Sri Lanka Patient Summary (IPS based) Implementation Guide
0.1.0 - STU1
LK NEHR Sri Lanka Patient Summary (IPS based) Implementation Guide, published by Ministry of Health, Sri Lanka. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/lk-gov-health-hiu/lk-nehr-fhir-ips/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.health.gov.lk/ips/StructureDefinition/allergy-intolerance | Version: 0.1.0 | |||
Active as of 2024-09-22 | Computable Name: Allergies |
Used to represent the patient's allergies.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AllergyIntoleranceUvIps
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | AllergyIntoleranceUvIps | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
clinicalStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text |
verificationStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text |
type | 1..1 | code | allergy | intolerance - Underlying mechanism (if known) | |
code | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |
text | 1..1 | string | Plain text representation of the concept | |
patient | 1..1 | Reference(Patient) | Who the sensitivity is for | |
encounter | 1..1 | Reference(Target Facility Encounter) | Encounter when the allergy or intolerance was asserted | |
Slices for onset[x] | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | |
onset[x]:onsetDateTime | S | 0..1 | dateTime S | When allergy or intolerance was identified |
recorder | S | 0..1 | Reference(Practitioner | Patient) | Who recorded the sensitivity |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
AllergyIntolerance | C | 0..* | AllergyIntoleranceUvIps | 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 | |||||||||||
abatement-datetime | 0..1 | dateTime | Abatement datetime URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips | |||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
clinicalStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||||||
verificationStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||||
type | SΣ | 1..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||||||
code | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
| ||||||||
coding | S | 0..* | CodingIPS | A reference to a code defined by a terminology system | ||||||||
text | SΣ | 1..1 | string | Plain text representation of the concept | ||||||||
patient | SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for | ||||||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
encounter | 1..1 | Reference(Target Facility Encounter) | Encounter when the allergy or intolerance was asserted | |||||||||
Slices for onset[x] | S | 0..1 | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | |||||||||
onsetDateTime | dateTime | |||||||||||
onset[x]:onsetDateTime | S | 0..1 | dateTime | When allergy or intolerance was identified | ||||||||
recorder | S | 0..1 | Reference(Practitioner | Patient) | Who recorded the sensitivity | ||||||||
reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
manifestation | S | 1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Reaction - SNOMED CT IPS Free Set (preferred): Code for the allergy or intolerance reaction manifestation from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set). | ||||||||
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.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.code | preferred | AllergyIntoleranceUvIps
http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-uv-ips | ||||||||||||
AllergyIntolerance.reaction.manifestation | preferred | AllergyReactionSnomedCtIpsFreeSethttp://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-snomed-ct-ips-free-set | ||||||||||||
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | 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 | error | 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 | 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().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 | 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 | C | 0..* | AllergyIntoleranceUvIps | 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
abatement-datetime | 0..1 | dateTime | Abatement datetime URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips | |||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
identifier | Σ | 0..* | Identifier | External ids for this item | ||||||||
clinicalStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||||||
verificationStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||||
type | SΣ | 1..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 | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
| ||||||||
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 | S | 0..* | CodingIPS | A reference to a code defined by a terminology system | ||||||||
text | SΣ | 1..1 | string | Plain text representation of the concept | ||||||||
patient | SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for | ||||||||
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 | SΣC | 1..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 | Identifier | Logical reference, when literal reference is not known | ||||||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||||||
encounter | 1..1 | Reference(Target Facility Encounter) | Encounter when the allergy or intolerance was asserted | |||||||||
Slices for onset[x] | S | 0..1 | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | |||||||||
onsetDateTime | dateTime S | |||||||||||
onsetAge | Age | |||||||||||
onsetPeriod | Period | |||||||||||
onsetRange | Range | |||||||||||
onsetString | string | |||||||||||
onset[x]:onsetDateTime | S | 0..1 | dateTime S | When allergy or intolerance was identified | ||||||||
recordedDate | 0..1 | dateTime | Date first version of the resource instance was recorded | |||||||||
recorder | S | 0..1 | Reference(Practitioner | Patient) | 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 | 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 | 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 | S | 1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Reaction - SNOMED CT IPS Free Set (preferred): Code for the allergy or intolerance reaction manifestation from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set). | ||||||||
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: 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 | 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/languages from the FHIR Standard | ||||||||||||
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.code | preferred | AllergyIntoleranceUvIps
http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-uv-ips | ||||||||||||
AllergyIntolerance.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||||||||||
AllergyIntolerance.reaction.substance | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard | ||||||||||||
AllergyIntolerance.reaction.manifestation | preferred | AllergyReactionSnomedCtIpsFreeSethttp://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-snomed-ct-ips-free-set | ||||||||||||
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | 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 | error | 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 | 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().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 | 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() |
This structure is derived from AllergyIntoleranceUvIps
Summary
Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AllergyIntoleranceUvIps
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | AllergyIntoleranceUvIps | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) | |
clinicalStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text |
verificationStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text |
type | 1..1 | code | allergy | intolerance - Underlying mechanism (if known) | |
code | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |
text | 1..1 | string | Plain text representation of the concept | |
patient | 1..1 | Reference(Patient) | Who the sensitivity is for | |
encounter | 1..1 | Reference(Target Facility Encounter) | Encounter when the allergy or intolerance was asserted | |
Slices for onset[x] | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | |
onset[x]:onsetDateTime | S | 0..1 | dateTime S | When allergy or intolerance was identified |
recorder | S | 0..1 | Reference(Practitioner | Patient) | Who recorded the sensitivity |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
AllergyIntolerance | C | 0..* | AllergyIntoleranceUvIps | 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 | |||||||||||
abatement-datetime | 0..1 | dateTime | Abatement datetime URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips | |||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
clinicalStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||||||
verificationStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||||
type | SΣ | 1..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||||||
code | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
| ||||||||
coding | S | 0..* | CodingIPS | A reference to a code defined by a terminology system | ||||||||
text | SΣ | 1..1 | string | Plain text representation of the concept | ||||||||
patient | SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for | ||||||||
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
encounter | 1..1 | Reference(Target Facility Encounter) | Encounter when the allergy or intolerance was asserted | |||||||||
Slices for onset[x] | S | 0..1 | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | |||||||||
onsetDateTime | dateTime | |||||||||||
onset[x]:onsetDateTime | S | 0..1 | dateTime | When allergy or intolerance was identified | ||||||||
recorder | S | 0..1 | Reference(Practitioner | Patient) | Who recorded the sensitivity | ||||||||
reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | ||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
manifestation | S | 1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Reaction - SNOMED CT IPS Free Set (preferred): Code for the allergy or intolerance reaction manifestation from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set). | ||||||||
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.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.code | preferred | AllergyIntoleranceUvIps
http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-uv-ips | ||||||||||||
AllergyIntolerance.reaction.manifestation | preferred | AllergyReactionSnomedCtIpsFreeSethttp://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-snomed-ct-ips-free-set | ||||||||||||
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | 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 | error | 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 | 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().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 | 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 | C | 0..* | AllergyIntoleranceUvIps | 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
abatement-datetime | 0..1 | dateTime | Abatement datetime URL: http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips | |||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||
identifier | Σ | 0..* | Identifier | External ids for this item | ||||||||
clinicalStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||||||
verificationStatus | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||||
type | SΣ | 1..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 | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or or a code for absent/unknown allergy.
| ||||||||
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 | S | 0..* | CodingIPS | A reference to a code defined by a terminology system | ||||||||
text | SΣ | 1..1 | string | Plain text representation of the concept | ||||||||
patient | SΣ | 1..1 | Reference(Patient) | Who the sensitivity is for | ||||||||
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 | SΣC | 1..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 | Identifier | Logical reference, when literal reference is not known | ||||||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||||||
encounter | 1..1 | Reference(Target Facility Encounter) | Encounter when the allergy or intolerance was asserted | |||||||||
Slices for onset[x] | S | 0..1 | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | |||||||||
onsetDateTime | dateTime S | |||||||||||
onsetAge | Age | |||||||||||
onsetPeriod | Period | |||||||||||
onsetRange | Range | |||||||||||
onsetString | string | |||||||||||
onset[x]:onsetDateTime | S | 0..1 | dateTime S | When allergy or intolerance was identified | ||||||||
recordedDate | 0..1 | dateTime | Date first version of the resource instance was recorded | |||||||||
recorder | S | 0..1 | Reference(Practitioner | Patient) | 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 | 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 | 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 | S | 1..* | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Allergy Reaction - SNOMED CT IPS Free Set (preferred): Code for the allergy or intolerance reaction manifestation from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set). | ||||||||
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: 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 | 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/languages from the FHIR Standard | ||||||||||||
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodeshttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.code | preferred | AllergyIntoleranceUvIps
http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-uv-ips | ||||||||||||
AllergyIntolerance.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||||||||||
AllergyIntolerance.reaction.substance | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard | ||||||||||||
AllergyIntolerance.reaction.manifestation | preferred | AllergyReactionSnomedCtIpsFreeSethttp://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-snomed-ct-ips-free-set | ||||||||||||
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard | ||||||||||||
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | 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 | error | 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 | 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().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 | 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() |
This structure is derived from AllergyIntoleranceUvIps
Summary
Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron