SimpleTraceResponse - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
PRPA_RM000200UK01
PdsTraceMatch
Parent class linking to details returned in the simple trace query response. As well as confirming that the NHS number exists on the PDS, a number of data fields are also retrieved from the PDS.
Used by:
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }

Indicates that this is an observation.

  • Fixed value: "OBS" (Observation)
[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }

Indicates that this is an observation which has occurred.

  • Fixed value: "EVN" (Event)
[1..1] [M] subject

A heading for providing a link to the subject of the PDS Simple Trace Response, i.e. the patient.

[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }

Indicates that the patient's record is the subject.
[1..1] [M] patientRole (PatientRole)

A link to information within the patient record associated with the response to a simple trace to uniquely identify a patient.

PatientRole

Parent class linking to and containing information about a patient

Used by: PdsTraceMatch
[1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="PAT" }

Indicates that this is the patient role.
[0..*] addr (SET<AD>)

Address(es) of the patient.

Simple Trace will only return the patient's current (and where available any future) home address ("H").

The particular flavour of the address datatype used here is Address streetAddressLine Typed (format 2 in the datatypes description), plus:

  • Optional Postcode
  • Optional Address Key
  • Optional Description
  • Mandatory Use
  • Optional Useable period

This means that the address will contain the following components:

  • Between one and five streetAddressLine elements. Excludes postcode, may be vernacular or PAF-derived. For vernacular addresses, the following formatting convention should normally apply although there may be some exceptions:
o Line 1: premises ID
o Line 2: no. / thoroughfare
o Line 3: locality
o Line 4: post town
o Line 5: county
o Lines 1 or 2 and line 4 should normally be mandatory although there may be some exceptions
  • A postalCode element to carry a postcode (optional)
  • An addressKey element to carry a PAF key (optional)
  • The use attribute to denote the type of address. Only the value "H" (Home address) is permitted here (mandatory)
  • A useablePeriod element to contain the dates for which the address is current as a range, and/or it's future range, supplied in the low and high sub-elements. Both the low and high sub-elements are optional, allowing open-ended ranges to be specified. This mechanism only allows either current or future Home addresses to be carried in the message, and distinguishes between those addresses (optional)
[0..1] confidentialityCode (CV {CNE:InformationSensitivity } )

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

The current NHS number of the patient. This will be one of:

  • NHS Number
  • Old Format NHS Number
  • Temporary NHS Number (issued by an NHAIS registration authority)

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

If it is an NHS Number:

  • 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

If it is an Old Format or Temporary NHS Number:

  • 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 Old Format or Temporary NHS Number

[0..*] telecom (SET<TEL>)
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).
Note . Multiple instances of telecom will be returned representing multiple contact methods. Only current (and where available future) data is returned.

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 is optionally to be used to indicate dates from and to which the telecommunication number was/is to be effective. This mechanism only allows current and future telecommunication numbers of any of the types listed above to be carried in the message and distinguished from each other. 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.

[0..1] patientPerson (Person)
A heading for providing information about the person who is the identified patient.
[0..1] subjectOf2
A heading for indicating that the patient is the subject of the associated previous NHS contact information.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }

Indicates that the patient is the subject of the associated previous NHS contact information.

  • Fixed value: "SBJ" (Subject)

The typeCode is carried as an attribute of the subjectOf5 element.

[1..1] previousNhsContact (PreviousNhsContact)
A heading for providing information about whether the patient has had previous NHS contact.
[0..1] subjectOf3

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.

[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }

Indicates that the patient is the subject of the associated death notification.

  • Fixed value: "SBJ" (Subject)

The typeCode is carried as an attribute of the subjectOf element.

[1..1] deathNotification (DeathNotification)

A heading for providing information about a death notification.

Person

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

Used by: PatientRole
[1..1] [M] classCode (CS {CNE:EntityClass } ) { Fixed="PSN" }

