Structured Headings
Domain Message Specification

Version: 1.0; Status: RC3

AllergyPropensity Tabular View

COCD_TP146061GB01
Allergy

This template class constrains the CDA Observation entry class.

This template is used to record that a patient has a propensity of an allergic reaction or adverse reaction to a substance, food or drug. This template is used to populate the patients Allergy and Adverse Reaction list.
Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="COND" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a condition.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "COND".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as a condition event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CD { CNE:AllergyOrAdverseReactionIdentSnCT } )

Model Attribute Description

The HL7 attribute value uses one or more SNOMED CT concepts to describe the propensity of an allergy or adverse reaction.

Implementation in XML Instance

The Concept Descriptor (CD) data type shall be used to carry this information in the XML element value as follows:

  • The XML attribute code shall contain a value from the AllergyOrAdverseReactionIdentSnCT vocabulary.
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15"
  • The XML attribute displayName shall carry the description associated with the SNOMED CT concept. It is recommended that the preferred term is used.
  • The XML element originalText can be used to carry an XML element reference. This can be used to link the coded item to the relevant text in the CDA section
  • The XML element qualifier may be populated if post coordination or translation is required. For further information, see the CD data type guidance linked on the left hand side.
[1..1] [M] effectiveTime (IVL<TS>)

Model Attribute Description

The HL7 attribute effectiveTime is used for the time the diagnosis of a allergy or adverse reaction propensity is valid.

Where known the dates that the propensity was effective for the patient should be recorded, i.e when the patient started with an allergy or adverse reaction and when the allergy or adverse reaction was no longer present for the patient.

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:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minute
  • ss is seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

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 Time Interval Complete data type shall be used:
  • The XML attribute value of the XML element low shall be populated with a 'start date' time stamp to indicate the onset of the allergy or adverse reaction.
  • The XML attribute value of the XML element high may be populated with an 'end date' time stamp to indicate when allergy or adverse reaction was no longer 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.

[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an identifier to identify the instance of the propensity of an allergy or adverse reaction event .

Implementation in XML Instance

The Identifier Global data type flavour is used to carry this information in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.
[1..1] [M] statusCode (CS { CNE:ActStatus } )
{ Default="active" }

Model Attribute Description

The HL7 attribute statusCode uses a code to describe the status of the identified allergy or adverse reaction.

Implementation in XML Instance

The Coded Only datatype flavour is used to carry this information as follows:

The XML attribute code of the XML element statusCode will contain a one of the following codes from the ActStatus vocabulary:

  • active - the allergy or averse reaction is active.
  • completed - the allergy or adverse reaction is no longer applicable.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146061GB01#Allergy" }
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:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146061GB01#Allergy".
[0..1] author

This template class constrains the CDA author class.

The author of this allergy or adverse reaction propensity 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:

  • The information may be included and the document author will be deemed to be the author (by inheritance). The author should be asked to decide whether this is acceptable or not.
  • If the document author does not want to be considered as the author of the information then information must not be included in the document.
[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

  • The XML attribute typeCode is fixed to "AUT".
[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":

  • "O" (Overriding) - the author replaces any author that has been conducted from any previous acts.
  • "P" (Propagating) - the author is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP"
[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.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[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

The Coded Plain data type flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element functionCode as follows:

  • The XML attribute code is fixed to "OA"
  • The XML attribute codeSystem is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.17.178"
  • The XML attribute displayName is fixed to the author's function name "Originating Author".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146061GB01#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:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146061GB01#author".
[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 propensity.

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:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

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:

  • The XML attribute nullFlavor of the XML element time shall contain the value "UNK"
[1..1] participant (AuthorChoice)

A link to the choice of author templates.
[0..*] entryRelationship

This template class constrains the CDA entryRelationship class.

Has support is a type of has pertinent information in which the target provides supporting evidence for an observation (source).

The author of the observation is asserting that their finding is supported by a previous action, event or condition.

In the context of this template the finding is information which supports the allergy or adverse reaction diagnosis.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="SPRT" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a has support relationship.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "SPRT".
[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

  • The XML attribute contextConductionInd is fixed to "true".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146061GB01#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:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146061GB01#entryRelationship".
[1..1] supportingFinding (Finding)
A link to the supporting finding.
[0..*] entryRelationship1

This template class constrains the CDA entryRelationship class.

Has support is a type of has pertinent information in which the target provides supporting evidence for an observation (source).

The author of the observation is asserting that the propensity is supported by a previous action, event or condition.

In the context of this template the propensity is supported by the referenced allergy or adverse reaction diagnosis event.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="SPRT" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a has support relationship.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "SPRT".
[1..1] [M] contextConductionInd (BL)
{ Fixed="false" }

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

  • The XML attribute contextConductionInd is fixed to "false".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146061GB01#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:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146061GB01#entryRelationship1".
[1..1] supportingEventRef (EventRef)
A link to the supporting event ref.
AuthorChoice

Refers to the choice of authors of an allergy or adverse reaction diagnosis event.
Used by: Allergy
[1..1] : Template
EventRef

This template class constrains the CDA Observation entry class.

This class represents a reference to an allergy or adverse reaction event carried elsewhere in the message.
Used by: Allergy
[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

  • The XML attribute classCode is fixed to "OBS".
[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 event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an identifier to identify the instance of a allergy or adverse reaction coded information which must be carried in the same CDA document when this reference class is used.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry this information in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146061GB01#supportingEventRef" }
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:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146061GB01#supportingEventRef".
Finding

This template class constrains the CDA Observation entry class.

This class is a finding which supports the diagnosis of an allergy or adverse reaction.
Used by: Allergy
[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

  • The XML attribute classCode is fixed to "OBS".
[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

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:CDAObservationType } )
{ Fixed="ASF" }

Model Attribute Description

The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as an allergy supporting finding.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value "ASF"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.220"
  • The XML attribute displayName shall carry the description associated with the code.
[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an identifier to identify the instance of the supporting finding.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry this information in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146061GB01#supportingFinding" }
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:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146061GB01#supportingFinding".
[1..1] [M] value (CV { CNE:FindingTypeSnCT } )

Model Attribute Description

The HL7 attribute value uses a SNOMED CT concept to describe the supporting finding.

Implementation in XML Instance

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element value as follows:

  • The XML attribute xsi:type shall contain the value "CV"
  • The XML attribute code shall contain a value from the FindingTypeSnCT vocabulary.
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15"
  • The XML attribute displayName shall carry the description associated with the SNOMED CT concept. It is recommended that the preferred term is used.
  • The XML element originalText can be used to carry an XML element reference. This can be used to link the coded item to the relevant text in the CDA section

Where there is no suitable coding to enable the information to be coded then:

The Coded Value (CV) data type shall be used to carry this information in the XML element value as follows:

  • The XML attribute xsi:type shall contain the value "CV".
  • The XML attribute code should be omitted.
  • The XML attribute codeSystem should be omitted.
  • The XML attribute displayName should be omitted.
  • The XML element originalText shall be used to carry the original text transcribed by the author.
  • The XML element originalText may also be used to carry an XML element reference. This can be used to link the original text to the relevant text in the CDA section.