PdsAdvancedTraceQuery Tabular View

PdsAdvancedTraceQuery - tabular view

No Current Link To Vocabulary

Coded With Extensions

Coded No Extensions

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

Used by:

[1..1] [M] historicDataIndicator (HistoricDataIndicator)

A link to 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.

[0..1] ignoreHistoryIndicator (IgnoreHistoryIndicator)

A link to information about the ignore history indicator parameter.

The ignore history indicator parameter may occur zero to one time to indicate whether or not to also search historic data (i.e. as well as current data).

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

A link to information about the person address parameter.

The person address parameter may occur zero or one time identifying the address of the person being searched for. The address details will be compared to all addresses (usual, correspondence and temporary).

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

A link to 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.

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

A link to information about the person birth time parameter.

The person birth time parameter may occur zero or one time 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.

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

A link to 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.

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

A link to 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.

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

A link to information about the person name parameter.

The person name parameter shall occur one time identifying a name of the person being searched for. The name details will be compared to all name types (i.e. usual, previous, preferred, alias).

[0..1] primaryCare.id (PrimaryCare.id)

A link to information about the primary care identifier parameter.

This parameter may occur zero or one time identifying the type of care provider and it's care provider code (e.g GP Code, GP Practice Code etc...) being searched for.

[1..1] [M] searchParameter (SearchParameter)

A link to information about the searchParameter parameter.

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

PrimaryCare.id

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.

Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="PrimaryCare.id" }

A literal text string identifying the PrimaryCare parameter item.

[1..1] [M] value (II)

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.

Note:

PDS does not perform transformation and searches only against the data held. If the ignore history indicator is set to 1, there is no need to supply a national GP code as all current data will be Practice codes and code transformation is not performed by PDS.

Person.birthTime

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

The person birth time parameter may occur zero or one time 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.

NOTE: Searching for the person's birth time is mandatory for alphanumeric searches and optional for other types of search.

Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="Person.birthTime" }

A literal text string identifying the parameter item.

[1..1] [M] value (IVL<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 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.

IgnoreHistoryIndicator

A heading for providing information about the IgnoreHistoryIndicator parameter. This indicates whether or not to search historic data (i.e. as well as current data), and is only relevant (and is mandatory) to alphanumeric traces.

Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="IgnoreHistoryType" }

A literal text string identifying the parameter item.

[1..1] [M] value (CV {CNE:IgnoreHistoryType } )

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 to search historic data (i.e. as well as current data)

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 IgnoreHistoryType vocabulary:

1 - Ignore History
0 - Search History

The codeSystem attribute will contain the OID, "2.16.840.1.113883.2.1.3.2.4.17.169" referenced in the IgnoreHistoryType vocabulary.

Person.address

A heading for providing information about the person address parameter.

Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="Person.address" }

A literal text string identifying the parameter item.

[1..1] [M] 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 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 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.

Note:

The PDS will search all address types.
The use of wildcards only applies to Alphanumeric Traces. A wildcard (*) can be added to the end of any streetAddressLine and postalCode component, following at least 2 characters.

Person.deceasedTime

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

Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="Person.deceasedTime" }

A literal text string identifying the parameter item.

[1..1] [M] value (IVL<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 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.

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] [M] semanticsText (ST) { Fixed="Person.administrativeGenderCode" }

A literal text string identifying the parameter item.

[1..1] [M] value (CS {CNE: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.

Person.name

A heading for providing information about the person name parameter.

The person name parameter shall occur one time identifying a name of the person being searched for. The name details will be compared to all name types (i.e. usual, previous, preferred, alias).

Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="Person.name" }

A literal text string identifying the parameter item.

[1..1] [M] value (PN)

The value of the parameter item in this case is a structured name, containing the following components:

A single instance of the family element is used to carry the family name (or surname). This is mandatory in an alphanumeric trace.
Between zero and two 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, and the second occurrence of the given element is used to carry the second given name.

Note:

The PDS will ignore any prefix or suffix elements.
For an algorithmic trace it is possible to supply a given name either instead of or in addition to a family name.
A wildcard (*) can be added to the end of any name component search string, following at least 2 characters. This wildcard (*) is for alpha trace only.

HistoricDataIndicator

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.

Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="HistoricDataIndicator" }

A literal text string identifying the parameter item.

[1..1] [M] value (CV {CNE:HistoricDataIndicator } )

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 "2.16.840.1.113883.2.1.3.2.4.17.36" referenced in the HistoricDataIndicator vocabulary.

SearchParameter

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.

Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="SearchParameter" }

A literal text string identifying the parameter item.

[1..1] [M] value (CV {CNE:SearchParameter } )

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, "2.16.840.1.113883.2.1.3.2.4.17.39" referenced in the SearchParameter vocabulary.

Person.id

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.

Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="Person.id" }

A literal text string identifying the parameter item.

[1..1] [M] value (II)

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.


QUPA_RM000002UK02

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

	Used by:

[1..1] [M] historicDataIndicator (HistoricDataIndicator)		A link to 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.

