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

• The XML attribute classCode is fixed to "ASSIGNED".

Model Attribute Description

The HL7 attribute code uses a code from the SDSSpecialty vocabulary or a suitable alternative vocabulary to describe the discharging specialty.

Implementation in XML Instance

When using a value from the SDSSpecialty vocabulary:

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 code from the SDSSpecialty vocabulary
• The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.511"
• The XML attribute displayName shall carry the description associated with the code.

• The XML attribute code shall contain the code
  
• The XML attribute codeSystem shall contain the OID from the alternative vocabulary
• The XML attribute displayName shall carry a description associated with the code

When this cannot be coded using a suitable vocabulary:

• 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 should be used to record the discharging specialty.

When the discharging speciality is not recorded, then the XML attribute nullFlavor of the XML element code shall contain "NI".

Model Attribute Description

The HL7 attribute id uses one or more identifier(s) including local identifiers to identify the person.

Implementation in XML Instance

When using SDS identifiers then:

When the SDS role profile ID is not available then the XML attribute nullFlavor of the second XML element id must carry a value of "UNK".

When using alternative identifiers 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 person'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:

• The XML attribute root shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.24".
• The XML attribute extension shall contain the person's identifier.
• The XML attribute assigningAuthorityName shall contain the assigning organisation in the format of ODSCode:ODSName, for example:

assigningAuthorityName="RA9:SOUTH DEVON HEALTHCARE NHS TRUST"

Where no identifier is available then the XML attribute nullFlavor of the XML element id shall contain "NI".

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_TP145243GB02#AssignedEntity"

A link to the person assigned to the discharging specialty.

A link to the organisation assigned to the discharging specialty.

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 is responsible for the service delivery location. 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:

• The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.2"
• The XML attribute extension shall contain the ODS site code.

When ODS organisation code is used then the XML element id is populated in the following way:

• The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.1"
• The XML attribute extension shall contain the ODS organisation code.

Where no identifier is available then the XML attribute nullFlavor of the XML element id shall contain "NI".

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_TP145243GB02#representedOrganization"

Model Attribute Description

The HL7 attribute classCode describes this class as a person.

Implementation in XML Instance

• The XML attribute classCode is fixed to "PSN".

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of a person.

Implementation in XML Instance

• The XML attribute determinerCode is fixed to "INSTANCE".

Model Attribute Description

The HL7 attribute name provides a name associated with the person.

Implementation in XML Instance

The Person Name Structured with optional Use and optional Valid Time flavour of the PN data type is the recommended format for the person's name. This information is carried in the XML element name as follows:

• The XML element prefix should contain the person's title
• The XML element given should contain the person's forenames; there can be as many occurrences of the XML element as required
  
• The XML element family should contain the person's surname
• The XML element suffix may contain any suffix for the person
  

Additionally the XML attribute use of the XML element name should be used to indicate the type of name; the recommended codes to be used are listed below:

Note some of the codes listed are NHS extensions, these are marked with an *

Code	Definition
L	Legal
PREFERRED *	Preferred name

Additionally the XML element validTime of the XML element name may be used to indicate the time when the name is valid/was valid for the person, some uses are shown below:

• A point in time when the name details are known to be valid
  
• A start and end time
• To represent the period of time the person is/was known by this name
  
• A start time only to indicate when the name is/was valid from for the person
  
• An end time only to indicate that the name is/was only valid for the person until a certain date

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_TP145243GB02#assignedPerson"