Structured Headings
Domain Message Specification

MedicalDevices Tabular View

COCD_TP146054GB01
SupplyMedicalDevice

This template class constrains the CDA supply class.

This template class is used to hold details of medical devices that do not appear in the dictionary of medicines and devices (dm+d)

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

Model Attribute Description

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

Implementation in XML Instance

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

Implementation in XML Instance

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

Model Attribute Description

The HL7 attribute code uses a fixed concept from the CDAObservationType vocabulary to indicate that the concept being carried in the value attribute of this class is a medical device.

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 value "MDS".
  • 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 a medical device entry.

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_TP146054GB01#SupplyMedicalDevice" }
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_TP146054GB01#SupplyMedicalDevice".
[1..1] [M] text (ST)

Model Attribute Description

The HL7 attribute text is used to carry information about a medical device.

Implementation in XML Instance

  • The text element shall contain the information relating to a medical device.
[0..1] author

This template class constrains the CDA author class.

This class is a links to the author of the medication entry.
[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_TP146054GB01#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_TP146054GB01#author".
[1..1] [R] time (TS)

Model Attribute Description

The HL7 attribute time is used to define the time the author originally recorded the device.

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.
AuthorChoice
Choice of authors for the medication item.
Used by: SupplyMedicalDevice
[1..1] : Template