A universal template for a recipient organization only
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 addr provides an address associated with the role.
This address is used to identify the address associated with the recipient; for example the GP practice address of the patient's GP.
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 or second XML element streetAddressLine and the fourth XML element streetAddressLine are mandated to be populated.
or the address may use the fully structured address:
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 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:
Model Attribute Description
The HL7 attribute telecom provides contact details for organisation 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.
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 the contact details associated with the role:
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:
This class details the organisation that the information is being sent to.
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 is the recipient. 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
Model Attribute Description
The HL7 attribute standardIndustryClassCode uses a code taken from the CDAOrganizationType vocabulary to indicate the type of organisation.
Implementation in XML Instance
The Coded Plain data type flavour of Coded Value (CV) shall be used to carry this information in the XML element standardIndustryClassCode as follows: