AuthorPersonUniversal Tabular View
| COCD_TP145200GB01 | |||||||||||
| AssignedAuthor |
This template class constrains the CDA AssignedAuthor class. A universal template for an author where information about the person and the organisation they work for is required to be sent between systems. |
||||||||||
| 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
|
||||||||||
| [0..*] addr (SET<AD>) |
Model Attribute Description The HL7 attribute addr provides a set of addresses associated with the role. This should be the address for where the information was authored. 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.
The XML element useablePeriod of XML element addr can be used to indicate some of the following types of valid times:
|
||||||||||
| [1..1] [R] code (CV { CWE:JobRoleName } ) |
Model Attribute Description
The HL7 attribute code uses a code from any available vocabulary to describe the person job role. 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: When the JobRoleName vocabulary is used then:
When an alternative vocabulary is used and no OID is available then:
Where no information about the person's role is available then the XML attribute nullFlavor of the XML element code should contain "NI" (no information). If the XML element id of this class uses a nullFlavor, the XML element code should not use a nullFlavor. |
||||||||||
| [1..*] [R] id (SET<II>) |
Model Attribute Description The HL7 attribute id uses one or more identifier(s) including local identifiers to identify the person who is the author. Implementation in XML Instance When using SDS identifiers then: The first instance of the XML element id is mandatory and shall carry the SDS User ID, the second instance of XML element id 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 id as follows: The first instance of the XML element id shall carry an SDS identifier that uniquely identifies the person as follows:
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:
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:
Where no identifier is available then the XML attribute nullFlavor of the XML element id shall contain "NI". Note: If the XML element code of this class uses a XML attribute nullFlavor, then the author XML element id should not use a XML attribute nullFlavor. |
||||||||||
| [0..*] telecom (SET<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 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:
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:
|
||||||||||
| [1..1] [M] templateId (II) { Fixed="COCD_TP145200GB01#AssignedAuthor" } |
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:
|
||||||||||
| [1..1] [M] assignedPerson (Person) |
A link to the person playing this role. |
||||||||||
| [1..1] [M] representedOrganization (Organization) |
A link to the scoping organisation. |
||||||||||
| Person |
This template class constrains the CDA Person class. A class which details the person who is the author. |
||||||||||
| Used by: AssignedAuthor | |||||||||||
| [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
|
||||||||||
| [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
|
||||||||||
| [1..1] [M] name (PN) |
Model Attribute Description The HL7 attribute name provides a name associated with the person who is the author. 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 author's name. This information is carried in the XML element name as follows:
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 *
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:
|
||||||||||
| [1..1] [M] templateId (II) { Fixed="COCD_TP145200GB01#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:
|
||||||||||
| Organization |
This template class constrains the CDA Organization class. This class details the organisation which scopes the role of the author (the organisation which employs the person who is the author). |
||||||||||
| Used by: AssignedAuthor | |||||||||||
| [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
|
||||||||||
| [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
|
||||||||||
| [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 author. 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:
|
||||||||||
| [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
|
||||||||||
| [1..1] [M] templateId (II) { Fixed="COCD_TP145200GB01#representedOrganization" } |
Model Attribute Description Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|