Nullification
Domain Message Specification

AuthorNonNamedPersonUniversal Tabular View

COCD_TP145208GB01
AssignedAuthor

A universal template for an author where information about the person is not available or required but the type of person (their role) and their organisation 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

The XML attribute classCode is fixed to " ASSIGNED".
[1..1] [R] code (CV { CWE:JobRoleName } )
Model Attribute Description

The HL7 attribute code uses a code from the JobRoleName vocabulary or any alternative vocabulary to describe the type of person's 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:

  • The XML attribute code shall contain the code from the JobRoleName vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.124"
  • The XML attribute displayName shall carry the description associated with the code in the JobRoleName vocabulary.
When an alternative vocabulary is used and an OID is available then:
  • The XML attribute code shall contain the code from the alternative vocabulary
  • The XML attribute codeSystem shall contain the OID for the alternative vocabulary
  • The XML attribute displayName shall carry the description from the alternative vocabulary

When an alternative vocabulary is used and no OID is available then:

  • The XML attribute code shall contain the code from the alternative vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.339"
  • The XML attribute displayName shall carry the description from the alternative vocabulary

Where no information about the person's role is available then the XML attribute nullFlavor of the XML element code should contain "NI".

If the XML element id of this class uses a nullFlavor, the XML element JobRoleName should not use a nullFlavor.

[1..1] [R] id (II)

Model Attribute Description

The HL7 attribute id uses a local identifier to identify the role of the person who is the author.

Implementation in XML Instance

When using a local identifier where the code system can be identified using an OID then the XML element id shall carry the identifier as follows:
  • The XML attribute root shall contain the OID for the identifying system.
  • The XML attribute extension shall contain the author's role identifier.

When using an alternative identifier where the code system can not be identified using an OID then the XML element id shall carry the identifier as follows:

  • The XML attribute root shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.37".
  • The XML attribute extension shall contain the author's role 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"

Where no identifier is available then the XML attribute nullFlavor of the XML element id shall contain "NI".

Note: If the XML element JobRoleName of this class uses a XML attribute nullFlavor, then the author XML element id should not use a XML attribute nullFlavor.

[1..1] [M] templateId (II)
{ Fixed="COCD_TP145208GB01#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:
  • 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_TP145208GB01#AssignedAuthor"
[1..1] [M] representedOrganization (Organization)

A link to the scoping organisation.

Organization

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

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 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:

  • 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_TP145208GB01#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_TP145208GB01#representedOrganization".