A universal template for an authoring device
This template is used to identify an authoring device or system where SDS is not appropriate or available.
The organisation which owns or is responsible for the device or system will be identified using the organisation's ODS (NACS) code.
An authoring device is normally described as a device that has processed some information and created an output without human involvement.
Model Attribute Description
The HL7 attribute classCode describes this class as an assigned role. An assigned role is a type of agent in which, the player is a person employed by a scoping organisation.
Implementation in XML Instance
Model Attribute Description
The HL7 attribute id uses one or more identifier(s) including local identifiers to identify the device.
Implementation in XML Instance
The local identifier where the code system can be identified using an OID then the XML element id shall carry the identifiers as follows:
- The XML attribute root shall contain the OID for the identifying system.
- The XML attribute extension shall contain the device's identifier.
When using alternative identifiers where the code system can not be identified using an OID then the XML element id shall carry the identifiers as follows:
assigningAuthorityName="RA9:SOUTH DEVON HEALTHCARE NHS TRUST"
- The XML attribute root shall contain the OID " 2.16.840.1.113883.2.1.3.2.4.18.36 ".
- The XML attribute extension shall contain the device's identifier.
- The XML attribute assignedAuthorityName shall contain the assigning organisation in the format of ODSCode:ODSName, for example:
Where no identifier is available then the XML attribute nullFlavor of the XML element id shall contain " NI ".
This class details the organisation which scopes the device (the organisation which owns or is responsible for the device).
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:
Model Attribute Description
The HL7 attribute classCode describes this class as an organisation.
Implementation in XML Instance
The XML attribute classCode is fixed to "
ORG
".
Model Attribute Description
The HL7 attribute determinerCode describes this class as an instance of an organisation.
Implementation in XML Instance
The XML attribute determinerCode is fixed to "
INSTANCE
".
Model Attribute Description
The HL7 attribute id uses an ODS code as an identifier that uniquely identifies the organisation which owns or is responsible for the device. The ODS code should identify the organisation at either the site level or organisation level. Where possible the organisation should be identified at the site level. ODS codes were formerly known as NACS codes.
Implementation in XML Instance
When ODS site code is used then the XML element id is populated in the following way:
When ODS organisation code is used then the XML element id is populated in the following way:
Model Attribute Description
The HL7 attribute name uses the description of the organisation associated with the ODS code.
Implementation in XML Instance
A class which details the device which authored the information.
Note: the term device also applies to software systems.
Model Attribute Description
The HL7 attribute classCode describes this class as a device.
Implementation in XML Instance
Model Attribute Description
The HL7 attribute determinerCode describes this class as an instance of a device.
Implementation in XML Instance
Model Attribute Description
The HL7 attribute manufacturedModelName uses a character string that optionally may have a code attached, this combination is used to describe the manufacture's name and / or model for the device or system. The text must always be present if a code is present. The HL7 vocabulary ManufacturedModelName contains no codes. Therefore local codes should be used when coding is required.
Implementation in XML Instance
The XML element manufacturedModelName is used to describe the devices manufacture's name and / or model and is populated as shown below:
When no OID is available for the local vocabualry then:
Model Attribute Description
The HL7 attribute softwareName uses a character string that optionally may have a code attached, this combination is used to describe the software installed / running on the device or system. The text must always be present if a code is present. The HL7 vocabulary SoftwareName contains no codes. Therefore local codes should be used when coding is required.
Implementation in XML Instance
The XML element softwareName is used to describe the device's software and is populated as shown below:
When no OID is available for the local vocabulary then: