R_AgentNPFIT - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
UKCT_RM120100UK04
AgentRoleChoice

Alows a choice of the method of representation of the Agent

Used by:
[1..1] either : 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.

             ... or ... : AgentRef

Used where the agent details are available elsewhere in the message

             ... or ... : AgentSDS

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

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

Indicates that this an Agent role.

  • Fixed value: "AGNT"
[0..2] id (SET<II>)

The first identifier can be used where the agent role has a nationally agreed identifier.  This may be either a code from a national scheme or a DCE UUID.

A national code is carried in the following way:

  • the root attribute shall contain the OID that identifies the coding scheme
  • the extension attribute shall contain the code

A DCE UUID is carried in the root attribute

The second identifier shall only be used where the agent is being carried as part of an 'agent directory' in the message and the first identifier is not a DCE UUID.  In this case the second identifier is a DCE UUID that can be used from elsewhere in the message to refer to this agent.  The DCE UUID is carried in the root attribute.

[0..1] code (CV {CNE:RoleCode} )

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

[0..*] addr (SET<AD>)

Addresses that are specific to the role being played

[0..*] telecom (SET<TEL>)

Telecommunication contact details that are specific to the role being played

[0..1] player (PlayingEntityChoice)

Allows a choice of the mechanism for representing the Person, Organization or Device that is playing the role.

[0..1] scoper (ScoperChoice)

Allows a choice of the mechanism for representing the Person or Organization that is scoping (defining) the role.

AgentRef
Used by: AgentRoleChoice
[1..1] classCode (CS {CNE:AGNT} ){ Fixed="AGNT " }

Indicates that this is an Agent role

  • Fixed value: "AGNT"
[1..1] id (II)

A DCE UUID that is used to point to the agent details in an 'Agent Directory' elsewhere in the message.

The DCE UUID is carried in the root attribute.

AgentSDS
Used by: AgentRoleChoice
[1..1] classCode (CS {CNE:AGNT} ){ Fixed="AGNT " }

Indicates that this is an Agent role

  • Fixed value: "AGNT"
[1..2] id (SET<II>)

The first identifier is used to carry the SDS Role Profile ID.  This is carried in the following way:

  • The root attribute shall contain an OID with the value 2.16.840.1.113883.2.1.3.2.4.11
  • the extension attribute shall contain the SDS Role Profile ID

The second identifier shall only be used where the agent is being carried as part of an 'agent directory' in the message and is a DCE UUID that can be used from elsewhere in the message to refer to this agent.  The DCE UUID is carried in the root attribute.

[1..1] agentPersonSDS (PersonSDS)

Information about the Person playing the role.

[0..1] part

Information about the target role that is linked to the AgentSDS Role.

[1..1] typeCode (CS {CNE:PART} ){ Fixed="PART " }

Indicates that the target role is a part of the source role. 

  • Fixed value: "PART"
[1..1] partSDSRole (SDSRole)

Information about the target role that is linked to the AgentSDS Role.

PlayingEntityChoice
Used by: Agent
[0..*] serviceDeliveryLocation (ServiceDeliveryLocation)

When the agent is a Organization, it can have any number locations/places where care is provided.  These may be either formal care provision locations (eg. wards, consulting rooms etc.) or informal locations where care was given out of neccesity (eg. corridor, toilets etc.)

[1..1] either : Organization

An organization that is not on SDS

             ... or ... : OrganizationSDS

An organisation that is on SDS

             ... or ... : PersonSDS

A person that is on SDS

             ... or ... : Person

A person that is not on SDS

             ... or ... : DeviceSDS

A device that is on SDS

             ... or ... : Device

A device that is not on SDS

ScoperChoice
Used by: Agent
[1..1] either : Organization

An organization that is not on SDS

             ... or ... : OrganizationSDS

An organisation that is on SDS

             ... or ... : PersonSDS

A person that is on SDS

             ... or ... : Person

A person that is not on SDS

ServiceDeliveryLocation
Used by: PlayingEntityChoice
[1..1] classCode (CS {CNE:SDLOC} ){ Fixed="SDLOC " }

The SDLOC code domain should be refined to either:

  • DSDLOC - Dedicated Service Delivery Location
  • ISDLOC - Incidental Service Delivery Loaction

depending on whether the location is one where care is routinely provided.

[1..1] code (CV {CNE:EHRLocationType} )

A code specifying the type of location or place.

[0..1] location (Place)

Information about the place that is the Service Delivery Location.

Organization
Used by: AgentPlayingEntityChoiceAgentScoperChoice
[1..1] classCode (CS {CNE:ORG} ){ Fixed="ORG " }

Indicates that this is an Organization

  • Fixed value: "ORG"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that the entity is a single identifiable Organization

  • Fixed value: "INSTANCE"
