R_AgentRole - tabular view

Allows a choice of the method of representation of the Agent

Used where the role is not defined on SDS.  This applies to all Organizations and Devices as well as Persons who are not registered NPfIT users.

Used where the role is defined on SDS.  This only applies to Persons who are or were a registered NPfIT user

Used where the role is not defined on SDS. This applies to all Organizations and Devices as well as Persons who are not registered NPfIT users

Indicates that this an Agent role.

• Fixed value: "AGNT"

Although the classCode is an attribute of the Agent element, it need not be included in message instances as its value is fixed in the schema.

One repeat is mandatory to provide a DCE UUID for the agent. This identifier is used as a reference within the message to this particular agent (the id field of the agentRef class will contain this identifier) wherever this agent has participated in a particular act.

Where the agent is a GP not on SDS, a second repeat may be present to provide the national GP code.

Where the agent is a person who is not a GP, or is an organization or device, no second repeat will be present.

To provide a DCE UUID, the Identifier Global datatype flavour is used as follows:

• the root attribute shall contain a DCE UUID.

A national GP code is carried in the following way:

• the root attribute shall contain an OID with the value "2.16.840.1.113883.2.1.4.2";
• the extension attribute shall contain the national GP code itself.

A code identifying the type of role that the agent is playing

The Coded Plain datatype flavour is used to carry this information as follows:

• The code attribute will contain a value from the list of codes in the EhrEgentType vocabulary that are applicable to the type of agent;
• The codeSystem attribute will contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.15";
• The displayName attribute will contain the text meaning of the code

To optionally provide addresses that are specific to the role being played.

To provide telecommunication contact details that are specific to the role being played.

Information about the entity (person, organization or device) playing the role of agent.

Information about the entity (person or organization) represented by the agent.

Used where the role is defined on SDS. This only applies to Persons who are or were a registered NPfIT user.

Indicates that this is an Agent role

• Fixed value: "AGNT"

Although the typeCode is an attribute of the AgentSDS element, it need not be included in message instances as its value is fixed in the schema.

One repeat is mandatory to provide a DCE UUID for the agent. This identifier is used as a reference within the message to this particular agent (the id field of the agentRef class will contain this identifier) wherever this agent has participated in a particular act.

A second repeat is mandatory to provide the SDS role profile ID for the agent.

To provide a DCE UUID, the Identifier Global datatype flavour is used as follows:

• the root attribute shall contain a DCE UUID.

A SDS role profile ID is carried in the following way:

• the root attribute shall contain an with the value "1.2.826.0.1285.0.2.0.67";
• the extension attribute shall contain the SDS role profile ID itself.

Information about the person on SDS.

Identifies and provides details about the entity (person, organisation or device) which plays this role.

Identifies and provides details about the entity (person, organisation or device) which plays this role.

Identifies and provides details about the entity (person, organisation or device) which plays this role.

Identifies and provides details about the entity (person, organisation or device) which plays this role.

Identifies and provides details about the entity (person, organisation or device) which plays this role.

Identifies and provides details about the entity (person, organisation or device) which plays this role.

Identifies and provides details about the entity (person, organisation or device) which plays this role.

Identifies and provides details about the entity (person, organisation or device) which plays this role.

Identifies and provides details about the entity (person, organisation or device) which plays this role.

Identifies and provides details about the entity (person, organisation or device) which plays this role.

Identifies and provides details about the entity (person, organisation or device) which plays this role.

Identifies and provides details about the entity (person, organisation or device) which plays this role.

Information about the organisation maintaining the EHR application.

Indicates that this is an organisation.

• Fixed value

Although the classCode is an attribute of the maintainingOrganization element, it need not be included in message instances as its value is fixed in the schema.

Indicates that this is a specific instance of an organisation not a general kind of organisation.

• Fixed value

Although the determinerCode is an attribute of the maintainingOrganization element, it need not be included in message instances as its value is fixed in the schema.

