PdsNhsNumberConfirmation - tabular view

A heading for providing information about a positive confirmation of a patient's NHS number.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

A heading for providing a link to the subject of the PDS NHS number confirmation, i.e. the patient.  

A heading for providing a link to information pertinent to the successful NHS number confirmation.

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;
• In the case of a temporary address, a textual description of nature of the address may also be provided;
• 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 one of the following codes in the use attribute:

• H - usual address;
• TMP - temporary 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 of any of the two types listed above to be carried in the message and distinguished from current addresses. 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 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 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 indicating that the patient is the subject of the associated consent.

A heading for providing the Serial Change Number for 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 pertinentSerialChangeNumber element.

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

To provide the type of observation in coded form.

In this context, the type of observation is an observation of a Serial Change Number.

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

• The code attribute will contain value "2" (Serial Change Number) 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 Serial Change Number of the Service User record on the PDS.

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

• The value attribute will contain the Serial Change Number.

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 the patient was born.

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

• 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 Only or 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.

A heading for providing details about the patient when associated with other providers, such as registered GP/GP Practice or pharmacies nominated by the patient.

A heading for providing details about the patient when associated with other providers, such as registered GP/GP Practice or pharmacies nominated by the patient.

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 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 providing information about patient consent.

Two types of consent information can be provided here:

• Consent to NHS Care Record sharing;
• Call centre call-back consent.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

To provide the type of observation in coded form.

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

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

• The code attribute will contain one of the following values from the list of codes in the DemographicObservationType vocabulary:
• "4" (Consent to NHS Care Record sharing);
• "6" (Call centre call-back consent).
• The codeSystem attribute will contain the OID referenced in the DemographicObservationType vocabulary.

To provide the significant date related to the consent, i.e. the date it was last changed.

Where the type of consent is "Consent to NHS Care Record sharing", the date it was last changed shall be given, in YYYYMMDD format.

Where the type of consent is "Call centre call-back consent", the date it was last changed shall not be given.

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

• The value attribute will contain the date value in the format indicated above

To provide a coded consent value related to the type of consent.

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

A heading for providing a link to information pertinent to the consent.

Optionally present where the type of consent is "Consent to NHS Care Record sharing".

Shall not be used where the type of consent is "Call centre call-back consent".

A heading for defining a relationship between a patient and his/her primary care provider (registered GP / GP Practice) or for a specific healthcare facility such as a type of pharmacy.

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, such as primary care provider (registered GP / GP Practice) or a type of pharmacy, 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 PatientCareProvisionType vocabulary;
• 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.

This is optionally present where the patient care provision type is "Primary care".

This shall not be present where the patient care provision type is not "Primary care".

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 supplementary textual comments arising from any review by a patient with a clinician on changing consent.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

To provide the type of observation in coded form.

In this context, the type of observation is an observation of supplementary textual comments pertinent to the consent status.

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

• The code attribute will contain value "7" (Consent supplementary comments) from the list of codes in the DemographicObservationType vocabulary;
• The codeSystem attribute will contain the OID referenced in the DemographicObservationType vocabulary.

To provide the supplementary comments as a text string.

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

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.

Where the type of patient care provision is primary care, this identifier will be a national GP code or national GP Practice code.

Where the type of patient care provision is type of pharmacy, this identifier will be a national pharmacy identifier.

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.

A national Pharmacy 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 Pharmacy code itself.