CrossCheckTraceResponse - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
PRPA_RM000213UK02
PDSResponse

Parent class linking to details returned in the Cross Check Trace query response.

This provides the facility to determine whether demographic data supplied for an NHS Number matches that held for the same NHS Number on the Spine, and to therefore provide an indication of quality of data held for a patient record by the requesting system. A summary set of demographic information (current and future dated), including the NHS number, is returned if a single exact match is found, otherwise a suitable status is returned.

Used by:
[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] subject
A link to the Subject of this Observation Event.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }
A link to an Observation that this role is the subject of.
[1..1] [M] patientRole (PatientRole)

A link to information within the patient record associated with the NHS Number that is being confirmed.

PatientRole
Parent class linking to and containing information about a patient.
Used by: PDSResponse
[1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="PAT" }
Indicates that this is a Patient role.
[0..*] addr (SET<AD>)

Address(es) of the patient.

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
    • Line 2: no. / thoroughfare
    • Line 3: locality
    • Line 4: post town
    • Line 5: county
    • 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.

Only values "B", "S" and "Y" are returned by this Trace, where:

  • B - Business Integration
  • S - Sensitive
  • Y - Sensitive (P1R1 Legacy Value)
[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>)

Telecommunication address(es) of the patient.


The particular flavour of the telecommunication address datatype used here is Telecommunication address plus use.

This means that the telecommunication address will contain the following components:

  • The value attribute to carry the telecommunication number or address, expressed as a URL (mandatory)
  • The use attribute to denote the type of telecommunication address (mandatory)
  • A useablePeriod element to contain the dates for which the telecommunication address is / was current as a 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 (optional)
[0..1] patientPerson (Person)
A link to details of the person playing the role of patient.
[0..1] subjectOf2

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" }
A link to an Observation that this role is the subject of.
[1..1] deathNotification (DeathNotification)

A link for providing information about a death notification.

[0..1] subjectOf8
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" }
A link to an Observation that this role is the subject of.
[1..1] previousNhsContact (PreviousNhsContact)
A link for providing information about whether the patient has had previous NHS contact.
Person
Parent class linking to and containing information about a patient which is specific to the person.
Used by: PatientRole
[1..1] [M] classCode (CS {CNE:EntityClass } ) { Fixed="PSN" }
Indicates that this is a Person entity.
[1..1] [M] determinerCode (CS {CNE:EntityDeterminer } ) { Fixed="INSTANCE" }
Indicates that this is an Instance of a person.
[0..1] administrativeGenderCode (CS {CNE:Sex } )

The administrative gender of the person.

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 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] 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>)

Name(s) of the person.

The particular flavour of the person name datatype used here is Person name structured with use (number 6 in the datatypes description). This means that the name will contain the following components:

  • A family element to carry the surname or family name of the person (optional)
  • Up to 2 given elements to carry the given names of the person. If the person has more than 2 given names, these will be concatenated in the second given name attribute with a space between each name. The order of the elements is also significant, so the first occurrence of the given element will carry the first given name, and the second occurrence will carry the second, third, etc. given names (optional)
  • A prefix element to carry a prefix for the name, such as Mr, Mrs, etc. (optional)
  • A suffix element to carry a suffix for the name, such as Jnr, Snr, etc. (optional)

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 link providing details about the patient's current GP Practice.

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 heading for indicating that the patient is the subject of the associated patient care provision.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }
A link to an Observation that this role is the subject of.
[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 a 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 contain only contain a value of "1" 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>)

The effective dates for the care provision relationship represented as a 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.

The effective from date (the low sub-element) must not be in the future.

[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 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 a 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 act.
[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }
Indicates that this is an Event
[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 "2.16.840.1.113883.2.1.3.2.4.17.35".
[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 "2.16.840.1.113883.2.1.3.2.4.17.38"
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"