PdsTraceQuery Tabular View

The Control Act carries administrative information related to the "controlled act" that is being communicated in the message.

Used by:

[1..1] classCode (CS {CNE:CACT} ){ Fixed="CACT " }

Indicates that this is a control act.

Fixed value: "CACT" (Control act)

The classCode is carried as an attribute of the ControlActEvent element.

[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN " }

Indicates that this is an event which has occurred.

Fixed value: "EVN"

The moodCode is carried as an attribute of the ControlActEvent element.

[0..1] author

A participation referring to a person who is logged in at the time the message is initiated.

The participation is optional. It shall be present when the message is initiated by a person. It shall not be present when the message is automatically initiated by a system.


[1..1] typeCode (CS {CNE:AUT} ){ Fixed="AUT " }		Defines the type of participation of the linked party to the PDS registration, i.e. that the linked party is the author. Fixed value: "AUT" (Author [originator]) The typeCode is carried as an attribute of the author element.

[1..1] participant [CMET: UKCT_MT120901UK01]		NPfIT CMET to identify a person fulfilling a specific role where the Person, Role Profile and Job Role are all mandatory. Full details of the person, role profile and job role are available from SDS. In this context the person is the signed in user for the user session responsible for initiating the message.

[1..2] author1

A participation referring to one or more systems that are involved in the initiation of the message.

One instance of the participation is mandatory and shall carry the accredited service id of the system in use at the time the message is initiated.

One instance of the participation is optional and may carry the workstation id of the system being used by the logged in user at the time the message is initiated.


[1..1] typeCode (CS {CNE:AUT} ){ Fixed="AUT " }		Defines the type of participation of the linked party to the PDS registration, i.e. that the linked party is the author. Fixed value: "AUT" (Author [originator]) The typeCode is carried as an attribute of the author1 element.

[1..1] participant [CMET: UKCT_MT121001UK01]		NPfIT CMET to identify a mandatory system which could be software or hardware. Full details of the system are available from SDS. In this context the system is a system in use at the time the message is initiated.

[1..1] query (Query)

A heading for providing information about the query.

Query

A heading for providing information about the query, in this case, a search for a Service User record on the PDS.

Used by: ControlActEvent

[0..1] person.address (Person.address)

A heading for providing information about the person address parameter.

The person address parameter may occur zero or one time identifying part of the usual address (full postcode or PAF Key) of the person that is being searched for.

[1..1] person.administrativeGenderCode (Person.administrativeGenderCode)

A heading for providing information about the person administrative gender code parameter.

The person administrative gender code parameter shall occur one time identifying the administrative gender code of the person being searched for.

[1..1] person.birthTime (Person.birthTime)

A heading for providing information about the person birth time parameter.

The person birth time parameter shall occur one time providing a full birth date of the person being searched for.

[0..1] person.deceasedTime (Person.deceasedTime)

A heading for providing information about the person deceased time parameter.

The person deceased time parameter may occur zero or one time providing a full death date of the person being searched for.

[1..1] person.name (Person.name)

A heading for providing information about the person name parameter.

The person name parameter shall occur one time identifying the usual name (or part of the usual name) of the person being searched for.

Person.address

A heading for providing information about the person address parameter.

The person address parameter may occur zero or one time identifying part of the usual address (full postcode or PAF Key) of the person that is being searched for.

Used by: Query

[1..1] value (AD)

To provide the value of the parameter item (identified in the associated semanticsText element) to be searched.

In this context, the value element provides a part of the usual address (full postcode or PAF Key) of the person that is being searched for.

The type of address is required to be identified by using the following code in the use attribute:

H - usual address;

The following sub-elements are used to carry the components of an address:

A postalCode element is used to carry a postcode;
An addressKey element is used to carry a PAF key;

Where a part address is to be given, one or other of these elements shall be present, but not both.

NB: Although the type of address is fixed as "Usual address" for this search, the PDS will search all address types.

[1..1] semanticsText (ST)

A literal text string identifying the parameter item.

Person.administrativeGenderCode

A heading for providing information about the person administrative gender code parameter.

The person administrative gender code parameter shall occur one time identifying the administrative gender code of the person being searched for.

Used by: Query

[1..1] value (CS {CWE:Sex} )

To provide the value of the parameter item (identified in the associated semanticsText element) to be searched.

In this context, the value element provides an administrative gender code of the person that is to be searched for.

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

The code attribute will contain a value from the list of codes in the Sex vocabulary;

[1..1] semanticsText (ST)

A literal text string identifying the parameter item.

Person.birthTime

A heading for providing information about the person birth time parameter.

The person birth time parameter shall occur one time providing a full birth date of the person being searched for.

Used by: Query

[1..1] value (TS)

To provide the value of the parameter item (identified in the associated semanticsText element) to be searched.

In this context, the value element provides a date of birth of the person that is to be searched for.

The date shall only be given in the following format:

YYYYMMDD.

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

The value attribute will contain the date value in the format indicated.

A null flavor shall not be used.

[1..1] semanticsText (ST)

A literal text string identifying the parameter item.

Person.deceasedTime

A heading for providing information about the person deceased time parameter.

The person deceased time parameter may occur zero or one time providing a full death date of the person being searched for.

Used by: Query

[1..1] value (TS)

To provide the value of the parameter item (identified in the associated semanticsText element) to be searched.

In this context, the value element provides a date of death of the person that is to be searched for.

The date shall only be given in the following format:

YYYYMMDD.

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

The value attribute will contain the date value in the format indicated.

[1..1] semanticsText (ST)

A literal text string identifying the parameter item.

Person.name

A heading for providing information about the person name parameter.

The person name parameter shall occur one time identifying the usual name (or part of the usual name) of the person being searched for.

Used by: Query

[1..1] value (PN)

To provide the value of the parameter item (identified in the associated semanticsText element) to be searched.

In this context, the value element provides a structured usual name (or partial name) of the person that is to be searched for.

The following sub-elements are used to carry components of a structured name:

A single instance of the prefix element is used to carry a name title, for example, Mr, Mrs, Ms etc;
One or more instances of the given element are used to carry given names (or forenames) or initials, with the order in which they are carried in the message being significant, i.e. the first occurrence of the given element is used to carry the first given name, the second occurrence of the given element is used to carry the second given name etc;
A single instance of the family element is used to carry the family name (or surname);
A single instance of the suffix element is used to carry a name prefix, for example, Jnr, Snr etc.

The type of name is required to be identified by using the following code in the use attribute.

L - usual name.

NB: One occurrence of the family element is mandatory. The PDS will ignore any prefix or suffix elements. Although the type of name is fixed as "Usual name" for this search, the PDS will search all name types (i.e. usual, previous, preferred and alias).

[1..1] semanticsText (ST)

A literal text string identifying the parameter item.

PdsTraceQuery - tabular view