[0..1] id (II)

An optional identifier that uniquely identifies the Organization.   This may be either a code from a national scheme or a DCE UUID.

A national code is carried in the following way:

  • the root attribute shall contain the OID that identifies the coding scheme
  • the extension attribute shall contain the code

A DCE UUID is carried in the root attribute.

If an id is not present, then a name shall be included.

[0..1] code (CS {CNE:OrganizationType} )

The type of Organization

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

  • The code attribute shall contain a value from the list of codes in the OrganizationType vocabulary.

If a code is not present, then a desc shall be included.

[0..1] name (ON)

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

[0..1] desc (ST)

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

[0..1] telecom (TEL)

The telephone contact details for the Organization.

[0..1] addr (AD)

The address of the Organization.

OrganizationSDS
Used by: AgentPlayingEntityChoiceAgentScoperChoice
[1..1] classCode (CS {CNE:ORG} ){ Fixed="ORG " }

Indicates that this is an Organization

  • Fixed value: "ORG"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that the entity is a single identifiable Organization

  • Fixed value: "INSTANCE"
[1..1] id (II)

A valid SDS identifier that uniquely identifies the Organization.  This could come from a number of SDS sets including (but not limited to) Organisations and Workgroups.  The root attribute shall be the OID for the SDS code set and the extension shall contain the code.

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

Indicates that this is a Role.

  • Fixed value: "ROL"
[0..1] id (II)

An SDS identifier that identifies the Job Role within the Role Profile Id. This is carried in the following way:

  • The root attribute shall contain an OID with the value 2.16.840.1.113883.2.1.3.2.4.11
  • The extension attribute shall contain the SDS Job Role.
Place
Used by: ServiceDeliveryLocation
[1..1] classCode (CS {CNE:PLC} ){ Fixed="PLC " }

Indicates that this is a Place

  • Fixed value: "PLC"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that the entity is a single identifiable Place.

[0..1] name (PN)

The name of the Place.

[0..1] telecom (TEL)

The telephone number of the Place.

[0..1] addr (AD)

The address of the Place.

PersonSDS
Used by: AgentAgentAgentAgentAgentSDS
[1..1] classCode (CS {CNE:PSN} ){ Fixed="PSN " }

Indicates that this is a Person

  • Fixed value: "PSN"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that the entity is a single identifiable Person

  • Fixed value: "INSTANCE"
[1..1] id (II)

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

  • The root attribute shall contain an OID with the value 1.2.826.0.1285.0.2.0.65
  • the extension attribute shall contain the SDS User ID
Person
Used by: AgentAgentAgentAgent
[1..1] classCode (CS {CNE:PSN} ){ Fixed="PSN " }

Indicates that this is a Person

  • Fixed value: "PSN"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that the entity is a single identifiable Person

  • Fixed value: "INSTANCE"
[0..1] id (II)

An optional identifier that uniquely identifies the Person.  This may be either a code from a natinal scheme or a DCE UUID.

A national code is carried in the following way:

  • the root attribute shall contain the OID that identifies the coding scheme
  • the extension attribute shall contain the code

A DCE UUID is carried in the root attribute.

If an id is not present, then a name shall be included.

[0..1] name (PN)

The name or the Person.

[0..1] administrativeGenderCode (CS {CNE:Sex} )

The code of the sex of the patient.

DeviceSDS
Used by: AgentAgent
[1..1] classCode (CS {CNE:DEV} ){ Fixed="DEV " }

Indicates that this is a Device. In this context the device can be hardware or software.

  • Fixed value: "DEV"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that this is a single identifiable Device

  • Fixed value: "INSTANCE"
[1..1] id (II)

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

  • The root attribute shall contain an OID with the appropriate value 
  • the extension attribute shall contain the SDS Device ID
Device
Used by: AgentAgent
[1..1] classCode (CS {CNE:DEV} ){ Fixed="DEV " }

Indicates that this is a Device

  • Fixed value: "DEV"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that this is a single identifiable Device

  • Fixed value: "INSTANCE"
[0..1] id (II)

An optional identifier that uniquely identifies the Device.   This may be either a code from a national scheme or a DCE UUID.

A national code is carried in the following way:

  • the root attribute shall contain the OID that identifies the coding scheme
  • the extension attribute shall contain the code

A DCE UUID is carried in the root attribute.

If an id is not present, then a name shall be included.

[0..1] code (CS {CNE:DeviceType} )

The type of Device

If a code is not present, then a desc shall be included.

[0..1] name (ST)

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

[0..1] desc (ST)

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

[0..1] manufacturerModelName (SC)

The model name as allocated by the Device manufacturer.

[0..1] softwareName (SC)

The name of the software used by the Device.