Model Attribute Description

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

Implementation in XML Instance

The XML attribute classCode is fixed to "PROC".

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

Model Attribute Description

The HL7 attribute code uses a code from SNOMED CT to describe anticipatory medicine box being issued.

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 xsi:type shall contain the value "CV"
• The XML attribute code shall contain a code from the EoLAnticipatoryMedicineBoxIssueSnCT 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 code. It is recommended that the preferred term is used to populate this attribute.
• The XML element originalText shall be used to carry the original text transcribed by the author.

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.

Model Attribute Description

The HL7 attribute effectiveTime is used to define the time when the anticipatory medicine box is issued.

Implementation in XML Instance

The XML attribute value of the XML element effectiveTime 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.

Model Attribute Description

The HL7 attribute id uses an identifier to identify each instance of issue of the anticipatory medicine box.

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.

Model Attribute Description

The HL7 attribute statusCode uses a code to describe the status of the issue of anticipatory medicine box.

Implementation in XML Instance

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

• The XML attribute code shall contain a fixed value of "completed".

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_TP146073GB01#AMBoxIssueProcedure".

This template class constrains the CDA author class.

The author of the anticipatory medicine box issue procedure is the person who originally recorded the information of issue of anticipatory medicine box.

The author of this information must be included if the author and/or date of authoring are different to those for 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 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 attribute typeCode describes this class as an author participation.

Implementation in XML Instance

The XML attribute typeCode is fixed to "AUT".

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 section are conducted across to the child section (also associated with the child section). 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"

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

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

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_TP146073GB01#author".

Model Attribute Description

The HL7 attribute time is used to define the time the author originally recorded issue of anticipatory medicine box.

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.

A link to the choice of authors.

This template class constrains the CDA entryRelationship entry class.

This class is an entryRelationship class used to link the End of Life care plan to the patient relationships associated with the End of Life care plan.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

The XML attribute typeCode is fixed to "COMP".

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

The XML attribute contextConductionInd is fixed to "true".

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

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_TP146073GB01#entryRelationship1".

A link to anticipatory medicine box location.

This template class constrains the CDA entryRelationship entry class.

This class is an entryRelationship class used to link the End of Life care plan to the patient relationships associated with the End of Life care plan.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

The XML attribute typeCode is fixed to "COMP".

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

The XML attribute contextConductionInd is fixed to "false".

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

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

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_TP146073GB01#entryRelationship2".

A link to the medication choice.

This template class constrains the CDA performer class.

The performer of the anticipatory medicine box issue procedure is the person who performs issue of anticipatory medicine box to patient.

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a performer.

Implementation in XML Instance

The XML attribute typeCode is fixed to "PRF".

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

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_TP146073GB01#performer".

A link to the choice of performers.

An abstract placeholder for author templates.

An abstract placeholder for performer templates.

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 moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

The XML attribute moodCode is fixed to "EVN".

Model Attribute Description

The HL7 attribute code uses a code from the EoLCDAObservationType to describe this class as being used to record location of anticipatory medicine box.

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 a fixed value of "EOLBLC"
• The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.435"
• The XML attribute displayName shall carry the description associated with the code.
  

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_TP146073GB01#aMBoxLocation".

Model Attribute Description

The HL7 attribute value is used to carry the information about location of anticipatory medicine box.

Implementation in XML Instance

The XML element value should be populated using the ST data type as follows:

• The XML attribute xsi:type shall contain the value "ST".
• The XML element value shall contain information about the location of the anticipatory medicine box.

An abstract placeholder for medication templates.