PdsTraceMatch - tabular view

A heading for providing information about a successful trace of a Service User record on the PDS.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

A heading for providing a link to the subject of the PDS Trace match, i.e. the patient details found as a result of the Trace or Advanced Trace Query this message is a response to.

Where this message is a response to a Trace Query, there shall be a single repetition of the subject.

Where this message is a response to an Advanced Trace Query, there shall be either a single repetition of the subject or multiple repetitions.

A heading for providing details about the patient.

Indicates that the role is that of a patient.

• Fixed value: "PAT" (Patient)

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

To provide the current nationally recognised identifier for the patient. 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.

To provide zero or more addresses of the patient.

An address is composed of the following components:

• Between one and five unstructured address lines;
• Postcode;
• A PAF (postal address file) key;
• An effective from date may be provided for every address; an effective to date may also be provided for any address.

The first of these components is required to be present with any address.

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:

• 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 postcode;
• An addressKey element is used to carry a PAF key;
• For a temporary address only, a desc element is used to carry a textual description of nature of the address.

For any address, the useablePeriod sub-element may be used to indicate dates from and to which the address was/is to be effective. This mechanism allows previous addresses to be carried in the message and distinguished from the current address. These effective dates are indicated, in the following way:

• The low sub-element of the useablePeriod element may optionally be present with the date from which the address was effective provided in YYYYMMDD format in the value attribute;
• The high sub-element of the useablePeriod element may optionally be present with the date to which the address was/is to be effective provided in YYYYMMDD format in the value attribute.

To provide zero or more telecommunication numbers of the patient, together with the contact method for each. These two items of information are carried in the value attribute, separated by a colon character. The contact method will be one of the following values:

• tel (for telephone numbers);
• fax (for fax numbers);
• mailto (for e-mail addresses);
• textphone (for minicom or textphone numbers).

In addition, for each telecommunication number, one occurrence of the use attribute is required to indicate the context for the telecommunication number, using the following values:

• H - A communication address at a home;
• HP - The primary home, to reach a person after business hours;
• HV - A vacation home, to reach a person while on vacation;
• WP - An office address;
• AS - An automated answering machine;
• EC - A contact specifically designated to be used for emergencies;
• PG - A paging device suitable to solicit a callback or to leave a very short message;
• MC - A telecommunication device that moves and stays with its owner.

For any telecommunication number, the useablePeriod sub-element may also be used to indicate dates from and to which the telecommunication number was/is to be effective. This mechanism allows previous telecommunication numbers of any of the types listed above to be carried in the message and distinguished from current telecommunication numbers. These effective dates are indicated, in the following way:

• The low sub-element of the useablePeriod element is required to be present with the date from which the telecommunication number was effective provided in YYYYMMDD format in the value attribute;
• The high sub-element of the useablePeriod element may optionally be present with the date to which the telecommunication number was/is to be effective provided in YYYYMMDD format in the value attribute.

To indicate the nature of any sensitive information about the patient in coded form.

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 InformationSensitivity vocabulary;
• The codeSystem attribute will contain the OID referenced in the InformationSensitivity vocabulary.

A heading for providing information about the person who is the identified patient.

A heading for indicating that the patient details are the subject of the associated Matching level information.

The subjectOf1 participation and the associated Matching Level information shall be present where this message is a response to an Algorithmic Advanced Trace Query.

The subjectOf1 participation and the associated Matching Level information shall not be present where this message is a response to an Alphanumeric Advanced Trace Query or Simple Trace Query.

A heading for indicating that the patient is the subject of the associated previous NHS contact information.

A heading for indicating that the patient is the subject of the associated death notification.

This shall be present where the patient's death date/time is given in the person.deceasedTime field.

This shall not be present where the person.deceasedTime field is not present.

A heading for providing information about the person who is the identified patient.

Indicates that the entity is a person.

• Fixed value: "PSN" (Person)

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

Indicates that the entity is a single identifiable person.

• Fixed value: "INSTANCE" (Specific)

The determinerCode is carried as an attribute of the patientPerson element.

To provide zero or more structured names of the patient.

Zero or one occurrence of the usual name may be provided.

Zero or more occurrences of alias names may also be provided.

Zero or one occurrence of a preferred name may also be provided.

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.

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.

For the usual name type, the validTime sub-element may be used to indicate dates from and to which the name was/is to be effective, in the following way:

• The low sub-element of the validTime element may optionally be present with the date from which the name was effective provided in YYYYMMDD format in the value attribute;
• The high sub-element of the validTime element may optionally be present with the date to which the name was/is to be effective provided in YYYYMMDD format in the value attribute.

