PdsAdvancedTraceQuery - tabular view

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

Indicates that this is a control act.

• Fixed value: "CACT" (Control act)

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

Indicates that this is an event which has occurred.

• Fixed value: "EVN"

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

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.

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.

A heading for providing information about the query.

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

A heading for providing information about the historicDataIndicator parameter. The historicDataIndicator parameter shall occur one time to indicate whether or not historic data is required to be returned in the response to the query.

A heading for providing information about the person address parameter.

The person address parameter may occur zero or one time identifying either the usual address or a temporary address of the person being searched for.

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.  

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

The person birth time parameter shall occur one time either providing a full or partial birth date of the person being searched for, or providing a birth date range of the person being searched for.

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

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

A heading for providing information about the person identifier parameter.

The person identifier parameter may occur zero or one time providing an identifier of the person being searched for.

A heading for providing information about the person name parameter.

The person name parameter shall occur one time identifying either the usual name, a previous name, an alias name or a preferred name of the person being searched for.

A heading for providing information about the primary care identifier parameter.

The primary care identifier parameter may occur zero or one time, providing an identifier of the primary care provider of the person being searched for.

A heading for providing information about the searchParameter parameter.

The searchParameter parameter shall occur one time to indicate the type of search required, i.e. alphanumeric or algorithmic.

A heading for providing information about the historicDataIndicator parameter. The historicDataIndicator parameter shall occur one time to indicate whether or not historic data is required to be returned in the response to the query.  

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 code to indicate whether or not historic data is required to be returned in the response to the query.

The Coded with Code System datatype flavour is used to carry this information as follows:

• The code attribute will contain a value from the list of codes in the HistoricDataIndicator vocabulary;
• The codeSystem attribute will contain the OID referenced in the HistoricDataIndicator vocabulary.

A literal text string identifying the parameter item.

A heading for providing information about the person address parameter.

The person address parameter may occur zero or one time identifying either the usual address or a temporary address of the person being searched for.

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 address of the person that is being searched for.

An address is composed of the following components:

• Between one and five unstructured address lines;
• Postcode;
• A PAF (postal address file) key.

At least one of these components is required to be present.

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

• H - usual address;
• TMP - temporary address;

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

• Between one and five streetAddressLine elements are used to carry unstructured address lines, with the order in which they are carried in the message being significant, i.e. the first occurrence of the streetAddressLine element is used to carry the first line of address, the second occurrence of the streetAddressLine element is used to carry the second line of address etc;
• A postalCode element is used to carry a full or partial postcode;
• An addressKey element is used to carry a PAF key.

NB: The PDS will search all address types irrespective of the address type given in the use attribute.

A literal text string identifying the parameter item.

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.

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;

A literal text string identifying the parameter item. 

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

The person birth time parameter shall occur one time either providing a full or partial birth date of the person being searched for, or providing a birth date range of the person being searched for.

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 or birth date range of the person that is to be searched for.

One of the Date Only or Date Month or Date Year datatype flavours is used to carry this information as follows:

• Where a single date is to be given, the center sub-element shall be present with the date to be searched for, provided in either YYYYMMDD, YYYYMM or YYYY format in the value attribute;
• Where a date range is to be given, the low sub-element may be present with the earliest date to be searched for, provided in either YYYYMMDD, YYYYMM or YYYY format in the value attribute;
• Where a date range is to be given, the high sub-element may be present with the latest to be searched for, provided in either YYYYMMDD, YYYYMM or YYYY format in the value attribute.

Where a date range is to be given, at least one of the low sub-elements and high sub-elements shall be present.

A literal text string identifying the parameter item.

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

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

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 or death date range of the person that is to be searched for.

One of the Date Only or Date Month or Date Year datatype flavours is used to carry this information as follows:

• Where a single date is to be given, the center sub-element shall be present with the date to be searched for, provided in either YYYYMMDD, YYYYMM or YYYY format in the value attribute;
• Where a date range is to be given, the low sub-element may be present with the earliest date to be searched for, provided in either YYYYMMDD, YYYYMM or YYYY format in the value attribute;
• Where a date range is to be given, the high sub-element may be present with the latest to be searched for, provided in either YYYYMMDD, YYYYMM or YYYY format in the value attribute.

Where a date range is to be given, at least one of the low sub-elements and high sub-elements shall be present.

A literal text string identifying the parameter item. 

A heading for providing information about the person identifier parameter.

The person identifier parameter may occur zero or one time providing an identifier of the person being searched for.

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 identifier of the person that is to be searched for. This identifier will be one of:

• NHS number;
• Temporary NHS number issued by an NHAIS registration authority;
• Old format NHS number.

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

A NHS number is carried in the following way:

• The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.4.1";
• The extension attribute will contain the NHS number itself.

A Temporary NHS number issued by an NHAIS registration authority or an old format NHS number is carried in the following way:

• The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.3";
• The extension attribute will contain the Temporary NHS number issued by an NHAIS registration authority or the old NHS number itself.

A literal text string identifying the parameter item.

A heading for providing information about the person name parameter.

The person name parameter shall occur one time identifying either the usual name, a previous name, an alias name or a preferred name of the person being searched for.

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.

Note that a wildcard (*) can be added to the end of any name component search string.

Where the usual name is being carried, this is required to be indicated with a value of "L" in the use attribute.

Where an alias name is being carried, this is required to be indicated with a value of "A" in the use attribute.

Where a preferred name is being carried, this is required to be indicated with a value of "PREFERRED" in the use attribute.

Where a previous name is being carried, this is required to be indicated with one of the following values given in the use attribute:

• "PREVIOUS-BIRTH" is used to indicate a birth name;
• "PREVIOUS-MAIDEN" is used to indicate a maiden name;
• "PREVIOUS-BACHELOR" is used to indicate a bachelor name;
• "PREVIOUS" is used to indicate any other kind of previous name.

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

A literal text string identifying the parameter item.

A heading for providing information about the primary care identifier parameter.

The primary care identifier parameter may occur zero or one time, providing an identifier of the primary care provider of the person being searched for.

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

In this context, the value element provides the nationally recognised identifier for the primary care provider of the person that is to be searched for.

This identifier will be a national GP code or national GP Practice code.

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

A national GP code is carried in the following way:

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

A national GP Practice code is carried in the following way:

• The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.4.3";
• The extension attribute will contain the national GP Practice code itself.

 

A literal text string identifying the parameter item.

A heading for providing information about the searchParameter parameter. The searchParameter parameter shall occur one time to indicate the type of search required, i.e. alphanumeric or algorithmic.

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

In this context, the value element provides a code to indicate the type of search required, i.e. alphanumeric or algorithmic.

The Coded with Code System datatype flavour is used to carry this information as follows:

• The code attribute will contain a value from the list of codes in the SearchParameter vocabulary;
• The codeSystem attribute will contain the OID referenced in the SearchParameter vocabulary.

A literal text string identifying the parameter item.