Structured Headings
Domain Message Specification

Version: 1.0; Status: RC3

RecipientWorkgroupUniversal Tabular View

COCD_TP145204GB03
RecipientWorkgroup

This template class constrains the CDA IntendedRecipient class.

A template to identify a workgroup or team which is a recipient of the information.

This class details the workgroup or team which is the recipient.
Used by:
[1..1] [M] classCode (CS { CNE: RoleClass } )
{ Fixed="ASSIGNED" }

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".
[0..1] addr (AD)

Model Attribute Description

The HL7 attribute addr provides an address associated with the team or workgroup. This is a physical location rather than a routing address.

The HL7 attribute addr allows structured and unstructured addresses to be carried in an instance. Only structured addresses are recommended to be used. There are a number of structured forms of addresses. The three shown here are the recommended formats for organisation addresses, they are listed in no particular order.

Implementation in XML Instance

When the structured address in the style of PDS is used then it shall contain five XML elements streetAddressLine.

  • The first XML element streetAddressLine should contain the premises name
  • The second XML element streetAddressLine should contain the number and thoroughfare
  • The third XML element streetAddressLine should contain the locality
  • The fourth XML element streetAddressLine should contain the post town
  • The fifth XML element streetAddressLine should contain the county

The first XML element streetAddressLine or second XML element streetAddressLine and the fourth XML element streetAddressLine are mandated to be populated.

  • The XML element postalCode may be used to carry a postcode
  • The XML element addressKey may be used to carry a PAF key

or the address may use the fully structured address:

  • The XML element houseNumber should contain the house/building number or name
  • The XML element streetName should contain contains the street name
  • The XML element city should contain the city name
  • The XML element county should contain the county
  • The XML element country should contain the country name
  • The XML element postalCode should contain the post code
  • The XML element addressKey should contain the address key

Alternatively the structured address may contain just a series of XML elements streetAddressLine populated in the correct order to render as a postal address with as much information as available included.

  • The first XML element streetAddressLine contains the first address line
  • The second XML element streetAddressLine contains the second address line
  • The third XML element streetAddressLine contains the third address line
  • and so on ....

The XML element addr allows an XML attribute use, this should be used to further define the organisation address when required. Only the use values listed below are recommended to be used for organisation addresses.

Code
 Definition
WP Work place - An office address. First choice for business related contacts during business hours.
TMP Temporary address - May be good for visit or mailing.
PHYS Physical visit address - Used primarily to visit an address.
PST
 Postal address - Used to send mail.

The XML element useablePeriod of XML element addr can be used to indicate some of the following types of valid times:

  • A point in time when the contact address details are valid
  • A start and end time
    • Just including hours and minutes to indicate opening hours
    • Using dates for indicating a contact address is only for a certain period of time
  • A start time only to indicate when the contact address is valid from
  • An end time only to indicate that the contact address is only valid until a certain date
[1..1] [R] id (II)

Model Attribute Description

The HL7 attribute id uses an identifier to identify the workgroup or team.

Implementation in XML Instance

The XML element id shall be used to carry this information as follows:

When using an SDS identifier then:

  • The XML attribute root shall be the OID "1.2.826.0.1285.0.2.0.109"
  • The XML attribute extension shall be the SDS workgroup code.

When using a local identifier and an OID is available on the sending system then:

  • The XML attribute root shall contain the OID for the identifying system.
  • The XML attribute extension shall contain the local workgroup identifier.

When using a local identifier and an OID is not available on the sending system then:

  • The XML attribute root shall be the OID "2.16.840.1.113883.2.1.3.2.4.18.24"
  • The XML attribute extension shall be the local workgroup 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"

When no workgroup name is available then:

The XML attribute nullFlavor of the XML element id shall contain the value "NI".

Note: If XML element recipientRoleCode uses a nullFlavor then the XML element id shall not.

[1..1] [R] recipientRoleCode (CV { CWE:WorkgroupRoleName } )

Model Attribute Description

The HL7 attribute recipientRoleCode uses the workgroup name to identify a workgroup or team by name.