To optionally provide a national code for the organization.

A national organization code is carried in the following way:

• the root attribute shall contain an with the value "2.16.840.1.113883.2.1.4.3";
• the extension attribute shall contain the national organization code itself.

Indicates the type of organisation.

The name of the organisation.

A description of the type of Organization. This shall be included if a code is not present.

Telecommunication numbers for the organisation.

• Includes email or web addresses where appropriate.

The address of the organisation.

Information about the organisation maintaining the EHR application.

Indicates that this is an organisation.

• Fixed value

Although the classCode is an attribute of the maintainingOrganization element, it need not be included in message instances as its value is fixed in the schema.

Indicates that this is a specific instance of an organisation not a general kind of organisation.

• Fixed value

Although the determinerCode is an attribute of the maintainingOrganization element, it need not be included in message instances as its value is fixed in the schema.

An SDS identifier that uniquely identifies the Organization. This is carried in the following way:

• The root attribute shall contain an OID with the value 1.2.826.0.1285.0.1.10.
• the extension attribute shall contain the SDS Organization ID itself

Details about a person who is related to the patient.

Indicates that this is a person.

• Fixed value

Although the classCode is an attribute of the player element, it need not be included in message instances as its value is fixed in the schema.

Indicates that this refers to a specific person.

• Fixed value

Although the determinerCode is an attribute of the player element, it need not be included in message instances as its value is fixed in the schema.

An identifier for the person.

In the GP2GP Project

• The NHS number is used for patients
• The GP number used in GP-HA link is used to identify GPs
• The OCS issued number is used for other health professionals (where available)
• Other profession identification schemes may be usable by future agreement.
• If no national code is available a GUID should be used to identify instances of the same person within a single message so that these are clearly recognisable as referring to the same real world instance.

Details about a person who is related to the patient.

Indicates that this is a person.

• Fixed value

Although the classCode is an attribute of the player element, it need not be included in message instances as its value is fixed in the schema.

Indicates that this refers to a specific person.

• Fixed value

Although the determinerCode is an attribute of the player element, it need not be included in message instances as its value is fixed in the schema.

To optionally provide one or more names of the person.

The sex of the person (e.g., female, male).

• This code is for administrative purposes only and does not imply a particular genetic or physical sex. Therefore, were gender is indeterminate the value should be as registered with the health provider.

Information about the EHR application device.

Indicates that this is a device.

• Fixed value

Although the classCode is an attribute of the maintainedDevice element, it need not be included in message instances as its value is fixed in the schema.

Indicates that this is a specific instance not a general kind of device.

• Fixed value

Although the determinerCode is an attribute of the maintainedDevice element, it need not be included in message instances as its value is fixed in the schema.

To provide a unique identifier for this particular device.

The Identifier Global datatype flavour is used to carry this information as follows:

• The root attribute will contain a DCE UUID.

Information about the EHR application device.

Indicates that this is a device.

• Fixed value

Although the classCode is an attribute of the maintainedDevice element, it need not be included in message instances as its value is fixed in the schema.

Indicates that this is a specific instance not a general kind of device.

• Fixed value

Although the determinerCode is an attribute of the maintainedDevice element, it need not be included in message instances as its value is fixed in the schema.

To provide a unique identifier for this particular device.

The Identifier Global datatype flavour is used to carry this information as follows:

• The root attribute will contain a DCE UUID.

A code identifying the type of application.

The Coded Plain datatype flavour is used to carry this information as follows:

• The code attribute will contain a value from the list of codes in the EhrSystemCode vocabulary;
• The codeSystem attribute will contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.15";
• The displayName attribute will contain the text meaning of the code.

The name of the Device. This shall be included if an id element is not present.

A description of the type of Device. This shall be included if a code element is not present.

The model name as allocated by the Device manufacturer

Name, version and release of the software that operates the device.

• Names and version identifiers to be allocated by vendors within an agreed naming convention.