<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html><html xmlns:pack="urn:pack" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns="http://www.w3.org/1999/xhtml"><head><title>NHS 111 - Tabular View</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta http-equiv="content-type" content="text/html;charset=UTF-8"/><link href="../../../Template/css/bootstrap/bootstrap.min.css" rel="stylesheet" media="screen"/><link href="../../../Template/css/base.css" rel="stylesheet" media="screen"/><link href="../../../Template/css/google-code-prettify/prettify.css" rel="stylesheet" media="screen"/></head><body><div id="wrap"><div class="container"><div class="row"><div class="span4"><img src="../../../Template/images/logo.png"/></div><div class="span8"><h4 class="pack-title text-right">NHS 111<br/>Domain Message Specification</h4></div></div><div class="navbar"><div class="navbar-inner"><div class="container"><button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"/><span class="icon-bar"/><span class="icon-bar"/></button><div class="nav-collapse collapse"><p class="navbar-text pull-right"><b>Version: </b>2.0; <b>Status: </b>RC1</p><ul class="nav"><li class="dropdown"><a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"> </b></a><ul class="dropdown-menu"><li><a href="../../../index.html">About</a></li><li><a href="../../../Core/changehistory.html">Change History</a></li><li><a href="../../../Core/glossary.html">Glossary</a></li></ul></li><li><a href="../../../Domains/messages.html">Messages</a></li><li><a href="../../../Examples/examples.html">Examples</a></li><li><a href="../../../AssociatedSpecifications/AssociatedSpecifications.html">Associated Specifications</a></li><li class="dropdown"><a href="#" class="dropdown-toggle" data-toggle="dropdown">References <b class="caret"> </b></a><ul class="dropdown-menu"><li class="dropdown-submenu"><a tabindex="-1" href="#">Data Types</a><ul class="dropdown-menu"><li><a href="../../../Data Types/datatypesusage.html">Data Types Usage</a></li><li><a href="../../../Data Types/datatypes.html">Data Types Specification</a></li></ul></li><li><a href="../../../Domains/Templates/Document files/constraintusage.html">Constraint Usage</a></li><li><a href="../../../Domains/Templates/Document files/templateusage.html">Template Usage</a></li><li><a href="../../../Vocabulary/vocabularyusage.html">Vocabulary Usage</a></li><li><a href="../../../Domains/profiles.html">Configuration Profiles</a></li></ul></li></ul></div></div></div></div><div id="content" class="row"><div class="span12"><div xmlns="" class="tabularview">
 <h3>DocumentParticipantUniversal Tabular View</h3> 
 <table cellpadding="2" cellspacing="0" class=" table"> 
  <tbody>
   <tr class="class"> 
    <td><a href="COCD_TP145214GB01.html"><b>COCD_TP145214GB01</b></a></td> 
    <td nowrap="yes"/> 
   </tr> 
   <tr valign="top" class="class"> 
    <td class="roleclass"><a name="AssociatedEntity"> </a><b>AssociatedEntity</b></td> 
    <td width="50%"> 
     <div> 
      <p> <b>A template only for use with the generic participation on the CDA document header.</b> </p> 
      <p> <b>This template constrains the generic participants of the CDA document to ones suitable for the CDA document header.</b> </p> 
      <p> <b/> </p> 
      <p> <b>This class identifies the type of role the document participant is playing. </b> <br/> </p> 
     </div> </td> 
   </tr> 
   <tr class="mif"> 
    <td align="right" width="50%"/> 
    <td><font color="gray">Used by: </font><a href="#"><b/></a></td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[1..1] </b></font><font color="green"><b> [M] </b></font><b>classCode</b> (<a href="../../../Data Types/datatypes.html#CS"><b>CS</b></a> {<a> </a><b>CNE</b>:<a href="../../../Vocabulary/RoleClassAssociative.html"><b>RoleClassAssociative</b></a> } ) </td> 
    <td width="50%"> 
     <div> 
      <p> <u> <b>Model Attribute Description </b> </u> <br/> </p> 
      <p>The HL7 attribute <b>classCode</b> describes the type of role using a value from the <b>RoleClassAssociative</b> domain of the HL7 vocabulary <b>RoleClass</b>. <br/> </p> 
      <p> <u> <b>Implementation in XML Instance </b> </u> <br/> </p> 
      <p> The XML attribute <b>classCode</b> shall carry a code from the <b>RoleClassAssociative</b> domain of the HL7 vocabulary <b>RoleClass</b>. The recommended codes to use are listed in the table below: </p> 
      <table align="center" width="90%" class=" table"> 
       <tbody> 
        <tr> 
         <th>Code<br/> </th> 
         <th>Display name<br/> </th> 
         <th>Definition<br/> </th> 
        </tr> 
        <tr> 
         <td> <b>ASSIGNED</b> </td> 
         <td>assigned entity<br/> </td> 
         <td>An assigned entity is a type of agent in which, the player is a person acting in the employ a scoping organisation. <br/> </td> 
        </tr> 
        <tr> 
         <td> <b>CAREGIVER</b> </td> 
         <td>caregiver</td> 
         <td>A person responsible for the primary care of a patient at home.</td> 
        </tr> 
        <tr> 
         <td> <b>CRINV </b> <br/> </td> 
         <td>clinical research investigator <br/> </td> 
         <td>A clinical research investigator is a type of formal relationship in which, the player is a person that has authority from a clinical research sponsor (scoper) to direct the conduct of a clinical research trial or study on behalf of that sponsor. </td> 
        </tr> 
        <tr> 
         <td> <b>COMPAR</b> </td> 
         <td>commissioning party</td> 
         <td>A commissioning party is a type of assigned entity in which, the player is an entity that is authorised to issue or instantiate permissions, privileges, credentials or other formal/legal agreements on behalf of a scoping entity. </td> 
        </tr> 
        <tr> 
         <td> <b>EMP </b> </td> 
         <td>employee </td> 
         <td>An employee is a type of formal relationship in which, the player is a person or organisation is contracted by a scoping organisation or person to undertake work for compensation.<br/> The employee role represents the nature of the employment relationship. In contrast assigned entity represents the function role (i.e. the nature of the work undertaken).<br/> </td> 
        </tr> 
        <tr> 
         <td> <b>IDENT</b> </td> 
         <td>identified entity</td> 
         <td>An identified entity is a type of passive role in which, the player is an entity that is assigned an identifier by a scoping entity. <br/> </td> 
        </tr> 
        <tr> 
         <td> <b>LIC</b> </td> 
         <td>licensed entity <br/> </td> 
         <td>A licensed entity is a type of formal relationship in which, the scoper certifies the player to perform certain activities that fall under the jurisdiction of the scoper.<br/> For example, The GMC licenses doctors to practice medicine in the UK. </td> 
        </tr> 
        <tr> 
         <td> <b>MIL </b> <br/> </td> 
         <td> military person<br/> </td> 
         <td>A military person is a type of employee in which, the player is a person who is a member of a military service. The scoping entity is the military service organisation or unit. <br/> </td> 
        </tr> 
        <tr> 
         <td> <b>PROV</b> <br/> </td> 
         <td>healthcare provider<br/> </td> 
         <td>A healthcare provider is a type of licensed entity in which, the player is an entity that is authorised to provide healthcare serviced by scoping authority.<br/> </td> 
        </tr> 
        <tr> 
         <td> <b>QUAL</b> <br/> </td> 
         <td>qualified entity<br/> </td> 
         <td>A qualified entity is a type of formal relationship in which, the player is an entity that is recognised as having training, experience, etc that makes them an appropriate performer of certain types of activity. The qualification is issued by the scoping entity.<br/> <br/> For example, a doctor is a qualified entity scoped by a medical school.<br/> </td> 
        </tr> 
        <tr> 
         <td> <b>SGNOFF</b> <br/> </td> 
         <td>signing authority or officer<br/> </td> 
         <td>A signing authority or officer is a type of assigned entity in which, the player is a person that who is the officer or signature authority for a scoping entity.<br/> </td> 
        </tr> 
        <tr> 
         <td> <b>STD</b> <br/> </td> 
         <td>student<br/> </td> 
         <td>A student is a type of formal relationship in which, the player is a person who is a student of a school or other educational establishment (scoper).<br/> </td> 
        </tr> 
       </tbody> 
      </table> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[0..1] </b></font><b>addr</b> (<a href="../../../Data Types/datatypes.html#AD"><b>AD</b></a>) </td> 
    <td width="50%"> 
     <div> 
      <div> 
       <p> <u> <b>Model Attribute Description</b> </u> <br/> </p> 
       <p>The HL7 attribute <b>addr</b> uses an address for person playing the role.<br/> </p> 
       <p>The HL7 attribute <b>addr</b> allows <b>structured</b> and <b>unstructured </b>addresses to be carried. Only <b>structured </b>addresses are recommended to be used. </p> 
       <p> <u> <b>Implementation in XML Instance</b> </u> </p> 
       <p> There are a number of forms of <b>structured</b> address. The three shown here are the recommended formats for the address, they are listed in no particular order. </p> 
       <p>The XML element <b>addr</b> is populated as follows: <br/> </p> 
       <p>When using the structured address in the style of PDS the XML element <b>addr</b> shall contain five XML elements <b>streetAddressLine</b>. <br/> </p> 
       <ul> 
        <li>The first XML element <b>streetAddressLine</b> shall contain the premises name<br/> </li> 
        <li>The second XML element <b>streetAddressLine</b> shall contain the number and thoroughfare </li> 
        <li>The third XML element <b>streetAddressLine</b> shall contain the locality </li> 
        <li>The fourth XML element <b>streetAddressLine</b> shall contain the post town </li> 
        <li>The fifth XML element <b>streetAddressLine</b> shall contain the county </li> 
       </ul> 
       <p> The first XML element <b>streetAddressLine</b> or the second XML element <b>streetAddressLine</b> and the fourth XML element <b>streetAddressLine</b> are mandatory to be populated.<br/> </p> 
       <ul> 
        <li> The XML element <b>postalCode</b> can be used to carry a postcode<br/> </li> 
        <li>The XML element <b>addressKey</b> can be used to carry a PAF key<br/> </li> 
       </ul> 
       <p>When using the <b>fully structured</b> address format then the XML element <b>addr </b>shall be populated as follows: </p> 
       <ul> 
        <li>The XML element<b> houseNumber</b> shall contain the house/building number or name<br/> </li> 
        <li>The XML element <b>streetName</b> shall contain the street name<br/> </li> 
        <li>The XML element <b>city</b> shall contain the city name<br/> </li> 
        <li>The XML element <b>county</b> shall contain the county </li> 
        <li>The XML element <b>country</b> shall contain the country name<br/> </li> 
        <li>The XML element <b>postalCode</b> shall contain the postcode </li> 
        <li>The XML element <b>addressKey</b> shall contain the address key </li> 
       </ul> 
       <blockquote> 
        <p> Note that unpopulated XML elements should not be present.<br/> </p> 
       </blockquote> 
       <p>Alternatively the <b>structured</b> address may contain just a series of XML elements <b>streetAddressLine</b> populated in the correct order to render as a postal address with as much information as available included.<br/> </p> 
       <ul> 
        <li>The first XML element <b>streetAddressLine</b> shall contain the first address line <br/> </li> 
        <li>The second XML element <b>streetAddressLine </b>shall contain the second address line </li> 
        <li>The third XML element <b>streetAddressLine </b>shall contain the third address line </li> 
        <li>and so on ....</li> 
       </ul> 
       <blockquote> 
        <p> Note that unpopulated XML elements should not be present.</p> 
       </blockquote> 
       <p>The XML element <b>addr</b> also allows an XML attribute <b>use</b> and this should be used to further define the person's address type when required. Only the <b>use</b> values listed below are recommended to be used for person's address. </p> 
       <table align="center" width="90%" class=" table"> 
        <tbody> 
         <tr> 
          <th>Code <br/> </th> 
          <th>Definition <br/> </th> 
         </tr> 
         <tr> 
          <td> <b>WP</b> </td> 
          <td>Work place - An office address. First choice for business related contacts during business hours. </td> 
         </tr> 
         <tr> 
          <td> <b>TMP</b> </td> 
          <td>Temporary address - A temporary address; may be good for visit or mailing.<br/> </td> 
         </tr> 
         <tr> 
          <td> <b>PHYS</b> </td> 
          <td>Physical visit address - Used primarily to visit an address.</td> 
         </tr> 
         <tr> 
          <td> <b>PST</b> <br/> </td> 
          <td>Postal address - Used to send mail.</td> 
         </tr> 
         <tr> 
          <td> <b>H</b> <br/> </td> 
          <td>Home address - The person's home address; attempted contacts for business purposes might intrude privacy and chances are one will contact family or other household members instead of the person one wishes to call. Typically used with urgent cases, or if no other contacts are available. </td> 
         </tr> 
         <tr> 
          <td> <b>HP</b> <br/> </td> 
          <td>The primary home address - An address to reach a person after business hours. </td> 
         </tr> 
         <tr> 
          <td> <b>HV</b> <br/> </td> 
          <td>A vacation home - An address to reach a person while on vacation. </td> 
         </tr> 
        </tbody> 
       </table> 
       <p>When the XML attribute<b> use </b>of the XML element <b>addr</b> contains the value <b>"PHYS" </b>then the following two XML elements of the XML element <b>addr</b> may be populated. </p> 
       <ul> 
        <li>The XML element <b>desc</b> of the XML element <b>addr</b> may contain a description of the address; this may be used for things like directions for the address </li> 
        <li>The XML element <b>additionalLocator</b> of the XML element <b>addr</b> may contain additional location information such as longitude and latitude coordinates<br/> </li> 
       </ul> 
       <p>The XML element <b>useablePeriod</b> of XML element <b>addr</b> can be used to indicate some of the following types of valid times for an address: </p> 
       <ul> 
        <li>A point in time when the contact address details are valid<br/> </li> 
        <li>A start and end time</li> 
        <ul> 
         <li>Just including hours and minutes to indicate opening hours of an office for a work address<br/> </li> 
         <li>Using dates for indicating a contact address is only for a certain period of time<br/> </li> 
        </ul> 
        <li>A start time only to indicate when the contact address is valid from</li> 
        <li>An end time only to indicate that the contact address is only valid until a certain date </li> 
       </ul> 
      </div> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[0..1] </b></font><b>code</b> (<a href="../../../Data Types/datatypes.html#CV"><b>CV</b></a> {<a> </a><b>CWE</b>:<a href="../../../Vocabulary/RoleCode.html"><b>RoleCode</b></a> } ) </td> 
    <td width="50%"> 
     <div> 
      <u> <b>Model Attribute Description</b> </u> 
      <br/> 
      <p>The HL7 attribute<b> code</b> uses a code from the HL7 vocabulary <b>RoleCode</b> or an alternative vocabulary to further describe the role code carried in the HL7 attribute <b>classCode</b>. </p> 
      <p> <u> <b>Implementation in XML Instance</b> </u> </p> 
      <p>The <b>Coded Plain</b> flavour of the <b>Coded Value</b> (CV) data type shall be used to carry this information in the XML element <b>code</b> as follows: </p> 
      <p>When the <b>RoleCode</b> vocabulary is used then: </p> 
      <ul> 
       <li>The XML attribute <b>code</b> shall contain the <font color="#000000">code from the<b> RoleCode</b> vocabulary </font> </li> 
       <li>The XML attribute <b>codeSystem</b> shall contain the OID "<font color="#ff0000"> <b>2.16.840.1.113883.5.111</b> </font>" </li> 
       <li>The XML attribute <b>displayName</b> shall carry the description associated with the code in the <b>RoleCode </b>vocabulary </li> 
      </ul> 
      <p>The recommended codes to use with each <b>classCode</b> are listed below: Where there is no entry for a given <b>classCode</b> then it is recommended that the XML element <b>code</b> is not used. <br/> </p> 
      <table align="center" width="90%" class=" table"> 
       <tbody> 
        <tr> 
         <th>Classcode</th> 
         <th>Code</th> 
         <th>DisplayName</th> 
         <th> Definition</th> 
        </tr> 
        <tr> 
         <td> <b>STD</b> <br/> </td> 
         <td> <b>FSTUD<br/> </b> </td> 
         <td>full-time student</td> 
         <td>Someone in full-time attendance at a recognized educational institution</td> 
        </tr> 
        <tr> 
         <td> <br type="_moz"/> </td> 
         <td> <b>PSTUD</b> <br/> </td> 
         <td>part-time student<br/> </td> 
         <td>Someone in part-time attendance at a recognized educational institution</td> 
        </tr> 
       </tbody> 
      </table> 
      <p/> When an alternative vocabulary is used and an OID is available then: 
      <br/> 
      <ul> 
       <li>The XML attribute <b>code</b> shall contain the <font color="#000000">code from the </font>alternative<font color="#000000"> vocabulary </font> </li> 
       <li>The XML attribute <b>codeSystem</b> shall contain the OID for the alternative vocabulary </li> 
       <li>The XML attribute <b>displayName</b> shall carry the description alternative vocabulary. </li> 
      </ul> 
      <p>When an alternative vocabulary is used and an OID is not available then: <br/> </p> 
      <ul> 
       <li>The XML attribute <b>code</b> shall contain the <font color="#000000">code from the </font>alternative<font color="#000000"> vocabulary </font> </li> 
       <li>The XML attribute <b>codeSystem</b> shall contain the OID "<font color="#ff0000"> <b>2.16.840.1.113883.2.1.3.2.4.17.409</b> </font>"<br/> </li> 
       <li>The XML attribute <b>displayName</b> shall carry the description alternative vocabulary. </li> 
      </ul> 
      <p/> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[0..*] </b></font><b>id</b> (<a href="../../../Data Types/datatypes.html#SET"><b>SET</b></a><b>&lt;<a href="../../../Data Types/datatypes.html#II"><b>II</b></a>&gt;</b>) </td> 
    <td width="50%"> 
     <div> 
      <p> <u> <b>Model Attribute Description</b> </u> </p> 
      <p>The HL7 attribute <b>id </b>allows identification of the role using a national or local identifier. <br/> </p> 
      <p> <u> <b>Implementation in XML Instance</b> </u> </p> 
      <p>When the role is identified using SDS then the XML element <b>id</b> is populated as below:<br/> </p> 
      <div> 
       <blockquote>
        The first instance of the XML element 
        <b>id</b> is mandatory and shall carry the SDS User ID, the second instance of XML element 
        <b>id</b> is required and shall carry the SDS User Role Profile ID when available on the sending system. The identifiers shall be carried in the XML element 
        <b>id</b> as follows:
        <br/> 
       </blockquote> 
       <blockquote>
         The first instance of the XML element 
        <b>id</b> shall carry an SDS identifier that uniquely identifies the person as follows:
        <br/> 
        <ul> 
         <li>The XML attribute <b>root</b> shall contain the OID "<font color="#ff0000"> <b>1.2.826.0.1285.0.2.0.65</b> </font>" </li> 
         <li>The XML attribute <b>extension</b> shall contain the SDS User ID<br/> </li> 
        </ul> The second instance of the XML element 
        <b>id</b> shall carry the SDS identifier that uniquely identifies the role profile of the person as follows:
        <br/> 
        <ul> 
         <li>The XML attribute <b>root</b> shall contain an OID with the value "<font color="#ff0000"> <b>1.2.826.0.1285.0.2.0.67</b> </font>" </li> 
         <li>The XML attribute <b>extension</b> shall contain the SDS Role Profile ID </li> 
        </ul> 
       </blockquote> 
      </div> 
      <blockquote> 
       <p>When the SDS role profile ID is not available then the XML element <b>nullFlavor</b> of the second XML element <b>id</b> must carry a value of "<font color="#ff0000"> <b>UNK</b> </font>". </p> 
      </blockquote> 
      <p>When using alternative identifiers where the code system can be identified using an OID then the XML element <b>id</b> shall carry the identifiers as follows:<br/> </p> 
      <blockquote> 
       <ul> 
        <li>The XML attribute <b>root</b> shall contain the OID for the identifying system. </li> 
        <li>The XML attribute <b>extension</b> shall contain the identifier. </li> 
       </ul> 
      </blockquote> 
      <p>When using alternative identifiers where the code system can not be identified using an OID then the XML element <b>id</b> shall carry the identifiers as follows:<br/> </p> 
      <blockquote> 
       <ul> 
        <li>The XML attribute <b>root</b> shall contain the OID "<font color="#ff0000"> <b>2.16.840.1.113883.2.1.3.2.4.18.24</b> </font>". </li> 
        <li>The XML attribute <b>extension</b> shall contain the identifier. </li> 
        <li>The XML attribute <b>assignedAuthorityName</b> shall contain the assigning organisation in the format of ODSCode:ODSName, for example: </li> 
       </ul> 
       <b>assigningAuthorityName</b>="RA9:SOUTH DEVON HEALTHCARE NHS TRUST" 
      </blockquote> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[0..*] </b></font><b>telecom</b> (<a href="../../../Data Types/datatypes.html#SET"><b>SET</b></a><b>&lt;<a href="../../../Data Types/datatypes.html#TEL"><b>TEL</b></a>&gt;</b>) </td> 
    <td width="50%"> 
     <div> 
      <p> <u> <b>Model Attribute Description </b> </u> <br/> </p> 
      <p>The HL7 attribute <b>telecom</b> specifies contact details for the person in the form of telephone numbers, fax numbers and email addresses. </p> 
      <p> <u> <b>Implementation in XML Instance </b> </u> <br/> </p> 
      <p>The XML <b>value</b> attribute of the XML element <b>telecom</b> should contain the telephone / fax number or an email address prefixed by the type of contact and a colon. </p> 
      <ul> 
       <li>For a telephone number the actual telephone number would be prefixed with <b>tel:</b> </li> 
       <li>For a fax number the actual fax number would be prefixed with <b>fax:</b> </li> 
       <li>For an email address the actual email address would be prefixed with <b>mailto:</b> <br/> </li> 
      </ul> 
      <p>The XML attribute <b>use</b> of the XML element <b>telecom</b> may be used to give further information about the type of contact details contained in the XML attribute <b>value</b>. Only the <b>use</b> values listed below are recommended to be used for the patient contact details: </p> 
      <table align="center" width="90%" class=" table"> 
       <tbody> 
        <tr> 
         <th>Code</th> 
         <th>Definition</th> 
        </tr> 
        <tr> 
         <td> <b>AS</b> </td> 
         <td>Answering service - an automated answering machine used for less urgent cases and if the main purpose of contact is to leave a message or access an automated announcement. </td> 
        </tr> 
        <tr> 
         <td> <b>EC </b> <br/> </td> 
         <td>Emergency contact - A contact specifically designated to be used for emergencies. This is the first choice in emergencies, independent of any other use codes. </td> 
        </tr> 
        <tr> 
         <td> <b>H </b> <br/> </td> 
         <td>Home - A communication address at a home, attempted contacts for business purposes might intrude privacy and chances are one will contact family or other household members instead of the person one wishes to call. Typically used with urgent cases, or if no other contacts are available. </td> 
        </tr> 
        <tr> 
         <td> <b>HP </b> <br/> </td> 
         <td>Home primary - the primary contact to reach a person after business hours.</td> 
        </tr> 
        <tr> 
         <td> <b>HV</b> <br/> </td> 
         <td>Home vacation - A vacation home, to reach a person while on vacation. </td> 
        </tr> 
        <tr> 
         <td> <b>WP</b> <br/> </td> 
         <td>Work place - An office address. First choice for business related contacts during business hours</td> 
        </tr> 
        <tr> 
         <td> <b>PG </b> <br/> </td> 
         <td>Pager - A paging device suitable to solicit a callback or to leave a very short message. </td> 
        </tr> 
        <tr> 
         <td> <b>MC </b> <br/> </td> 
         <td>Mobile contact - A telecommunication device that moves and stays with its owner. May have characteristics of all other use codes, suitable for urgent matters, not the first choice for routine business. </td> 
        </tr> 
       </tbody> 
      </table> 
      <p>The XML element <b>useablePeriod</b> of the XML element <b>telecom</b> may be used to indicate when the contact details given are valid, for example to indicate that a telephone number is only for office hours (9am to 5 pm). It can be used to indicate some of the following types of valid times: </p> 
      <ul> 
       <li>A point in time when the contact details are valid<br/> </li> 
       <li>A start and end time</li> 
       <ul> 
        <li>Just including hours and minutes to indicate opening hours of an office for work contacts<br/> </li> 
        <li>Using dates for indicating a contact is only for a certain period of time<br/> </li> 
       </ul> 
       <li>A start time only to indicate when the contact details are valid from</li> 
       <li>An end time only to indicate that the contact details are only valid until a certain date </li> 
      </ul> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[1..1] </b></font><font color="green"><b> [M] </b></font><b>templateId</b> (<a href="../../../Data Types/datatypes.html#II"><b>II</b></a>)<br/> {<b> Fixed="<font color="red">COCD_TP145214GB01#AssociatedEntity</font>"</b> } </td> 
    <td width="50%"> 
     <div> 
      <div> 
       <p> <u> <b>Model Attribute Description</b> </u> <br/> <br/> The HL7 attribute <b>templateId</b> 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. </p> 
       <p> <u> <b>Implementation in XML Instance </b> </u> <br/> </p> 
       <p>The <b>Identifier External </b>data type flavour is used to carry this information in the XML element <b>templateId</b> as follows: </p> 
       <ul> 
        <li>The XML attribute <b>root</b> is fixed to the OID "<font color="#ff0000"> <b>2.16.840.1.113883.2.1.3.2.4.18.2</b> </font>" </li> 
        <li>The XML attribute <b>extension</b> is fixed to "<font color="#ff0000"> <b> <span class="redText">COCD_TP145214GB01#AssociatedEntity</span> </b> </font>". </li> 
       </ul> 
      </div> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[0..1] </b></font><b><a id="AssociatedEntity/associatedPerson"/>associatedPerson</b> (<a href="#Person"><b>Person</b></a>) </td> 
    <td width="50%"> 
     <div>
      A link to the person.
      <br/> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[0..1] </b></font><b><a id="AssociatedEntity/scopingOrganization"/>scopingOrganization</b> (<a href="#Organization"><b>Organization</b></a>) </td> 
    <td width="50%"> 
     <div>
      A link to the scoping organisation.
     </div> </td> 
   </tr> 
   <tr valign="top" class="class"> 
    <td class="entclass"><a name="Person"> </a><b>Person</b></td> 
    <td width="50%"> 
     <div> 
      <p> <b>A class which details the person who is playing the role.</b> </p> 
     </div> </td> 
   </tr> 
   <tr class="mif"> 
    <td align="right" width="50%"/> 
    <td><font color="gray">Used by: </font><a href="#AssociatedEntity"><b>AssociatedEntity</b></a></td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[1..1] </b></font><font color="green"><b> [M] </b></font><b>classCode</b> (<a href="../../../Data Types/datatypes.html#CS"><b>CS</b></a> {<a> </a><b>CNE</b>:<a> </a><b>EntityClass</b> } )<br/> {<b> Fixed="<font color="red">PSN</font>"</b> } </td> 
    <td width="50%"> 
     <div> 
      <p> <u> <b>Model Attribute Description </b> </u> <br/> </p> 
      <p>The HL7 attribute <b>classCode</b> describes this class as a person. </p> 
      <p> <u> <b>Implementation in XML Instance </b> </u> <br/> </p>The XML attribute 
      <b>classCode</b> is fixed to "
      <font color="#ff0000"> <b>PSN</b> </font>". 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[1..1] </b></font><font color="green"><b> [M] </b></font><b>determinerCode</b> (<a href="../../../Data Types/datatypes.html#CS"><b>CS</b></a> {<a> </a><b>CNE</b>:<a> </a><b>EntityDeterminer</b> } )<br/> {<b> Fixed="<font color="red">INSTANCE</font>"</b> } </td> 
    <td width="50%"> 
     <div> 
      <p> <u> <b>Model Attribute Description </b> </u> <br/> </p> 
      <p>The HL7 attribute <b>determinerCode</b> describes this class as an instance of a person. </p> 
      <p> <u> <b>Implementation in XML Instance </b> </u> <br/> </p>The XML attribute 
      <b>determinerCode</b> is fixed to "
      <font color="#ff0000"> <b>INSTANCE</b> </font>". 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[1..1] </b></font><font color="green"><b> [M] </b></font><b>name</b> (<a href="../../../Data Types/datatypes.html#PN"><b>PN</b></a>) </td> 
    <td width="50%"> 
     <div> 
      <p> <u> <b>Model Attribute Description </b> </u> <br/> </p> 
      <p>The HL7 attribute <b>name</b> provides a name associated with the person. </p> 
      <p> <u> <b>Implementation in XML Instance </b> </u> <br/> </p> 
      <p>The <b>Person Name Structured</b> <b> with optional Use and optional Valid Time</b> flavour of the<b> PN</b> data type is the recommended format for the person's name. This information is carried in the XML element <b>name </b>as follows: </p> 
      <ul> 
       <li>The XML element <b>prefix</b> should contain the person's title </li> 
       <li>The XML element <b>given</b> should contain the person's forenames; there can be as many occurrences of the XML element as required<br/> </li> 
       <li>The XML element <b>family</b> should contain the person's surname </li> 
       <li>The XML element <b>suffix</b> may contain any suffix for the person<br/> </li> 
      </ul> 
      <p>Additionally the XML attribute <b>use</b> of the XML element <b>name </b>should be used to indicate the type of name; the recommended codes to be used are listed below: </p> 
      <p>Note some of the codes listed are NHS extensions, these are marked with an * <br/> </p> 
      <table align="center" width="90%" class=" table"> 
       <tbody> 
        <tr> 
         <th width="30%">Code</th> 
         <th width="70%">Definition</th> 
        </tr> 
        <tr> 
         <td> <b>L</b> <br/> </td> 
         <td>Legal<br/> </td> 
        </tr> 
        <tr> 
         <td> <b>PREFERRED *</b> <br/> </td> 
         <td>Preferred name<br/> </td> 
        </tr> 
       </tbody> 
      </table> 
      <p>Additionally the XML element <b>validTime</b> of the XML element <b>name</b> may be used to indicate the time when the name is valid/was valid for the person, some uses are shown below: <br/> </p> 
      <ul> 
       <li>A point in time when the name details are known to be valid<br/> </li> 
       <li>A start and end time</li> 
       <ul> 
        <li>To represent the period of time the person is/was known by this name<br/> </li> 
       </ul> 
       <li>A start time only to indicate when the name is/was valid from for the person<br/> </li> 
       <li>An end time only to indicate that the name is/was only valid for the person until a certain date </li> 
      </ul> 
      <br/> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[1..1] </b></font><font color="green"><b> [M] </b></font><b>templateId</b> (<a href="../../../Data Types/datatypes.html#II"><b>II</b></a>)<br/> {<b> Fixed="<font color="red">COCD_TP145214GB01#associatedPerson</font>"</b> } </td> 
    <td width="50%"> 
     <div> 
      <u> <b>Model Attribute Description</b> </u> 
      <br/> 
      <br/>The HL7 attribute 
      <b>templateId</b> 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.
      <br/> 
      <br/> 
      <u> <b>Implementation in XML Instance</b> </u> 
      <br/> 
      <br/>The 
      <b>Identifier External </b>data type flavour is used to carry this information in the XML element 
      <b>templateId</b> as follows:
      <br/> 
      <ul> 
       <li>The XML attribute <b>root</b> is fixed to the OID "<font color="#ff0000"> <b>2.16.840.1.113883.2.1.3.2.4.18.2</b> </font>" </li> 
       <li>The XML attribute <b>extension</b> is fixed to "<font color="#ff0000"> <b>COCD_TP145214GB01#associatedPerson</b> </font>" </li> 
      </ul> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="class"> 
    <td class="entclass"><a name="Organization"> </a><b>Organization</b></td> 
    <td width="50%"> 
     <div> 
      <p> <b>This class details the organisation which scopes the role (the organisation which employs the person who is in the role).<br/> </b> </p> 
     </div> </td> 
   </tr> 
   <tr class="mif"> 
    <td align="right" width="50%"/> 
    <td><font color="gray">Used by: </font><a href="#AssociatedEntity"><b>AssociatedEntity</b></a></td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[1..1] </b></font><font color="green"><b> [M] </b></font><b>classCode</b> (<a href="../../../Data Types/datatypes.html#CS"><b>CS</b></a> {<a> </a><b>CNE</b>:<a> </a><b>EntityClass</b> } )<br/> {<b> Fixed="<font color="red">ORG</font>"</b> } </td> 
    <td width="50%"> 
     <div> 
      <p> <u> <b>Model Attribute Description </b> </u> <br/> </p> 
      <p>The HL7 attribute <b>classCode</b> describes this class as an organisation. </p> 
      <p> <u> <b>Implementation in XML Instance </b> </u> <br/> </p> 
      <p>The XML attribute <b>classCode</b> is fixed to "<b> <font color="#ff0000">ORG</font> </b>". <br/> </p> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[1..1] </b></font><font color="green"><b> [M] </b></font><b>determinerCode</b> (<a href="../../../Data Types/datatypes.html#CS"><b>CS</b></a> {<a> </a><b>CNE</b>:<a> </a><b>EntityDeterminer</b> } )<br/> {<b> Fixed="<font color="red">INSTANCE</font>"</b> } </td> 
    <td width="50%"> 
     <div> 
      <p> <u> <b>Model Attribute Description </b> </u> <br/> </p> 
      <p>The HL7 attribute <b>determinerCode</b> describes this class as an instance of an organisation. </p> 
      <p> <u> <b>Implementation in XML Instance </b> </u> <br/> </p> 
      <p>The XML attribute <b>determinerCode</b> is fixed to "<font color="#ff0000"> <b>INSTANCE</b> </font>". <br/> </p> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[1..1] </b></font><font color="green"><b> [M] </b></font><b>id</b> (<a href="../../../Data Types/datatypes.html#II"><b>II</b></a>) </td> 
    <td width="50%"> 
     <div> 
      <p> <u> <b>Model Attribute Description </b> </u> <br/> </p> 
      <p>The HL7 attribute<b> id</b> uses an ODS code as an identifier that uniquely identifies the organisation which employs the person in the role. 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. </p> 
      <p> <u> <b>Implementation in XML Instance </b> </u> <br/> </p> 
      <p>When ODS site code is used then the XML element <b>id </b>is populated in the following way: </p> 
      <ul> 
       <li>The XML attribute <b>root</b> shall contain an OID with the value "<font color="#ff0000"> <b>2.16.840.1.113883.2.1.3.2.4.19.2</b> </font>" </li> 
       <li>The XML attribute <b>extension</b> shall contain the ODS site code. </li> 
      </ul> 
      <p>When ODS organisation code is used then the XML element <b>id </b>is populated in the following way:<br/> </p> 
      <ul> 
       <li>The XML attribute <b>root</b> shall contain an OID with the value "<font color="#ff0000"> <b>2.16.840.1.113883.2.1.3.2.4.19.1</b> </font>" </li> 
       <li>The XML attribute <b>extension</b> shall contain the ODS organisation code. </li> 
      </ul> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[1..1] </b></font><font color="green"><b> [M] </b></font><b>name</b> (<a href="../../../Data Types/datatypes.html#ON"><b>ON</b></a>) </td> 
    <td width="50%"> 
     <div> 
      <p> <u> <b>Model Attribute Description </b> </u> <br/> </p> 
      <p>The HL7 attribute <b>name</b> uses the description of the organisation associated with the ODS code. </p> 
      <p> <u> <b>Implementation in XML Instance </b> </u> <br/> </p> 
      <div>
       The XML element 
       <b>name</b> will carry the description associated with the ODS code carried in the XML attribute 
       <b>extension</b> of the XML element 
       <b>id</b>. 
      </div> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[0..1] </b></font><b>standardIndustryClassCode</b> (<a href="../../../Data Types/datatypes.html#CE"><b>CE</b></a> {<a> </a><b>CWE</b>:<a> </a><b>OrganizationIndustryClass</b> } ) </td> 
    <td width="50%"> 
     <div> 
      <p> <u> <b>Model Attribute Description</b> </u> </p> 
      <p>The HL7 attribute <b>standardIndustryClassCode</b> uses a code from any vocabulary to describe the type of organisation. The vocabulary <b>OrganizationIndustryClass </b>is the default HL7 vocabulary and is not recommended for use in the NHS and therefore a suitable local vocabulary should be used instead. </p> 
      <p> <u> <b>Implementation in XML Instance</b> </u> </p> 
      <p>The <b>Coded with Equivalents</b> (CE) data type shall be used to carry this information in the XML element <b>standardIndustryClassCode</b> as follows: </p> 
      <p>When an OID is available for the alternative vocabulary then: <br/> </p> 
      <ul> 
       <li>Th<i>e </i>XML attribute <b>code</b> shall contain a code from the alternative vocabulary </li> 
       <li>The XML attribute <b>codeSystem</b> shall contain the OID for the alternative vocabulary </li> 
       <li>The XML attribute <b>displayName</b> shall carry a description associated with the code in the alternative vocabulary </li> 
       <li>The XML attribute <b>originalText</b> may be used if required to carry the text or phrase used as the basis for the coding </li> 
      </ul> 
      <p>When no OID is available for the alternative vocabulary then: <br/> </p> 
      <ul> 
       <li>Th<i>e </i>XML attribute <b>code</b> shall contain a code from the alternative vocabulary </li> 
       <li>The XML attribute <b>codeSystem</b> shall contain the OID "<font color="#ff0000"> <b>2.16.840.1.113883.2.1.3.2.4.17.331</b> </font>" </li> 
       <li>The XML attribute <b>displayName</b> shall carry a description associated with the code in the alternative vocabulary </li> 
       <li>The XML attribute <b>originalText</b> may be used if required to carry the text or phrase used as the basis for the coding </li> 
      </ul> 
      <br/> 
     </div> </td> 
   </tr> 
   <tr valign="top" class="part"> 
    <td width="50%"><font color="green"><b>[1..1] </b></font><font color="green"><b> [M] </b></font><b>templateId</b> (<a href="../../../Data Types/datatypes.html#II"><b>II</b></a>)<br/> {<b> Fixed="<font color="red">COCD_TP145214GB01#scopingOrganization</font>"</b> } </td> 
    <td width="50%"> 
     <div> 
      <div> 
       <p> <u> <b>Model Attribute Description</b> </u> <br/> <br/> The HL7 attribute <b>templateId</b> 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. </p> 
       <p> <u> <b>Implementation in XML Instance </b> </u> <br/> </p> 
       <p>The <b>Identifier External </b>data type flavour is used to carry this information in the XML element <b>templateId</b> as follows: </p> 
       <ul> 
        <li>The XML attribute <b>root</b> is fixed to the OID "<font color="#ff0000"> <b>2.16.840.1.113883.2.1.3.2.4.18.2</b> </font>" </li> 
        <li>The XML attribute <b>extension</b> is fixed to "<font color="#ff0000"> <b> <span class="redText">COCD_TP145214GB01#scopingOrganization</span> </b> </font>". </li> 
       </ul> 
      </div> 
     </div> </td> 
   </tr> 
  </tbody>
 </table>  
</div></div></div></div><div id="push"/></div><div id="footer"><div class="container"><div class="row"><div class="span4"><p class="text-left"><a href="mailto:interoperability@hscic.gov.uk?subject=NHS111 v2.0 RC1">Contact us
            					</a></p></div><div class="span4"><p class="text-right"><b>Release Date: </b>17-Jun-2019</p></div></div></div></div><script src="../../../Template/js/jquery/jquery-1.8.3.js"> </script><script src="../../../Template/js/bootstrap/bootstrap.min.js"> </script><script src="../../../Template/js/google-code-prettify/prettify.js"> </script><script>
				!function ($){$(function(){window.prettyPrint && prettyPrint()})}(window.jQuery)
				</script></body></html>