BatchTraceQuery Tabular View

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

Used by:

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

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

A link to information about the person administrative gender code parameter.

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

NB This link must be present if a new-style NHS number is not present in Person.id.

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

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

NB This link is mandatory, and Person.id must contain a new-style NHS number, if either name or gender are not present.

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

A link to information about the person name parameter.

The person name parameter shall occur zero or one time identifying the name of the person being searched for.

NB This link must be present if a new-style NHS number is not present in Person.id.

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

A link to information about the primary care parameter.

The primary care parameter may occur zero or one time allowing a search for a patient to include either the GP or Practice code for the patient.

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

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.

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 - The UK format Postcode, 8 character string (e.g.: ZZ99 3VZ). AS PER BS7666. The 8 characters field allows a space to be inserted to differentiate between the inward and outward segments of the code, enabling full use to be made of Royal Mail postcode functionality.
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 postcode;
An addressKey element is used to carry a PAF key.

NB: The PDS will search all address types.

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 Interval of Points in Time (IVL) datatype flavours (Date Only or Date Month or Date Year) 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.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] [M] semanticsText (ST) { Fixed="Person.birthTime" }

A literal text string identifying the parameter item.

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

The value of the parameter item in this case contains the date of birth of the person that is to be searched for.

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

The value attribute will contain the date value in the format: YYYYMMDD

Person.administrativeGenderCode

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

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

Note: This must be present if there is no new-style NHS number in Person.id

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 zero or one time identifying the name of the person being searched for.

Note: This must be present if there is no new-style NHS number in Person.id

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 mandatory instance of the family element is used to carry the family name (or surname).
Between one 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.

NB: The PDS will ignore any prefix or suffix elements.

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.

Note This must be present and contain a new-style NHS number if either name or gender are not present.

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.

Therefore, all types of NHS number are supported but cross check trace will only be invoked where a new style NHS number is present.

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_RM000005UK02

Query		A heading for providing information about the query, in this case, a Batch Trace Request for a Service User record on the PDS.

	Used by:

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

[0..1] person.administrativeGenderCode (Person.administrativeGenderCode)		A link to information about the person administrative gender code parameter. The person administrative gender code parameter shall occur zero or one time identifying the administrative gender code of the person being searched for. NB This link must be present if a new-style NHS number is not present in Person.id.

[1..1] [M] person.birthTime (Person.birthTime)		A link to 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 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. NB This link is mandatory, and Person.id must contain a new-style NHS number, if either name or gender are not present.

[0..1] person.name (Person.name)		A link to information about the person name parameter. The person name parameter shall occur zero or one time identifying the name of the person being searched for. NB This link must be present if a new-style NHS number is not present in Person.id.

[0..1] primaryCare.id (PrimaryCare.id)		A link to information about the primary care parameter. The primary care parameter may occur zero or one time allowing a search for a patient to include either the GP or Practice code for the patient.

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

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.

	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 - The UK format Postcode, 8 character string (e.g.: ZZ99 3VZ). AS PER BS7666. The 8 characters field allows a space to be inserted to differentiate between the inward and outward segments of the code, enabling full use to be made of Royal Mail postcode functionality. 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 postcode; An addressKey element is used to carry a PAF key. NB: The PDS will search all address types.

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 Interval of Points in Time (IVL) datatype flavours (Date Only or Date Month or Date Year) 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.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] [M] semanticsText (ST) { Fixed="Person.birthTime" }		A literal text string identifying the parameter item.

[1..1] [M] value (TS)		The value of the parameter item in this case contains the date of birth of the person that is to be searched for. The Date Only datatype flavour is used to carry this information as follows: The value attribute will contain the date value in the format: YYYYMMDD

Person.administrativeGenderCode		A heading for providing information about the person administrative gender code parameter. The person administrative gender code parameter shall occur zero or one time identifying the administrative gender code of the person being searched for. Note: This must be present if there is no new-style NHS number in Person.id

	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 zero or one time identifying the name of the person being searched for. Note: This must be present if there is no new-style NHS number in Person.id

	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 mandatory instance of the family element is used to carry the family name (or surname). Between one 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. NB: The PDS will ignore any prefix or suffix elements.

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. Note This must be present and contain a new-style NHS number if either name or gender are not present.

	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. Therefore, all types of NHS number are supported but cross check trace will only be invoked where a new style NHS number is present. 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.

BatchTraceQuery - tabular view