Left: | US Core AllergyIntolerance Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance) |
Right: | US Core AllergyIntolerance Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance) |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/AllergyIntolerance | ||
copyright | Used by permission of HL7 International, all rights reserved Creative Commons License | ||
description | The US Core AllergyIntolerance Profile inherits from the FHIR [AllergyIntolerance](https://hl7.org/fhir/R4/allergyintolerance.html) resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the AllergyIntolerance resource to record, search, and fetch allergies/adverse reactions associated with a patient. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption. | ||
experimental | false | ||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | USCoreAllergyIntolerance | ||
publisher | HL7 International / Cross-Group Projects | ||
purpose | |||
status | active | ||
title | US Core AllergyIntolerance Profile | ||
type | AllergyIntolerance | ||
url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance |
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AllergyIntolerance | C | 0..* | AllergyIntolerance | 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 | C | 0..* | AllergyIntolerance | 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 | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
identifier | Σ | 0..* | Identifier | External ids for this item | Σ | 0..* | Identifier | External ids for this item | |||||||||
clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: ?? (required) | ?!SΣC | 0..1 | CodeableConcept | active | inactive | resolved Binding: ?? (required) | |||||||||
verificationStatus | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: ?? (required) | ?!SΣC | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error Binding: ?? (required) | |||||||||
type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: ?? (required): Identification of the underlying physiological mechanism for a Reaction Risk. | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: ?? (required): Identification of the underlying physiological mechanism for a Reaction Risk. | |||||||||
category | Σ | 0..* | code | food | medication | environment | biologic Binding: ?? (required): Category of an identified substance associated with allergies or intolerances. | Σ | 0..* | code | food | medication | environment | biologic Binding: ?? (required): Category of an identified substance associated with allergies or intolerances. | |||||||||
criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: ?? (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | Σ | 0..1 | code | low | high | unable-to-assess Binding: ?? (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | |||||||||
code | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: ?? (extensible) | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: ?? (extensible) | |||||||||
patient | SΣ | 1..1 | Reference(US Core Patient Profile) | Who the sensitivity is for | SΣ | 1..1 | Reference(US Core Patient Profile) | Who the sensitivity is for | |||||||||
encounter | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||||||||
onset[x] | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified | |||||||||||
recordedDate | 0..1 | dateTime | Date first version of the resource instance was recorded | 0..1 | dateTime | Date first version of the resource instance was recorded | |||||||||||
recorder | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | 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 | Σ | 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 | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||||||||
note | 0..* | Annotation | Additional text not captured in other fields | 0..* | Annotation | Additional text not captured in other fields | |||||||||||
reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 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: ?? (example): Codes defining the type of the substance (including pharmaceutical products). | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: ?? (example): Codes defining the type of the substance (including pharmaceutical products). | |||||||||||
manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: ?? (extensible) | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: ?? (extensible) | |||||||||
description | 0..1 | string | Description of the event as a whole | 0..1 | string | Description of the event as a whole | |||||||||||
onset | 0..1 | dateTime | Date(/time) when manifestations showed | 0..1 | dateTime | Date(/time) when manifestations showed | |||||||||||
severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: ?? (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: ?? (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: ?? (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: ?? (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 | 0..* | Annotation | Text about event not captured in other fields | |||||||||||
Documentation for this format |