AllergicOrAdverseReactionEvent Tabular View
COCD_TP146060GB02 | |
AllergyEvent |
This template class constrains the CDA Observation entry class. This template is to record an allergy or adverse reaction event. |
Used by: | |
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="OBS" } |
Model Attribute Description The HL7 attribute classCode uses a code to describe this class as an observation. Implementation in XML Instance
|
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } |
Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as an observation event. Implementation in XML Instance
|
[1..1] [M] code (CV { CNE:CDAObservationType } ) { Fixed="ALLEV" } |
Model Attribute Description The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as a method of admission. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
[1..1] [R] effectiveTime (IVL<TS>) |
Model Attribute Description The HL7 attribute effectiveTime is used for the date and time the allergy or adverse reaction was recorded. Implementation in XML Instance The Interval of Points in Time data type flavour is used to carry this information in the XML element effectiveTime using the value attributes of the of the XML elements low and high. The date range shall be carried as follows: The XML attribute value of the XML elements low and high, shall be populated with a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:
Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.
The XML attribute value of the XML elements low and high should be populated to the level of detail that is available on the sending system. Where no time is recorded or available then:
|
[1..1] [M] id (II) |
Model Attribute Description Implementation in XML Instance The Identifier Global data type flavour is used to carry this information in the XML element id as follows:
|
[1..1] [M] statusCode (CS { CNE:ActStatus } ) { Fixed="completed" } |
Model Attribute Description
The HL7 attribute code uses a code to describe the status of the allergy or adverse reaction event. Implementation in XML Instance The Coded Simple (CS) data type shall be used to carry this information in the XML element code as follows:
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#AllergyEvent" } |
Model Attribute Description
The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] [R] value (CV { CNE:ReactionCategoryType } ) |
Model Attribute Description
The HL7 attribute value uses a code from the ReactionCategoryType vocabulary to describe whether the reaction experienced was an allergy, adverse reaction event, or intolerance. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
Where the type of reaction is not known then:
|
[0..1] author |
This template class constrains the CDA author class. The author of this allergy or adverse reaction event information must be included if the author is different to the document (inherited) author. If there is no known author for the information held on the source system then:
|
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="AUT" } |
Model Attribute Description The HL7 attribute typeCode describes this class as an author participation. Implementation in XML Instance
|
[1..1] [M] contextControlCode (CS { CNE: ContextControl } ) { Fixed="OP" } |
Model Attribute Description The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent act are conducted across to the child act (also associated with the child act). This set of codes also determine how these participations conduct. The conduction can only take place if the contextConductionInd in the actRelationships is set to "true". The value of this attribute is fixed in the HL7 model to "OP":
Implementation in XML Instance
|
[1..1] [M] contentId (II) { "NPFIT-300001#Role" } |
Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at run time with a value from the allowed list contained in the model.
|
[1..1] [M] functionCode (CV { CNE:AuthorFunctionType } ) { Fixed="OA" } |
Model Attribute Description The HL7 attribute functionCode uses a code from the vocabulary AuthorFunctionType to describe the function of the author Implementation in XML Instance
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#author" } |
Model Attribute Description
The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] [R] time (TS) |
Model Attribute Description The HL7 attribute time is used to define the time the author originally recorded the allergy or adverse reaction event. Implementation in XML Instance The XML attribute value of the XML element time shall be populated with the time that author recorded the information using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:
Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present. Where no time is recorded or available then:
|
[1..1] participant (AuthorChoice) |
A link to the choice of author templates. |
[1..1] [M] entryRelationship |
This template class constrains the CDA entryRelationship class. |
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } |
Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a has support relationship. Implementation in XML Instance
|
[1..1] [M] contextConductionInd (BL) { Fixed="true" } |
Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent act is conducted across to the child act (also associated with the child act). Implementation in XML Instance
|
[1..1] [M] seperatableInd (BL) { Fixed="false" } |
Model Attribute Description
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#entryRelationship" } |
Model Attribute Description
The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] [M] causativeAgent (CausativeAgent) |
A link to the causative agent.
|
[0..1] entryRelationship1 |
This template class constrains the CDA entryRelationship class. |
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } |
Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a component. Implementation in XML Instance
|
[1..1] [M] contextConductionInd (BL) { Fixed="true" } |
Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent act is conducted across to the child act (also associated with the child act). Implementation in XML Instance
|
[1..1] [M] seperatableInd (BL) { Fixed="false" } |
Model Attribute Description
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#entryRelationship1" } |
Model Attribute Description
The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] reactionDetails (ReactionDetails) |
A link to the reaction details.
|
[0..1] entryRelationship2 |
This template class constrains the CDA entryRelationship class. A component linking the Allergy Event to Evidence that the causative agent was responsible for the reaction. |
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } |
Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a has support relationship. Implementation in XML Instance
|
[1..1] [M] contextConductionInd (BL) { Fixed="true" } |
Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent act is conducted across to the child act (also associated with the child act). Implementation in XML Instance
|
[1..1] [M] seperatableInd (BL) { Fixed="false" } |
Model Attribute Description
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#entryRelationship2" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] evidence (Evidence) |
A link to the evidence.
|
[0..1] entryRelationship3 |
This template class constrains the CDA entryRelationship class. |
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } |
Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a has support relationship. Implementation in XML Instance
|
[1..1] [M] contextConductionInd (BL) { Fixed="true" } |
Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent act is conducted across to the child act (also associated with the child act). Implementation in XML Instance
|
[1..1] [M] seperatableInd (BL) { Fixed="false" } |
Model Attribute Description
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#entryRelationship3" } |
Model Attribute Description
The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] probabilityOfRecurrence (ProbabilityOfRecurrence) |
A link to the probability of recurrence.
|
[0..1] entryRelationship4 |
This template class constrains the CDA entryRelationship class. |
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } |
Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a has support relationship. Implementation in XML Instance
|
[1..1] [M] contextConductionInd (BL) { Fixed="true" } |
Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent act is conducted across to the child act (also associated with the child act). Implementation in XML Instance
|
[1..1] [M] seperatableInd (BL) { Fixed="false" } |
Model Attribute Description
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#entryRelationship4" } |
Model Attribute Description
The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] dateFirstExperienced (DateFirstExperienced) |
A link to date first experienced.
|
AuthorChoice |
Refers to the choice of authors of an allergy or adverse reaction diagnosis event. |
Used by: AllergyEvent | |
[1..1] : Template1 |
A link to the author templates. |
ReactionDetails |
This template class constrains the CDA Observation entry class. This class is an observation of the reaction details. |
Used by: AllergyEvent | |
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="OBS" } |
Model Attribute Description The HL7 attribute classCode uses a code to describe this class as an observation. Implementation in XML Instance
|
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } |
Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as an observation event. Implementation in XML Instance
|
[1..1] [R] code (CV { CNE:CDAObservationType } ) { Fixed="ALLRD" } |
Model Attribute Description The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as a method of admission. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
[1..1] [R] templateId (II) { Fixed="COCD_TP146060GB02#reactionDetails" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[0..1] text (ST) |
Model Attribute Description
The HL7 attribute
text is used to carry additional comments and clarification about the adverse reaction.
Implementation in XML Instance
The String (ST) data type is used to carry this information in the XML element text as follows
|
[1..1] [M] value (CV { CNE:FindingTypeSnCT } ) |
Model Attribute Description The HL7 attribute value is used to carry a description of the manifestation of the reaction experienced by the patient, for example "Skin rash". This may be represented by either a finding from the SNOMED CT terminology, or as text. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element value as follows: If using a concept from the FindingTypeSnCT vocabulary then
If not using a concept from SNOMED CT then
|
[0..1] entryRelationship5 |
This template class constrains the CDA component class. |
[1..1] [M] typeCode (CS { CNE: COMP } ) |
Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a has support relationship. Implementation in XML Instance
|
[1..1] [M] contextConductionInd (BL) { Fixed="true" } |
Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent act is conducted across to the child act (also associated with the child act). Implementation in XML Instance
|
[1..1] [M] seperatableInd (BL) { Fixed="false" } |
Model Attribute Description
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#entryRelationship5" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] certainty (Certainty) |
A link to certainty.
|
[0..1] entryRelationship6 |
This template class constrains the CDA component class. |
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } |
Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a has support relationship. Implementation in XML Instance
|
[1..1] [M] contextConductionInd (BL) { Fixed="true" } |
Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent act is conducted across to the child act (also associated with the child act). Implementation in XML Instance
|
[1..1] [M] seperatableInd (BL) { Fixed="false" } |
Model Attribute Description
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#entryRelationship6" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] severity (Severity) |
A link to severity.
|
Certainty |
This template class constrains the CDA Observation entry class. This class is an observation of how certain the reaction is thought to have been caused by the agent. |
Used by: ReactionDetails | |
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="OBS" } |
Model Attribute Description The HL7 attribute classCode uses a code to describe this class as an observation. Implementation in XML Instance
|
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } |
Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as an observation event. Implementation in XML Instance
|
[1..1] [M] code (CV { CNE:CDAObservationType } ) { Fixed="ALLCER" } |
Model Attribute Description The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as an certainty of whether the causative agent caused the reactions. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#certainty" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] [M] value (CV { CNE:CertaintySnCT } ) |
Model Attribute Description The HL7 attribute code uses a code from the CertaintySnCT vocabulary to describe the certainty that the adverse reaction was caused by the agent. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
Severity |
This template class constrains the CDA observation class.
This template class is used to hold details of the severity of the adverse reaction. |
Used by: ReactionDetails | |
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="OBS" } |
Model Attribute Description The HL7 attribute classCode uses a code to describe this class as an observation. Implementation in XML Instance
|
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } |
Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as an observation event. Implementation in XML Instance
|
[1..1] [M] code (CV { CNE:CDAObservationType } ) { Fixed="ALLSEV" } |
Model Attribute Description The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as a method of admission. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#severity" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] [M] value (CV { CNE:SeveritySnCT } ) |
Model Attribute Description The HL7 attribute code uses a code from the SeveritySnCT vocabulary to describe the severity of the adverse reaction. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
CausativeAgent |
This template class constrains the CDA Observation entry class. This class is an observation for the causative agent that caused the adverse reaction. |
Used by: AllergyEvent | |
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="OBS" } |
Model Attribute Description The HL7 attribute classCode uses a code to describe this class as an observation. Implementation in XML Instance
|
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } |
Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as an observation event. Implementation in XML Instance
|
[1..1] [M] code (CV { CNE:CDAObservationType } ) { Fixed="ALLCAUS" } |
Model Attribute Description The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as a method of admission. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#causativeAgent" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] [M] value (CV { CNE:CausativeAgentSnCT } ) |
Model Attribute Description The HL7 attribute value uses a concept from the SNOMED CT terminology, or text to represent the causative agent. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element value as follows: If using a concept from SNOMED CT then
If using a text representation the
If there are no known allergies or adverse reactions then
|
Evidence |
This template class constrains the CDA Observation entry class. This class is an observation of the investigations that confirmed the certainty of the diagnosis. |
Used by: AllergyEvent | |
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="OBS" } |
Model Attribute Description The HL7 attribute classCode uses a code to describe this class as an observation. Implementation in XML Instance
|
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } |
Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as an observation event. Implementation in XML Instance
|
[1..1] [M] code (CV { CNE:CDAObservationType } ) { Fixed="ALLEVID" } |
Model Attribute Description The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as a method of admission. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#evidence" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] [M] value (ST) |
Model Attribute Description The String (ST) data type is used to carry this information in the XML element value as follows
|
ProbabilityOfRecurrence |
This template class constrains the CDA Observation entry class. This class is an observation of the probability of the reaction reoccurring. |
Used by: AllergyEvent | |
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="OBS" } |
Model Attribute Description The HL7 attribute classCode uses a code to describe this class as an observation. Implementation in XML Instance
|
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } |
Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as an observation event. Implementation in XML Instance
|
[1..1] [M] code (CV { CNE:CDAObservationType } ) { Fixed="ALLPOR" } |
Model Attribute Description The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as a method of admission. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#probabilityOfRecurrence" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] [M] value (ST) |
Model Attribute Description The String (ST) data type is used to carry this information in the XML element value as follows
|
DateFirstExperienced |
This template class constrains the CDA Observation entry class. This class is an observation of when the reaction was first experienced. |
Used by: AllergyEvent | |
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="OBS" } |
Model Attribute Description The HL7 attribute classCode uses a code to describe this class as an observation. Implementation in XML Instance
|
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } |
Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as an observation event. Implementation in XML Instance
|
[1..1] [M] code (CV { CNE:CDAObservationType } ) { Fixed="ALLDFE" } |
Model Attribute Description The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as a date reaction first experienced. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
[0..1] effectiveTime (TS) |
Model Attribute Description
The HL7 attribute time is used to record the time the allergic or adverse reaction (or intolerance) was first experienced, and a date (to at least the accuracy of year) can be established. Implementation in XML Instance The XML attribute value of the XML element time shall be populated with the time that reaction was first experienced using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146060GB02#dateFirstExperienced" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[0..1] text (ST) |
Model Attribute Description The String (ST) data type is used to carry this information in the XML element text as follows
|