. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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
Profile for allergyintolerance
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance\"><b>AllergyIntolerance</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"This records identifiers associated with this allergy/intolerance concern that are defined by business processed 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).\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External Ids for this item</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Criticality of the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.criticality\"><b>criticality</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"criticality.html\">fatal | high | medium | low</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Type of the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.sensitivityType\"><b>sensitivityType</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"sensitivitytype.html\">allergy | intolerance | unknown</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Date when the sensitivity was recorded.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.recordedDate\"><b>recordedDate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When recorded</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Status of the sensitivity (this element modifies the meaning of other elements)\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"sensitivitystatus.html\">suspected | confirmed | refuted | resolved</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The patient who has the allergy or intolerance.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who the sensitivity is for</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"Indicates who has responsibility for the record.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.recorder\"><b>recorder</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who recorded the sensitivity</span><span style=\"color: Gray\"> --></span></recorder>\r\n <<a title=\"The substance that causes the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.substance\"><b>substance</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"substance.html#Substance\">Substance</a>)</span> <span style=\"color: navy\">The substance that causes the sensitivity</span><span style=\"color: Gray\"> --></span></substance>\r\n <<a title=\"Reactions associated with the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.reaction\"><b>reaction</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"adversereaction.html#AdverseReaction\">AdverseReaction</a>)</span> <span style=\"color: navy\">Reactions associated with the sensitivity</span><span style=\"color: Gray\"> --></span></reaction>\r\n <<a title=\"Observations that confirm or refute the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.html#AllergyIntolerance.sensitivityTest\"><b>sensitivityTest</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"observation.html#Observation\">Observation</a>)</span> <span style=\"color: navy\">\r\n Observations that confirm or refute</span><span style=\"color: Gray\"> --></span></sensitivityTest>\r\n</AllergyIntolerance>\r\n</pre></div>"
},
"name": "allergyintolerance",
"publisher": "FHIR Project",
"description": "Basic Profile. Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Allergy/Intolerance resources are used to provide information about adverse sensitivities to substances that lead to physiologic changes that are clinically observable. An adverse sensitivity is defined as: \r\n\r\nA condition expected to result in undesirable physiologic reaction to an amount of a substance that would not produce a reaction in most individuals. The substance is the trigger of an immunologic response that produces the observed physiologic changes, or in some instances nonimmunologic mechanisms that produce clinically identical physiologic changes. The immunologic response might be considered the actual cause of the reaction, but it is exposure to the trigger substance that is clinically observable. \r\n\r\nThis definition excludes clinically identical episodes that may be caused by physical agents, such as heat, cold, sunlight, or vibration, by exercise activity, or by infectious agents. Those conditions caused by physical agents or infectious would be captured on the problem list (List/Condition Resources). The allergy/intolerance list is a list of conditions that represent a propensity unique to this individual for a reaction upon future exposure to a specified substance. \r\n\r\nNote that this specification draws a distinction between the patients condition/problem list and an allergy/intolerance list, even though allergies and intolerances are also conditions. This is because the distinction is a long established clinical workflow, even to patients. Asking an individual \"if they have any problems\" is not going to invoke an account of their past reactions to medications or foods. Instead, they are asked if they \"have any allergies\". An allergy/intolerance is also different in that a potential harm from exposure to an external substance that may be ordered by a provider in the course of their care but is not inherent to exposure to that substance for the general population.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "AllergyIntolerance",
"publish": true,
"element": [
{
"path": "AllergyIntolerance",
"definition": {
"short": "Drug, food, environmental and others",
"formal": "Indicates the patient has a susceptibility to an adverse reaction upon exposure to a specified substance.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Observation[moodCode=EVN, code<AllergyIntolerance]"
}
]
}
},
{
"path": "AllergyIntolerance.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "AllergyIntolerance.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "AllergyIntolerance.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "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.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "AllergyIntolerance.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "AllergyIntolerance.identifier",
"definition": {
"short": "External Ids for this item",
"formal": "This records identifiers associated with this allergy/intolerance concern that are defined by business processed 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"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "AllergyIntolerance.criticality",
"definition": {
"short": "fatal | high | medium | low",
"formal": "Criticality of the sensitivity.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "Criticality",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/criticality"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"criticality\"].value"
}
]
}
},
{
"path": "AllergyIntolerance.sensitivityType",
"definition": {
"short": "allergy | intolerance | unknown",
"formal": "Type of the sensitivity.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "SensitivityType",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/sensitivitytype"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"sensitivity\"].value"
},
{
"identity": "v2",
"map": "IAM-9-Sensitivity to Causative Agent Code"
}
]
}
},
{
"path": "AllergyIntolerance.recordedDate",
"definition": {
"short": "When recorded",
"formal": "Date when the sensitivity was recorded.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
},
{
"identity": "v2",
"map": "IAM-20-Statused at Date/Time"
}
]
}
},
{
"path": "AllergyIntolerance.status",
"definition": {
"short": "suspected | confirmed | refuted | resolved",
"formal": "Status of the sensitivity.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "SensitivityStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/sensitivitystatus"
}
},
"mapping": [
{
"identity": "rim",
"map": ".status (suspected/confirmed differentiated by uncertaintyCode)"
},
{
"identity": "v2",
"map": "IAM-17-Allergy Clinical Status Code"
}
]
}
},
{
"path": "AllergyIntolerance.subject",
"definition": {
"short": "Who the sensitivity is for",
"formal": "The patient who has the allergy or intolerance.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
}
]
}
},
{
"path": "AllergyIntolerance.recorder",
"definition": {
"short": "Who recorded the sensitivity",
"formal": "Indicates who has responsibility for the record.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
},
{
"identity": "v2",
"map": "IAM-14-Reported By (if patient) / IAM-18-Statused By Person (if practitioner)"
}
]
}
},
{
"path": "AllergyIntolerance.substance",
"definition": {
"short": "The substance that causes the sensitivity",
"formal": "The substance that causes the sensitivity.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Substance"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=ADMM]"
},
{
"identity": "v2",
"map": "AL1-3-Allergen Code/Mnemonic/Description / IAM-3-Allergen Code/Mnemonic/Description"
}
]
}
},
{
"path": "AllergyIntolerance.reaction",
"definition": {
"short": "Reactions associated with the sensitivity",
"formal": "Reactions associated with the sensitivity.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/AdverseReaction"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN, code<AdverseReaction]"
},
{
"identity": "v2",
"map": "IAM-7-Allergy Unique Identifier (Overloaded concept)"
}
]
}
},
{
"path": "AllergyIntolerance.sensitivityTest",
"definition": {
"short": "Observations that confirm or refute",
"formal": "Observations that confirm or refute the sensitivity.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Observation"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN, code<SensitivityTest]"
},
{
"identity": "v2",
"map": "OBX-21-Observation Instance Identifier\n(Subject to Ch7 caveats)"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "Recorded date/time.",
"xpath": "f:AllergyIntolerance/f:recordedDate"
},
{
"name": "recorder",
"type": "reference",
"documentation": "Who recorded the sensitivity",
"xpath": "f:AllergyIntolerance/f:recorder"
},
{
"name": "status",
"type": "token",
"documentation": "The status of the sensitivity",
"xpath": "f:AllergyIntolerance/f:status"
},
{
"name": "subject",
"type": "reference",
"documentation": "The subject that the sensitivity is about",
"xpath": "f:AllergyIntolerance/f:subject"
},
{
"name": "substance",
"type": "reference",
"documentation": "The name or code of the substance that produces the sensitivity",
"xpath": "f:AllergyIntolerance/f:substance"
},
{
"name": "type",
"type": "token",
"documentation": "The type of sensitivity",
"xpath": "f:AllergyIntolerance/f:sensitivityType"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change