To provide the current registered sex of the patient in coded form.

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;

To provide the date, and where relevant, time when the patient was born.

The date/time may be given in one of the following formats:

• YYYYMMDDHHMM where the full date and time of birth is known;
• YYYYMMDD where the full date of birth is known;
• YYYYMM or YYYY where the full date of birth is not known.

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

• The value attribute will contain the date value in one of the formats indicated.

To provide the date (and time where available) the patient died, where relevant.

The date/time may be given in one of the following formats:

• YYYYMMDDHHMM where the full date and time of death is known;
• YYYYMMDD where the full date of death is known;
• YYYYMM or YYYY where the full date of death is not known.

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

• The value attribute will contain the date value in one of the formats indicated.

To provide the birth order, where relevant (i.e. in the case of multiple births), as an integer.

Note that permissible values are 1-9, with any value between 1 and 7 inclusive indicating the actual birth order number, 8 meaning "Not applicable" and 9 meaning "Not known".

A heading for providing details about the patient when associated with other providers.

The otherProviderPatient grouping shall occur zero or more times, once for each registered GP/GP Practice to be returned.

A heading for providing details about the patient when associated with other providers.

In this context, this will be the current registered GP/GP Practice, and, if this is a response to an advanced trace query and historic data was requested, previous GP/GP Practice registrations as indicated by the effectiveTime field.  

Indicates that the role is that of a patient.

• Fixed value: "PAT" (Patient)

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

A heading for indicating that the patient is the subject of the associated patient care provision.

A heading for providing information about the matching level.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

To provide the type of observation in coded form.

In this context, the type of observation is an observation of the matching level.

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

• The code attribute will contain value "12" (Matching level) from the list of codes in the DemographicObservationType vocabulary;
• The codeSystem attribute will contain the OID referenced in the DemographicObservationType vocabulary.

To provide a value for the Matching Level, i.e. the level of confidence in the match expressed as a percentage.

The Physical Quantity datatype is used to carry this information as follows:

• The value attribute will contain the numeric Matching Level;
• The unit attribute will contain the unit that the Matching Level in measured in, i.e. %;

A heading for providing information about whether the patient has had previous NHS contact.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

To provide the type of observation in coded form.

In this context, the type of observation is an observation of previous NHS contact information.

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

• The code attribute will contain value "17" (Previous NHS contact) from the list of codes in the DemographicObservationType vocabulary;
• The codeSystem attribute will contain the OID referenced in the DemographicObservationType vocabulary.

To provide the previous NHS contact information in coded form.

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 PreviousNhsContact vocabulary;
• The codeSystem attribute will contain the OID referenced in the PreviousNhsContact vocabulary.

A heading for providing information about a death notification.  

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

To provide the type of observation in coded form.

In this context, the type of observation is an observation of a death notification.

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

• The code attribute will contain value "3" (Death notification) from the list of codes in the DemographicObservationType vocabulary;
• The codeSystem attribute will contain the OID referenced in the DemographicObservationType vocabulary.

To provide the registration status of the death notification in coded form.

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 DeathNotification vocabulary;
• The codeSystem attribute will contain the OID referenced in the DeathNotification vocabulary.

A heading for defining a relationship between a patient and his/her primary care provider (registered GP / GP Practice).

Indicates that this is a patient care provision.

• Fixed value: "PCPR" (Patient Care Provision)

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

Indicates that this is a defined patient care provision which has occurred.

• Fixed value: "EVN" (Event)

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

To provide the type of defined patient care provision (i.e. registered GP / GP Practice), in coded form.

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

• The code attribute will contain the value from the list of codes in the PatientCareProvisionType vocabulary relating to Primary care, i.e. "1".
• The codeSystem attribute will contain the OID referenced in the PatientCareProvisionType vocabulary.

To provide a date interval during which the patient care provision was effective.

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

• The low sub-element may be present with the date from which the patient care provision was effective, provided in YYYYMMDD format in the value attribute;
• The high sub-element may optionally be present with the date to which the the patient care provision was effective provided in YYYYMMDD format in the value attribute.

A heading for providing a link to the party responsible for the patient care provision.

A heading for providing details about a provider responsible for the patient care provision. In this context, this will be the GP / GP Practice the patient is registered with.

Indicates that the role is that of a provider.

• Fixed value: "PROV" (Healthcare provider)

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

To provide the nationally recognised identifier for the provider.

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.