Structured Headings
Domain Message Specification

CrisisCarePlan Tabular View

COCD_TP146090GB01
CrisisCarePlan

This template class constrains the CDA Act class.

This class represents the crisis care plan.

Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="PCPR" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as patient care provision.

Implementation in XML Instance

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

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as intended patient care.

Implementation in XML Instance

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

Model Attribute Description

The HL7 attribute code uses a code from the CDAObservationType to describe this class as an crisis care plan.

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 "CCP"
  • 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] effectiveTime (IVL<TS>)
Model Attribute Description

The HL7 attribute effectiveTime defines the time period during which the crisis care plan is valid.

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 (equivalent to the start of the crisis care plan).
  • The XML attribute value of the XML element high may be populated with an 'end date' time stamp when the crisis care plan has ended.

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 each instance of an crisis care plan.

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 } )
{ Fixed="active" }

Model Attribute Description

The HL7 attribute code uses a code to describe the status of the crisis care plan.

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 "active".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146090GB01#CrisisCarePlan" }

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_TP146090GB01#CrisisCarePlan".
[0..1] author

This template class constrains the CDA author class.

The author of this crisis care plan 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-000192#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_TP146090GB01#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_TP146090GB01#author".
[1..1] [M] time (TS)

Model Attribute Description

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

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..1] author1

This template class constrains the CDA author class.

The author of the crisis care plan is the person who updates the information on the crisis care system.

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.
[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 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".
[1..1] [M] contentId (II) { "NPFIT-000192#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 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.
[1..1] [M] functionCode (CV { CNE:AuthorFunctionType } )
{ Fixed="LA" }

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 "LA"
  • 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 "Last Amending Author"
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146090GB01#author1" }

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_TP146090GB01#author1".
[1..1] [M] time (TS)

Model Attribute Description

The HL7 attribute time is used to define the time the author updated the crisis care information.

Implementation in XML Instance

The XML attribute value of the XML element time shall be populated with the time that author updated 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.

[1..1] participant (AuthorChoice)

A link to the choice of authors.

[0..1] entryRelationship2
This template class constrains the CDA entryRelationship entry class.

This class is an entryRelationship class used to link the crisis care plan to its review date.

[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

The XML attribute typeCode is fixed to "COMP".

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

[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_TP146090GB01#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:

  • 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_TP146090GB01#entryRelationship2".
[1..1] plannedReviewDate (PlannedReviewDate)

A link to the planned review date.

[0..1] entryRelationship3

This template class constrains the CDA entryRelationship entry class.

This class is an entryRelationship class used to link the crisis care plan to its plan agreement text.

[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

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

  • 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_TP146090GB01#entryRelationship3".
[1..1] planAgreementText (PlanAgreementText)

A link to the plan agreement text.

AuthorChoice

Refers to the choice of authors of the crisis care plan.

Used by: CrisisCarePlan
[1..1] : Template1

A link to the choice of author templates.

PlannedReviewDate

This template class constrains the CDA Observation class.

Date the crisis care plan is due for review. This date is set at creation of the crisis care plan by a professional, in consultation with the patient.

Used by: CrisisCarePlan
[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="CCPRD" }

Model Attribute Description

The HL7 attribute code uses a code from the CDAObservationType to describe this class being used to record review date of crisis care plan.

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 "CCPRD"
  • 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] templateId (II)
{ Fixed="COCD_TP146090GB01#plannedReviewDate" }

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_TP146090GB01#plannedReviewDate".
[1..1] [M] value (TS)

Model Attribute Description

The HL7 attribute value is used to indicate when the crisis care plan is to be reviewed.

Implementation in XML Instance

The XML attribute value of the XML element value shall be populated with the time the crisis care plan should be reviewed 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
  • The XML attribute xsi:type shall contain the value "TS"

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.

PlanAgreementText

This template class constrains the CDA Observation class.

This class captures whether the patient or carer has agreed to the content of the entire plan or individual aspects of treatment, expected outcomes, risks and alternative treatments. It also captures if agreement cannot be obtained and the reason for this.

Used by: CrisisCarePlan
[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] code (CV { CNE:CDAObservationType } )
{ Fixed="PAPC" }

Model Attribute Description

The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe the plan agreed with patient carer.

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 of "PAPC"
  • 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] templateId (II)
{ Fixed="COCD_TP146090GB01#planAgreementText" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname 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_TP146090GB01#planAgreementText"
[1..1] [M] value (ST)

Model Attribute Description

The HL7 attribute value is used to carry the care plan agreement text.

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 the plan agreement text.