The vocabulary used is a default one which contains no values and its only purpose is to allow the XML attribute displayName to carry the name of the workgroup or team. Where an alternative vocabulary is available this may be used.

Implementation in XML Instance

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element recipientRoleCode as follows:

When no alternative vocabulary is available then:

  • The XML attribute code shall contain the fixed value "01"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.266"
  • The XML attribute displayName shall carry the name of the workgroup or team.

When an alternative vocabulary is available then:

  • The XML attribute code shall contain a code from the vocabulary
  • The XML attribute codeSystem shall contain the OID for the vocabulary
  • The XML attribute displayName shall carry the name associated with the code.

When no workgroup name is available then:

The XML attribute nullFlavor of the XML element recipientRoleCode shall contain the value "NI".

Note: If XML element recipientRoleCode uses a nullFlavor then the XML element id shall not.
[0..*] telecom (SET<TEL>)

Model Attribute Description

The HL7 attribute telecom provides contact details for the workgroup or team in the form of telephone numbers, fax numbers and email addresses.

Implementation in XML Instance

This XML element telecom should be populated as below:

The XML attribute value of the XML element telecom should contain the telephone / fax number or an email address prefixed by the type of contact and a colon.

  • For a telephone number the actual telephone number would be prefixed with tel:
  • For a fax number the actual fax number would be prefixed with fax:
  • For an email address the actual email address would be prefixed with mailto:

The XML attribute use of the XML element telecom may be used to give further information about the type of contact details contained in the XML attribute value. Only the use values listed below are recommended for a workgroup or team's contact details:

Code Definition
AS 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.
EC
Emergency contact - A contact specifically designated to be used for emergencies. This is the first choice in emergencies, independent of any other use codes.

The XML element useablePeriod of XML element telecom 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:

  • A point in time when the contact details are valid.
  • A start and end time
    • Just including hours and minutes to indicate opening hours
    • Using dates for indicating a contact is only for a certain period of time
  • A start time only to indicate when the contact details are valid from
  • An end time only to indicate that the contact details are only valid until a certain date.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP145204GB03#RecipientWorkgroup" }
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_TP145204GB03#RecipientWorkgroup"
[0..1] assignedPerson (Person)

A link to the person who is a member of the team.
[1..1] [M] representedOrganization (Organization)

A link to the scoping organisation.
Organization

This template class constrains the CDA Organization class.

This class details the organisation which scopes the role of the recipient workgroup or team (the organisation which employs the workgroup or team which is the recipient).
Used by: RecipientWorkgroup
[1..1] [M] classCode (CS { CNE: EntityClass } )
{ Fixed="ORG" }

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".
[1..1] [M] determinerCode (CS { CNE: EntityDeterminer } )
{ Fixed="INSTANCE" }

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".
[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an ODS code as an identifier that uniquely identifies the organisation which employs the recipient workgroup or team. 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.
[1..1] [M] name (ON)

Model Attribute Description

The HL7 attribute name uses the description of the organisation associated with the ODS code.

Implementation in XML Instance

  • The XML element name will carry the description associated with the ODS code carried in the XML attribute extension of the XML element id.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP145204GB03#representedOrganization" }

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_TP145204GB03#representedOrganization".
Person

This template class constrains the CDA Person class.

A class which details a person who is a member of the recipient workgroup or team.
Used by: RecipientWorkgroup
[1..1] [M] classCode (CS { CNE: EntityClass } )
{ Fixed="PSN" }

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".
[1..1] [M] determinerCode (CS { CNE: EntityDeterminer } )
{ Fixed="INSTANCE" }

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".
[1..1] [M] name (PN)

Model Attribute Description

The HL7 attribute name provides a name associated with the person who is a member of the recipient workgroup or team.

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 recipient's name. This information is carried in the XML element name as follows:

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

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 recipient, 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 recipient is/was known by this name
  • A start time only to indicate when the name is/was valid from for the recipient
  • An end time only to indicate that the name is/was only valid for the recipient until a certain date.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP145204GB03#assignedPerson" }
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_TP145204GB03#assignedPerson"