Health and Social Care Integration
Domain Message Specification

NonNamedPersonUniversal Tabular View

COCD_TP145013UK03
ParticipantRole

This template is used when the details of the actual person involved is not available or not required to be sent.

Identifies the type person and their role in an organisation but not the actual person.


Used by:
[1..1] [M] classCode (CS { CNE: RoleClass } )
{ Fixed="ROL" }

Model Attribute Description

The HL7 attribute classCode describes this class as a role. This is a generic code and the type of role should be described using the HL7 attribute code whenever possible.

Implementation in XML Instance

The XML attribute classCode is fixed to " ROL".
[0..1] code (CV { CWE:CDAJobRoleName } )
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:

  • 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 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
[1..1] [M] templateId (II)
{ Fixed="COCD_TP145013UK03#ParticipantRole" }

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_TP145013UK03#ParticipantRole"
[1..1] [M] scopingOrganization (Organization)
A link to the organisation scoping this role.
Organization

This class details the organisation.

Used by: ParticipantRole
[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] desc (ST)

Model Attribute Description

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

Implementation in XML Instance

The XML element desc 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_TP145013UK03#scopingOrganization" }

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_TP145013UK03#scopingOrganization"