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".

Model Attribute Description

The HL7 attribute code uses a code from a vocabulary to describe the values carried in the value attribute of this class. The vocabulary CrisisCareObservation is the default vocabulary for "Healthy London Partnership London Digital Programme End of Life Care Co-ordination project". When this vocabulary is used then a fixed value of "CCO" must be used. The code of "CCO" must be further defined using a code from the CrisisCareObservationType vocabulary using the qualifier element.

Implementation in XML Instance

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

• The XML attribute code shall contain fixed value of "CCO".
• The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.532".
• The XML attribute displayName shall carry the description associated with the code.
• The XML element qualifier shall be used to qualify the code of CCO as follows:
• The XML attribute code shall contain the code from the CrisisCareObservationType vocabulary.
• The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.533".
• The XML attribute displayName shall carry the description associated with the code.

This attribute is defined as CWE to allow other vocabularies to be used, where there is a business requirement to do so. When this is the case the code should be set to a suitable value from that vocabulary to specify the type of observation carried in the value. and qualified in a similar manner.

Model Attribute Description

The HL7 attribute effectiveTime is used for the time the observation.

Where known the dates that the observation was effective on the patient should be 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:

• 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 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.

• 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_TP146056GB01#CrisisCareObservation".

Model Attribute Description

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 xsi:type shall contain the value "CD"
• The XML attribute code should contain a value from the vocabulary.
• The XML attribute codeSystem should contain the OID for the vocabulary.
  
• The XML attribute displayName should carry the description associated code.
• The XML element qualifier may be used if required
  
• The XML element originalText may 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 coded item to the relevant text in the CDA section.
  

Where there is no suitable vocabulary or codes to enable the information to be coded then:

The Coded Value (CD) 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 "CD"
• The XML attribute code should be omitted.
• The XML attribute codeSystem should be omitted.
  
• The XML attribute displayName should be omitted.
• The XML element qualifier 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.

This template class constrains the CDA author class.

The author of this 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.

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 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.

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".

Model Attribute Description

The HL7 attribute time is used to define the time the author originally recorded the crisis care observation.

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:

A link to the choice of author templates.

This template class constrains the CDA informant class.

Refers to who informed about the crisis care observation.

A link to the author templates.

A link to the informant templates.