This 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
Profile for adversereaction
<Profile xmlns="http://hl7.org/fhir"> <text> <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction" title="Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance."><b>AdverseReaction</b></a> xmlns="http://hl7.org/fhir"> <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span> <!-- 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> --> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.identifier" title="This records identifiers associated with this reaction 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)."><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 adverse reaction</span><span style="color: Gray"> --></span></identifier> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.date" title="The date (and possibly time) when the reaction began."><b>date</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 the reaction occurred</span><span style="color: Gray"> --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.subject" title="The subject of the adverse reaction."><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 had the reaction</span><span style="color: Gray"> --></span></subject> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.didNotOccurFlag" title="If true, indicates that no reaction occurred (this element modifies the meaning of other elements)"><span style="text-decoration: underline"><b>didNotOccurFlag</b></span></a> value="[<span style="color: darkgreen"><a href="datatypes.html#boolean">boolean</a></span>]"/><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Indicates lack of reaction</span><span style="color: Gray"> --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.recorder" title="Identifies the individual responsible for the information in the reaction record."><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 reaction</span><span style="color: Gray"> --></span></recorder> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.symptom" title="The signs and symptoms that were observed as part of the reaction."><b>symptom</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> What was reaction? --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.symptom.code" title="Indicates the specific sign or symptom that was observed."><b>code</b></a>><span style="color: Gray"><!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="http://apps.who.int/classifications/icd10/browse/2010/en.html" style="color: navy">E.g. Rash, vomiting</a></span><span style="color: Gray"> --></span></code> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.symptom.severity" title="The severity of the sign or symptom."><b>severity</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 href="reactionSeverity.html" style="color: navy">severe | serious | moderate | minor</a></span><span style="color: Gray"> --></span> </symptom> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure" title="An exposure to a substance that preceded a reaction occurrence."><b>exposure</b></a>> <span style="color: Gray"><!-- <span style="color: brown"><b>0..*</b></span> Suspected substance --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure.date" title="Identifies the initial date of the exposure that is suspected to be related to the reaction."><b>date</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 the exposure occurred</span><span style="color: Gray"> --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure.type" title="The type of exposure: Drug Administration, Immunization, Coincidental."><b>type</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 href="exposureType.html" style="color: navy">drugadmin | immuniz | coincidental</a></span><span style="color: Gray"> --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure.causalityExpectation" title="A statement of how confident that the recorder was that this exposure caused the reaction."><b>causalityExpectation</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 href="causalityExpectation.html" style="color: navy">likely | unlikely | confirmed | unknown</a></span><span style="color: Gray"> --></span> <<a class="dict" href="adversereaction-definitions.html#AdverseReaction.exposure.substance" title="Substance that is presumed to have caused the adverse reaction."><b>substance</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="substance.html#Substance">Substance</a>)</span> <span style="color: navy">Presumed causative substance</span><span style="color: Gray"> --></span></substance> </exposure> </AdverseReaction> </pre></div> </text> <name value="adversereaction"/> <publisher value="FHIR Project"/> <description value="Basic Profile. Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance."/> <status value="draft"/> <date value="2014-09-30"/> <requirements value="Scope and Usage Adverse Reaction resources are used to provide information about specific reactions to a substance. These are normally associated with an AllergyIntolerance resource, but can be reported on their own when no assumption of further reactions is being made, or when specific events are being described."/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <structure> <type value="AdverseReaction"/> <publish value="true"/> <element> <path value="AdverseReaction"/> <definition> <short value="Specific reactions to a substance"/> <formal value="Records an unexpected reaction suspected to be related to the exposure of the reaction subject to a substance."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="Observation[classCode=OBS, moodCode=EVN]"/> </mapping> <mapping> <identity value="v2"/> <map value="IAM-11-Onset Date (Does not allow for IAM-12-Onset Date Text)"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="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 value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="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 value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.text"/> <definition> <short value="Text summary of the resource, for human interpretation"/> <formal value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <synonym value="narrative"/> <synonym value="html"/> <synonym value="xhtml"/> <synonym value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.contained"/> <definition> <short value="Contained, inline Resources"/> <formal value="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 value="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 value="inline resources"/> <synonym value="anonymous resources"/> <synonym value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.identifier"/> <definition> <short value="External Ids for this adverse reaction"/> <formal value="This records identifiers associated with this reaction 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 value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.date"/> <definition> <short value="When the reaction occurred"/> <formal value="The date (and possibly time) when the reaction began."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="effectiveTime"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.subject"/> <definition> <short value="Who had the reaction"/> <formal value="The subject of the adverse reaction."/> <min value="1"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=SBJ]"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3-Patient ID List"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.didNotOccurFlag"/> <definition> <short value="Indicates lack of reaction"/> <formal value="If true, indicates that no reaction occurred."/> <comments value="Note that the normal case is false, which is a double negative - it's not true that this reaction did not occur. The normal case is to assert that a reaction did happen."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="actionNegationInd"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.recorder"/> <definition> <short value="Who recorded the reaction"/> <formal value="Identifies the individual responsible for the information in the reaction record."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Practitioner"/> </type> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Patient"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=AUT]"/> </mapping> <mapping> <identity value="v2"/> <map value="IAM-14-Reported By (if patient) / IAM-18-Statused By Person (if practitioner)"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.symptom"/> <definition> <short value="What was reaction?"/> <formal value="The signs and symptoms that were observed as part of the reaction."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=<<symptom>>]"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.symptom.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="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 value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.symptom.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="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 value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.symptom.code"/> <definition> <short value="E.g. Rash, vomiting"/> <formal value="Indicates the specific sign or symptom that was observed."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="SymptomType"/> <isExtensible value="true"/> <conformance value="preferred"/> <referenceUri value="http://apps.who.int/classifications/icd10/browse/2010/en"/> </binding> <mapping> <identity value="rim"/> <map value="value"/> </mapping> <mapping> <identity value="v2"/> <map value="IAR-1"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.symptom.severity"/> <definition> <short value="severe | serious | moderate | minor"/> <formal value="The severity of the sign or symptom."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ReactionSeverity"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/reactionSeverity"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=<<severity>> ].value"/> </mapping> <mapping> <identity value="v2"/> <map value="AL1-4-Allergy Severity Code / IAM-4-Allergy Severity Code"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.exposure"/> <definition> <short value="Suspected substance"/> <formal value="An exposure to a substance that preceded a reaction occurrence."/> <comments value="Multiple repetitions are used to indicate multiple potential causes for the reaction."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="outboundRelationship[typeCode=SAS].target[classCode=EXPOS, moodCode=EVN]"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.exposure.extension"/> <definition> <short value="Additional Content defined by implementations"/> <formal value="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 value="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 value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.exposure.modifierExtension"/> <definition> <short value="Extensions that cannot be ignored"/> <formal value="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 value="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 value="extensions"/> <synonym value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </definition> </element> <element> <path value="AdverseReaction.exposure.date"/> <definition> <short value="When the exposure occurred"/> <formal value="Identifies the initial date of the exposure that is suspected to be related to the reaction."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="effectiveTime"/> </mapping> <mapping> <identity value="v2"/> <map value="(V2 does not define distinct concepts of exposure date and reaction date)"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.exposure.type"/> <definition> <short value="drugadmin | immuniz | coincidental"/> <formal value="The type of exposure: Drug Administration, Immunization, Coincidental."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ExposureType"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/exposureType"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="code"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.exposure.causalityExpectation"/> <definition> <short value="likely | unlikely | confirmed | unknown"/> <formal value="A statement of how confident that the recorder was that this exposure caused the reaction."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="CausalityExpectation"/> <isExtensible value="false"/> <conformance value="required"/> <referenceResource> <reference value="http://hl7.org/fhir/vs/causalityExpectation"/> </referenceResource> </binding> <mapping> <identity value="rim"/> <map value="inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=<<ReactionRelatedn ess>, ].value Note: Observation also needs to have a subject of the Adverse Reaction itself (i.e. it's expressing relatedness of exposure & reaction)"/> </mapping> <mapping> <identity value="v2"/> <map value="IAM-17-Allergy Clinical Status Code"/> </mapping> </definition> </element> <element> <path value="AdverseReaction.exposure.substance"/> <definition> <short value="Presumed causative substance"/> <formal value="Substance that is presumed to have caused the adverse reaction."/> <min value="0"/> <max value="1"/> <type> <code value="ResourceReference"/> <profile value="http://hl7.org/fhir/profiles/Substance"/> </type> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="participation[typeCode=EXPAGNT]"/> </mapping> <mapping> <identity value="v2"/> <map value="AL1-3 / IAM-3 Allergen Code/Mnemonic/Description"/> </mapping> </definition> </element> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/> </searchParam> <searchParam> <name value="_language"/> <type value="token"/> <documentation value="The language of the resource"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> <documentation value="The date of the reaction"/> <xpath value="f:AdverseReaction/f:date"/> </searchParam> <searchParam> <name value="subject"/> <type value="reference"/> <documentation value="The subject that the sensitivity is about"/> <xpath value="f:AdverseReaction/f:subject"/> </searchParam> <searchParam> <name value="substance"/> <type value="reference"/> <documentation value="The name or code of the substance that produces the sensitivity"/> <xpath value="f:AdverseReaction/f:exposure/f:substance"/> </searchParam> <searchParam> <name value="symptom"/> <type value="token"/> <documentation value="One of the symptoms of the reaction"/> <xpath value="f:AdverseReaction/f:symptom/f:code"/> </searchParam> </structure> </Profile>
© 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