STU 3 Candidate
This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
StructureDefinition for allergyintolerance
{
"resourceType": "StructureDefinition",
"id": "AllergyIntolerance",
"meta": {
"lastUpdated": "2016-03-31T08:01:25.570+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}
],
"url": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"name": "AllergyIntolerance",
"status": "draft",
"publisher": "Health Level Seven International (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"date": "2016-03-31T08:01:25+11:00",
"description": "Base StructureDefinition for AllergyIntolerance Resource",
"requirements": "To record a clinical assessment of a propensity, or potential risk to an individual, of an adverse reaction upon future exposure to the specified substance, or class of substance.",
"fhirVersion": "1.4.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"kind": "resource",
"abstract": false,
"baseType": "DomainResource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"path": "AllergyIntolerance",
"short": "Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)",
"definition": "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.",
"comments": "Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.",
"alias": [
"Allergy",
"Intolerance",
"Adverse Reaction"
],
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
},
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"path": "AllergyIntolerance.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"path": "AllergyIntolerance.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"path": "AllergyIntolerance.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "AllergyIntolerance.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "AllergyIntolerance.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "AllergyIntolerance.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AllergyIntolerance.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AllergyIntolerance.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AllergyIntolerance.identifier",
"short": "External ids for this item",
"definition": "This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IAM-7"
},
{
"identity": "rim",
"map": "id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "AllergyIntolerance.status",
"short": "active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error",
"definition": "Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified Substance.",
"comments": "Decision support would typically raise alerts for 'Unconfirmed', 'Confirmed', and 'Resolved' and ignore a 'Refuted' reaction. In particular, 'Refuted' may be useful for reconciliation of the Adverse Reaction List. Some implementations may choose to make this field mandatory.",
"alias": [
"State"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/allergy-intolerance-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "IAM-17"
},
{
"identity": "rim",
"map": "statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "AllergyIntolerance.type",
"short": "allergy | intolerance - Underlying mechanism (if known)",
"definition": "Identification of the underlying physiological mechanism for the reaction risk.",
"comments": "Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians may not be in a position to distinguish the mechanism of a particular reaction. Often the term \"allergy\" is used rather generically and may overlap with the use of \"intolerance\" - in practice the boundaries between these two concepts may not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.",
"alias": [
"Category",
"Class"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Identification of the underlying physiological mechanism for a Reaction Risk.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/allergy-intolerance-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "IAM-9"
},
{
"identity": "rim",
"map": "code"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "AllergyIntolerance.category",
"short": "food | medication | environment | other - Category of Substance",
"definition": "Category of the identified Substance.",
"comments": "This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the Substance where coding systems are used, and is effectively redundant in that situation.",
"alias": [
"Category",
"Type",
"Reaction Type",
"Class"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Category of an identified Substance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/allergy-intolerance-category"
}
},
"mapping": [
{
"identity": "v2",
"map": "AL1-2"
},
{
"identity": "rim",
"map": "value < IntoleranceValue (Agent)"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "AllergyIntolerance.criticality",
"short": "low | high | unable-to-assess",
"definition": "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified Substance.",
"comments": "The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the Substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere).",
"alias": [
"Severity",
"Seriousness",
"Contra-indication",
"Risk"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified Substance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality"
}
},
"mapping": [
{
"identity": "v2",
"map": "AL1-4"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]"
},
{
"identity": "w5",
"map": "grade"
}
]
},
{
"path": "AllergyIntolerance.substance",
"short": "Substance, (or class) considered to be responsible for risk",
"definition": "Identification of a substance, or a class of substances, that is considered to be responsible for the adverse reaction risk.",
"comments": "It is strongly recommended that the substance be coded with a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology available. Additional details about a substance can be specified in the text.",
"alias": [
"Agent"
],
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Type of the substance and Negation codes for reporting no known allergies.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/allergyintolerance-substance-code"
}
},
"mapping": [
{
"identity": "v2",
"map": "AL1-3 / IAM-3"
},
{
"identity": "rim",
"map": ".participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"path": "AllergyIntolerance.patient",
"short": "Who the sensitivity is for",
"definition": "The patient who has the allergy or intolerance.",
"alias": [
"Patient"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "(PID-3)"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"path": "AllergyIntolerance.recordedDate",
"short": "When recorded",
"definition": "Date when the sensitivity was recorded.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IAM-20"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"path": "AllergyIntolerance.recorder",
"short": "Who recorded the sensitivity",
"definition": "Individual who recorded the record and takes responsibility for its content.",
"alias": [
"Author"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "w5",
"map": "who.author"
}
]
},
{
"path": "AllergyIntolerance.reporter",
"short": "Source of the information about the allergy",
"definition": "The source of the information about the allergy that is recorded.",
"comments": "The recorder takes repsonsibility for the content, but can reference the source from where they got it.",
"alias": [
"Source",
"Informant"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IAM-14 (if patient) / IAM-18 (if practitioner)"
},
{
"identity": "rim",
"map": ".participation[typeCode=INF].role"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"path": "AllergyIntolerance.onset",
"short": "Date(/time) when manifestations showed",
"definition": "Record of the date and/or time of the onset of the Allergy or Intolerance.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "effectiveTime.low"
}
]
},
{
"path": "AllergyIntolerance.lastOccurence",
"short": "Date(/time) of last known occurrence of a reaction",
"definition": "Represents the date and/or time of the last known occurrence of a reaction event.",
"comments": "This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime"
}
]
},
{
"path": "AllergyIntolerance.note",
"short": "Additional text not captured in other fields",
"definition": "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.",
"comments": "For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the Substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "rim",
"map": "subjectOf.observationEvent[code=\"annotation\"].value"
}
]
},
{
"path": "AllergyIntolerance.reaction",
"short": "Adverse Reaction Events linked to exposure to substance",
"definition": "Details about each adverse reaction event linked to exposure to the identified Substance.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]"
}
]
},
{
"path": "AllergyIntolerance.reaction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AllergyIntolerance.reaction.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AllergyIntolerance.reaction.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AllergyIntolerance.reaction.substance",
"short": "Specific substance considered to be responsible for event",
"definition": "Identification of the specific substance considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different to the substance identified as the cause of the risk, but must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite substance that includes the identified substance. It must be clinically safe to only process the AllergyIntolerance.substance and ignore the AllergyIntolerance.event.substance.",
"comments": "Coding of the specific substance with a terminology capable of triggering decision support should be used wherever possible. The substance field allows for the use of a specific substance or a group or class of substances, for example \"Penicillins\". The specific substance field could be used for Amoxycillin. Duplication is acceptable when a specific substance has been recorded in the 'substance' field.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Codes defining the type of the substance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/substance-code"
}
},
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]"
}
]
},
{
"path": "AllergyIntolerance.reaction.certainty",
"short": "unlikely | likely | confirmed - clinical certainty about the specific substance",
"definition": "Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event.",
"alias": [
"Cause"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Statement about the degree of clinical certainty that a Specific Substance was the cause of the Manifestation in an reaction event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/reaction-event-certainty"
}
},
"mapping": [
{
"identity": "rim",
"map": "uncertaintyCode"
}
]
},
{
"path": "AllergyIntolerance.reaction.manifestation",
"short": "Clinical symptoms/signs associated with the Event",
"definition": "Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.",
"comments": "Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.",
"alias": [
"Symptoms",
"Signs"
],
"min": 1,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/manifestation-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "AL1-5"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "AllergyIntolerance.reaction.description",
"short": "Description of the event as a whole",
"definition": "Text description about the reaction as a whole, including details of the manifestation if required.",
"comments": "Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.",
"alias": [
"Narrative",
"Text"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "text"
}
]
},
{
"path": "AllergyIntolerance.reaction.onset",
"short": "Date(/time) when manifestations showed",
"definition": "Record of the date and/or time of the onset of the Reaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "AL1-6"
},
{
"identity": "rim",
"map": "effectiveTime.low"
}
]
},
{
"path": "AllergyIntolerance.reaction.severity",
"short": "mild | moderate | severe (of event as a whole)",
"definition": "Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.",
"comments": "It is acknowledged that this assessment is very subjective. There may be some some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/reaction-event-severity"
}
},
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]"
}
]
},
{
"path": "AllergyIntolerance.reaction.exposureRoute",
"short": "How the subject was exposed to the substance",
"definition": "Identification of the route by which the subject was exposed to the substance.",
"comments": "Coding of the route of exposure with a terminology should be used wherever possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/route-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode"
}
]
},
{
"path": "AllergyIntolerance.reaction.note",
"short": "Text about event not captured in other fields",
"definition": "Additional text about the adverse reaction event not captured in other fields.",
"comments": "Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "rim",
"map": "subjectOf.observationEvent[code=\"annotation\"].value"
}
]
}
]
},
"differential": {
"element": [
{
"path": "AllergyIntolerance",
"short": "Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)",
"definition": "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.",
"comments": "Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.",
"alias": [
"Allergy",
"Intolerance",
"Adverse Reaction"
],
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
},
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"path": "AllergyIntolerance.identifier",
"short": "External ids for this item",
"definition": "This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IAM-7"
},
{
"identity": "rim",
"map": "id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "AllergyIntolerance.status",
"short": "active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error",
"definition": "Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified Substance.",
"comments": "Decision support would typically raise alerts for 'Unconfirmed', 'Confirmed', and 'Resolved' and ignore a 'Refuted' reaction. In particular, 'Refuted' may be useful for reconciliation of the Adverse Reaction List. Some implementations may choose to make this field mandatory.",
"alias": [
"State"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/allergy-intolerance-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "IAM-17"
},
{
"identity": "rim",
"map": "statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "AllergyIntolerance.type",
"short": "allergy | intolerance - Underlying mechanism (if known)",
"definition": "Identification of the underlying physiological mechanism for the reaction risk.",
"comments": "Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians may not be in a position to distinguish the mechanism of a particular reaction. Often the term \"allergy\" is used rather generically and may overlap with the use of \"intolerance\" - in practice the boundaries between these two concepts may not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.",
"alias": [
"Category",
"Class"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Identification of the underlying physiological mechanism for a Reaction Risk.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/allergy-intolerance-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "IAM-9"
},
{
"identity": "rim",
"map": "code"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "AllergyIntolerance.category",
"short": "food | medication | environment | other - Category of Substance",
"definition": "Category of the identified Substance.",
"comments": "This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the Substance where coding systems are used, and is effectively redundant in that situation.",
"alias": [
"Category",
"Type",
"Reaction Type",
"Class"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Category of an identified Substance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/allergy-intolerance-category"
}
},
"mapping": [
{
"identity": "v2",
"map": "AL1-2"
},
{
"identity": "rim",
"map": "value < IntoleranceValue (Agent)"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "AllergyIntolerance.criticality",
"short": "low | high | unable-to-assess",
"definition": "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified Substance.",
"comments": "The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the Substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere).",
"alias": [
"Severity",
"Seriousness",
"Contra-indication",
"Risk"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified Substance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality"
}
},
"mapping": [
{
"identity": "v2",
"map": "AL1-4"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]"
},
{
"identity": "w5",
"map": "grade"
}
]
},
{
"path": "AllergyIntolerance.substance",
"short": "Substance, (or class) considered to be responsible for risk",
"definition": "Identification of a substance, or a class of substances, that is considered to be responsible for the adverse reaction risk.",
"comments": "It is strongly recommended that the substance be coded with a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology available. Additional details about a substance can be specified in the text.",
"alias": [
"Agent"
],
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Type of the substance and Negation codes for reporting no known allergies.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/allergyintolerance-substance-code"
}
},
"mapping": [
{
"identity": "v2",
"map": "AL1-3 / IAM-3"
},
{
"identity": "rim",
"map": ".participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"path": "AllergyIntolerance.patient",
"short": "Who the sensitivity is for",
"definition": "The patient who has the allergy or intolerance.",
"alias": [
"Patient"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "(PID-3)"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"path": "AllergyIntolerance.recordedDate",
"short": "When recorded",
"definition": "Date when the sensitivity was recorded.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IAM-20"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"path": "AllergyIntolerance.recorder",
"short": "Who recorded the sensitivity",
"definition": "Individual who recorded the record and takes responsibility for its content.",
"alias": [
"Author"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "w5",
"map": "who.author"
}
]
},
{
"path": "AllergyIntolerance.reporter",
"short": "Source of the information about the allergy",
"definition": "The source of the information about the allergy that is recorded.",
"comments": "The recorder takes repsonsibility for the content, but can reference the source from where they got it.",
"alias": [
"Source",
"Informant"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IAM-14 (if patient) / IAM-18 (if practitioner)"
},
{
"identity": "rim",
"map": ".participation[typeCode=INF].role"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"path": "AllergyIntolerance.onset",
"short": "Date(/time) when manifestations showed",
"definition": "Record of the date and/or time of the onset of the Allergy or Intolerance.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "effectiveTime.low"
}
]
},
{
"path": "AllergyIntolerance.lastOccurence",
"short": "Date(/time) of last known occurrence of a reaction",
"definition": "Represents the date and/or time of the last known occurrence of a reaction event.",
"comments": "This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime"
}
]
},
{
"path": "AllergyIntolerance.note",
"short": "Additional text not captured in other fields",
"definition": "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.",
"comments": "For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the Substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "rim",
"map": "subjectOf.observationEvent[code=\"annotation\"].value"
}
]
},
{
"path": "AllergyIntolerance.reaction",
"short": "Adverse Reaction Events linked to exposure to substance",
"definition": "Details about each adverse reaction event linked to exposure to the identified Substance.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]"
}
]
},
{
"path": "AllergyIntolerance.reaction.substance",
"short": "Specific substance considered to be responsible for event",
"definition": "Identification of the specific substance considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different to the substance identified as the cause of the risk, but must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite substance that includes the identified substance. It must be clinically safe to only process the AllergyIntolerance.substance and ignore the AllergyIntolerance.event.substance.",
"comments": "Coding of the specific substance with a terminology capable of triggering decision support should be used wherever possible. The substance field allows for the use of a specific substance or a group or class of substances, for example \"Penicillins\". The specific substance field could be used for Amoxycillin. Duplication is acceptable when a specific substance has been recorded in the 'substance' field.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Codes defining the type of the substance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/substance-code"
}
},
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]"
}
]
},
{
"path": "AllergyIntolerance.reaction.certainty",
"short": "unlikely | likely | confirmed - clinical certainty about the specific substance",
"definition": "Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event.",
"alias": [
"Cause"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Statement about the degree of clinical certainty that a Specific Substance was the cause of the Manifestation in an reaction event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/reaction-event-certainty"
}
},
"mapping": [
{
"identity": "rim",
"map": "uncertaintyCode"
}
]
},
{
"path": "AllergyIntolerance.reaction.manifestation",
"short": "Clinical symptoms/signs associated with the Event",
"definition": "Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.",
"comments": "Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.",
"alias": [
"Symptoms",
"Signs"
],
"min": 1,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/manifestation-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "AL1-5"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "AllergyIntolerance.reaction.description",
"short": "Description of the event as a whole",
"definition": "Text description about the reaction as a whole, including details of the manifestation if required.",
"comments": "Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.",
"alias": [
"Narrative",
"Text"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "text"
}
]
},
{
"path": "AllergyIntolerance.reaction.onset",
"short": "Date(/time) when manifestations showed",
"definition": "Record of the date and/or time of the onset of the Reaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "AL1-6"
},
{
"identity": "rim",
"map": "effectiveTime.low"
}
]
},
{
"path": "AllergyIntolerance.reaction.severity",
"short": "mild | moderate | severe (of event as a whole)",
"definition": "Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.",
"comments": "It is acknowledged that this assessment is very subjective. There may be some some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/reaction-event-severity"
}
},
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]"
}
]
},
{
"path": "AllergyIntolerance.reaction.exposureRoute",
"short": "How the subject was exposed to the substance",
"definition": "Identification of the route by which the subject was exposed to the substance.",
"comments": "Coding of the route of exposure with a terminology should be used wherever possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/route-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode"
}
]
},
{
"path": "AllergyIntolerance.reaction.note",
"short": "Text about event not captured in other fields",
"definition": "Additional text about the adverse reaction event not captured in other fields.",
"comments": "Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "rim",
"map": "subjectOf.observationEvent[code=\"annotation\"].value"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Candidate (v1.4.0-8139) generated on Thu, Mar 31, 2016 08:07+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change