[0..1] ignoreHistoryIndicator (IgnoreHistoryIndicator)		A link to information about the ignore history indicator parameter. The ignore history indicator parameter may occur zero to one time to indicate whether or not to also search historic data (i.e. as well as current data).

[0..1] person.address (Person.address)		A link to information about the person address parameter. The person address parameter may occur zero or one time identifying the address of the person being searched for. The address details will be compared to all addresses (usual, correspondence and temporary).

[1..1] [M] person.administrativeGenderCode (Person.administrativeGenderCode)		A link to 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.

[0..1] person.birthTime (Person.birthTime)		A link to information about the person birth time parameter. The person birth time parameter may occur zero or one time 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.

[0..1] person.deceasedTime (Person.deceasedTime)		A link to 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.

[0..1] person.id (Person.id)		A link to 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.

[1..1] [M] person.name (Person.name)		A link to information about the person name parameter. The person name parameter shall occur one time identifying a name of the person being searched for. The name details will be compared to all name types (i.e. usual, previous, preferred, alias).

[0..1] primaryCare.id (PrimaryCare.id)		A link to information about the primary care identifier parameter. This parameter may occur zero or one time identifying the type of care provider and it's care provider code (e.g GP Code, GP Practice Code etc...) being searched for.

[1..1] [M] searchParameter (SearchParameter)		A link to information about the searchParameter parameter. The searchParameter parameter shall occur one time to indicate the type of search required, i.e. alphanumeric or algorithmic.

PrimaryCare.id		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.

	Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="PrimaryCare.id" }		A literal text string identifying the PrimaryCare parameter item.

[1..1] [M] value (II)		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. Note: PDS does not perform transformation and searches only against the data held. If the ignore history indicator is set to 1, there is no need to supply a national GP code as all current data will be Practice codes and code transformation is not performed by PDS.

Person.birthTime		A heading for providing information about the person birth time parameter. The person birth time parameter may occur zero or one time 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. NOTE: Searching for the person's birth time is mandatory for alphanumeric searches and optional for other types of search.

	Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="Person.birthTime" }		A literal text string identifying the parameter item.

[1..1] [M] value (IVL<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 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.

IgnoreHistoryIndicator		A heading for providing information about the IgnoreHistoryIndicator parameter. This indicates whether or not to search historic data (i.e. as well as current data), and is only relevant (and is mandatory) to alphanumeric traces.

	Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="IgnoreHistoryType" }		A literal text string identifying the parameter item.

[1..1] [M] value (CV {CNE:IgnoreHistoryType } )		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 to search historic data (i.e. as well as current data) 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 IgnoreHistoryType vocabulary: 1 - Ignore History 0 - Search History The codeSystem attribute will contain the OID, "2.16.840.1.113883.2.1.3.2.4.17.169" referenced in the IgnoreHistoryType vocabulary.

Person.address		A heading for providing information about the person address parameter. The person address parameter may occur zero or one time identifying the address of the person being searched for. The address details will be compared to all addresses (usual, correspondence and temporary).

	Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="Person.address" }		A literal text string identifying the parameter item.

[1..1] [M] 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 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 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. Note: The PDS will search all address types. The use of wildcards only applies to Alphanumeric Traces. A wildcard () can be added to the end of any streetAddressLine* and postalCode component, following at least 2 characters.

Person.deceasedTime		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.

	Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="Person.deceasedTime" }		A literal text string identifying the parameter item.

[1..1] [M] value (IVL<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 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.

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] [M] semanticsText (ST) { Fixed="Person.administrativeGenderCode" }		A literal text string identifying the parameter item.

[1..1] [M] value (CS {CNE: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.

Person.name		A heading for providing information about the person name parameter. The person name parameter shall occur one time identifying a name of the person being searched for. The name details will be compared to all name types (i.e. usual, previous, preferred, alias).

	Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="Person.name" }		A literal text string identifying the parameter item.

[1..1] [M] value (PN)		The value of the parameter item in this case is a structured name, containing the following components: A single instance of the family element is used to carry the family name (or surname). This is mandatory in an alphanumeric trace. Between zero and two 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, and the second occurrence of the given element is used to carry the second given name. Note: The PDS will ignore any prefix or suffix elements. For an algorithmic trace it is possible to supply a given name either instead of or in addition to a family name. A wildcard () can be added to the end of any name component search string, following at least 2 characters. This wildcard () is for alpha trace only.

HistoricDataIndicator		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.

	Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="HistoricDataIndicator" }		A literal text string identifying the parameter item.

[1..1] [M] value (CV {CNE:HistoricDataIndicator } )		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 "2.16.840.1.113883.2.1.3.2.4.17.36" referenced in the HistoricDataIndicator vocabulary.

SearchParameter		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.

	Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="SearchParameter" }		A literal text string identifying the parameter item.

[1..1] [M] value (CV {CNE:SearchParameter } )		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, "2.16.840.1.113883.2.1.3.2.4.17.39" referenced in the SearchParameter vocabulary.

Person.id		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.

	Used by: Query

[1..1] [M] semanticsText (ST) { Fixed="Person.id" }		A literal text string identifying the parameter item.

[1..1] [M] value (II)		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.