Structured Headings
Domain Message Specification

Version: 1.0; Status: RC4

RelatedEntity Tabular View

COCD_TP145007UK04
RelatedEntity

Template for a person with a relationship with the patient.

This class is used to specify the type of relationship.

For example mother or carer.
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 uses an address for the person who has a relationship with the patient.

The HL7 attribute addr allows structured and unstructured addresses to be carried. Only structured addresses are recommended to be used.

Implementation in XML Instance

There are a number of forms of structured address. The three shown here are the recommended formats for patient addresses, they are listed in no particular order.

The XML element addr is populated as follows:

When using the structured address in the style of PDS the XML element addr shall contain five XML elements streetAddressLine.

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

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

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

When using the fully structured address format then the XML element addr shall be populated as follows:

  • The XML element houseNumber shall contain the house/building number or name
  • The XML element streetName shall contain the street name
  • The XML element city shall contain the city name
  • The XML element county shall contain the county
  • The XML element country shall contain the country name
  • The XML element postalCode shall contain the postcode
  • The XML element addressKey shall contain the address key

Note that unpopulated XML elements should not be present.

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 shall contain the first address line
  • The second XML element streetAddressLine shall contain the second address line
  • The third XML element streetAddressLine shall contain the third address line
  • and so on ....

Note that unpopulated XML elements should not be present.

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

Code
Definition
WP Work place - An office address. First choice for business related contacts during business hours.
TMP Temporary address - A 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.
H
 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.
HP
 The primary home address - An address to reach a person after business hours.
HV
 A vacation home - An address to reach a person while on vacation.

When the XML attribute use of the XML element addr contains the value "PHYS" then the following two XML elements of the XML element addr may be populated.

  • The XML element desc of the XML element addr may contain a description of the address; this may be used for things like directions for the address
  • The XML element additionalLocator of the XML element addr may contain additional location information such as longitude and latitude coordinates

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

  • 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 of an office for a work address
    • 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] [M] code (CV { CNE:CDAPersonRelationshipType } )

Model Attribute Description

The HL7 attribute code uses a code from the CDAPersonRelationshipType vocabulary to describe the relationship between the patient and the named person.

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 code as follows:

  • The XML attribute code shall contain a code from the CDAPersonRelationshipType vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.16.45"
  • The XML attribute displayName shall carry the name associated with the code
[1..1] [R] id (SET<II>)

Model Attribute Description

The HL7 attribute id is only present for CDA conformance and is not used in this template

Implementation in XML Instance

The XML attribute nullFlavor of the XML element id shall contain " NA".
[0..1] telecom (TEL)

Model Attribute Description

The HL7 Attribute telecom specifies contact details for the person in the form of telephone numbers, fax numbers and email addresses.

Implementation in XML Instance

The XML value attribute 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 to be used for the patient 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.
H
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.
HP
Home primary - The primary contact to reach a person after business hours.
HV
 Home vacation - A vacation home, to reach a person while on vacation.
WP
 Work place - An office address. First choice for business related contacts during business hours
PG
Pager - A paging device suitable to solicit a callback or to leave a very short message.
MC
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.

The XML element useablePeriod of the 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 of an office for work contacts
    • 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_TP145007UK04#RelatedEntity" }
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_TP145007UK04#RelatedEntity"
[0..1] assignedPerson (Person)
A link to the assigned person.
Person

A class which details the person who has a relationship with the patient.
Used by: RelatedEntity
[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 has the relationship with the patient.

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 author, 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

[1..1] [M] templateId (II)
{ Fixed="COCD_TP145007UK04#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_TP145007UK04#assignedPerson"