Indicates that the entity is a person.

  • Fixed value: "PSN" (Person)

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

[1..1] [M] determinerCode (CS {CNE:EntityDeterminer } ) { Fixed="INSTANCE" }

Indicates that the entity is a single identifiable person.

  • Fixed value: "INSTANCE" (Specific)

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

[0..1] administrativeGenderCode (CS {CNE:Sex } )

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;
[0..1] birthTime (TS)

To provide the date 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.
[0..1] deceasedTime (TS)

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.
[0..1] multipleBirthOrderNumber (INT)
Describes the sequence in the case of multiple births (e.g. twins, triplets etc).

For births that are not a part of a multiple birth, this will be set to 1.

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".
[0..*] name (SET<PN>)

To provide zero or more structured names of the patient.

Note Only current (and where available any future) data is returned.

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;
  • Up to two instances of the given element are used to carry up to two given names (or forenames). If the patient has more than 2 given names, these will be concatenated in the 2nd given name attribute with a space between each name.
  • 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 these name types, 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.
[0..1] playedOtherProviderPatient (OtherProviderPatient)
A heading for providing details about the patient when associated with the other provider.

The otherProviderPatient grouping shall occur zero or one time, where only the current registered GP Practice is returned.
OtherProviderPatient

Parent class linking to information about the patient while in the care of other providers.

Used by: Person
[1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="PAT" }

Indicates that this is a Patient role.

[1..1] [M] subjectOf

A link to a PatientCareProvision that this role is the subject of.

[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }

Indicates that this is a Subject participation.

[1..1] [M] patientCareProvision (PatientCareProvision)

A link to details of patient care provision given by a health care provider.

PatientCareProvision

Parent class linking to and containing information about the patient's current GP practice.

Used by: OtherProviderPatient
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="PCPR" }

Indicates that this is a Patient Care Provision act.

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

Indicates that this is an Event.

[1..1] [M] code (CV {CNE:PatientCareProvisionType } ) { Fixed="1" }

Indicates the type of patient care provision.

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

  • The code attribute will only contain the value of "1" (representing Primary Care) from the list of codes in the PatientCareProvisionType vocabulary.
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.37".
[0..1] effectiveTime (IVL<TS>)

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

A link to the Performer of this PatientCareProvision.

[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="PRF" }

Indicates that this is a performer.

[1..1] [M] assignedOrganization (AssignedOrganization)
A link to details of the organisation which is the performer of the patient care provision.
AssignedOrganization

The organisation acting as health care provider, i.e. performing the patient care provision.

Used by: PatientCareProvision
[1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="ASSIGNED" }

Indicates that this is an Assigned role.

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

The identifier of the assigned organisation acting as health care provider. For a Simple Trace Response this will be:

  • GP Practice Code - where the PatientCareProvisionType is "1" (Primary Care)

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

For the GP Practice Code:

  • 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 GP Practice Code
PreviousNhsContact

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

Used by: PatientRole
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }

Indicates that this is an observation.

  • Fixed value: "OBS" (Observation)

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

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

Indicates that this is an observation which has occurred.

  • Fixed value: "EVN" (Event)

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

[1..1] [M] code (CV {CNE:DemographicObservationType } ) { Fixed="17" }

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.
[1..1] [M] value (CV {CNE:PreviousNhsContact } )

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

The Death Notification status of the patient.

Used by: PatientRole
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }

Indicates that this is an Observation act.

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

Indicates that this is an Event.

[1..1] [M] code (CV {CNE:DemographicObservationType } ) { Fixed="3" }

Indicates the type of observation. In this case, the observation is that of the death notification status of the patient.

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

  • The code attribute will contain the value "3" (Death notification) from the list of codes in the DemographicObservationType vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.35"
[1..1] [M] value (CV {CNE:DeathNotification } )

The value of the death notification status.

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 "2.16.840.1.113883.2.1.3.2.4.16.5"