PdsGeneralUpdateRequest - tabular view

A heading for providing information about a request to update information about a patient registered on the PDS.

Indicates that this is a registration.

• Fixed value: "REG" (Registration)

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

Indicates that this is a registration which is being requested.

• Fixed value: "RQO" (Request or Order)

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

To provide the type of update 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 UpdateType vocabulary;
• The codeSystem attribute will contain the OID referenced in the UpdateType vocabulary.

A heading for providing a link to the subject of the PDS update request, i.e. the patient.

A heading for providing a link to details of the registering authority for a death notification.

This shall be present where a date of death is given in the Person.deceasedTime field and is not being removed. Otherwise not used.

I.e. where the updateMode attribute of the deceasedTime element has value "added" or "altered", author / registering authority information shall be present; where the updateMode attribute of the deceasedTime element has value "removed" or the deceasedTime element is not present, author / registering authority information shall not be present.

A heading for providing a link to information pertinent to the registration request.

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.

The type of update being applied to an address shall be indicated as follows:

• Where an address is being removed, the updateMode attribute shall contain value "removed"; the id element shall contain the PDS allocated object identifier associated with that address. None of the address component or useablePeriod sub-elements shall be present.
• Where an address is being altered, the updateMode attribute shall contain value "altered"; the id element shall contain the PDS allocated object identifier associated with that address. NB: the "altered" update mode only applies to components of the address and not the type of address as given in the use attribute, i.e. where an existing address is being altered, the use attribute shall contain the same value already associated with that address and PDS object identifier. If the type of an existing address was being altered, the existing address with the existing use and existing PDS object identifier would need to be "removed", and a new address would need to be "added" containing the existing address components and the new use value.
• Where an address is being added, the updateMode attribute shall contain value "added"; the id element shall not be present (an identfier to be associated with that address will be allocated by the PDS).

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 added or altered address.

With any updated 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;
• PST - correspondence address.

NB: as stated above, where an existing address is being altered, the use attribute shall contain the same value already associated with that address and PDS object identifier.

The following sub-elements are used to carry the components of a added or altered 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. NB: addresses updating the PDS shall conform to the NHAIS address format, where specific streetAddressLine elements contain specific address information, as follows:
• The first streetAddressLine element shall contain Premises ID (House Name) (or be present and have no value or a null flavor if there is no Premises ID);
• The second streetAddressLine element shall contain House Number and / or Thoroughfare (or be present and have no value or a null flavor if there is neither of these); at least one of the first streetAddressLine element and second streetAddressLine element shall have a non-null value;
• The third streetAddressLine element shall contain Locality (or be present and have no value or a null flavor if there is no locality);
• The fourth streetAddressLine element shall contain Post Town (this shall be a non-null value);
• The fifth streetAddressLine element shall contain County (or have no value or a null flavor or be absent if there is no county).
• 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 added or altered 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 three 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 be present (is required to be present where the update type is "New data") with the date from which the address was/is to be 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.

The type of update being applied to the telecommunication numbers shall be indicated as follows:

• Where a telecommunication number is being removed, the updateMode attribute shall contain value "removed"; the id element shall contain the PDS allocated object identifier associated with that telecommunication number. The value attribute shall not be present.
• Where a telecommunication number is being altered, the updateMode attribute shall contain value "altered"; the id element shall contain the PDS allocated object identifier associated with that telecommunication number. The new telecommunication number together with the contact method are carried in the value attribute, separated by a colon character. NB: the "altered" update mode only applies to components of the telecommunication number and not the context of the telecommunication number as given in the use attribute, i.e. where an existing telecommunication number is being altered, the use attribute shall contain the same value already associated with that telecommunication number and PDS object identifier. If the context of an existing telecommunication number was being altered, the existing telecommunication number with the existing use and existing PDS object identifier would need to be "removed", and a new telecommunication number would need to be "added" containing the existing telecommunication components and the new use value.
• Where a telecommunication number is being added, the updateMode attribute shall contain value "added"; the id element shall not be present (an identifier to be associated with that telecommunication number will be allocated by the PDS). The new telecommunication number together with the contact method are carried in the value attribute, separated by a colon character.

For an added or altered telecommunication number, 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 being updated, 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.

NB: as stated above, where an existing telecommunication number is being altered, the use attribute shall contain the same value already associated with that telecommunication number and PDS object identifier.

For any telecommunication number being added or altered, a single occurrence of the useablePeriod sub-element may also be used to indicate the 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. An effective date is indicated in the following way:

• The low sub-element of the useablePeriod element may be present (is required to be present where the update type is "New data") with the date from which the telecommunication number was/is to be 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.

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 NHAIS registration information.

A heading for indicating that the patient is the subject of the associated preferred contact method.

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

One repeat is optional to provide information about "Consent to NHS Care Record Sharing".

One repeat is optional to provide information about "Call centre call-back consent".

A heading for indicating that the patient is the subject of the associated preferred written communication format information.

A heading for indicating that the patient is the subject of the associated Shared secret.

A heading for indicating that the patient is the subject of the associated Healthspace registration.

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

This shall be present where Person.deceasedTime is present (i.e. this shall be present when a date of death is being added, altered or removed); otherwise not used.

A heading for providing details of the registering authority for a death notification.

Indicates that the role is that of an assigning authority.

• Fixed value: "ASSIGNED" (Assigned entity)

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

To indicate the type of registering authority 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 RegisteringAuthorityType vocabulary;
• The codeSystem attribute will contain the OID referenced in the RegisteringAuthorityType vocabulary.

A heading for providing information about a person who is authoring a PDS registration.

This information shall be present where the registering authority is NHAIS.

This information shall not be present where the registering authority is not NHAIS.

A heading for providing information about the organization responsible for authoring a PDS registration.

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 previous names may also 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 type of update being applied to a name shall be indicated as follows:

• Where a name is being removed, the updateMode attribute shall contain value "removed"; the id element shall contain the PDS allocated object identifier associated with that name. None of the name component or useablePeriod sub-elements shall be present.
• Where a name is being altered, the updateMode attribute shall contain value "altered"; the id element shall contain the PDS allocated object identifier associated with that name. NB: the "altered" update mode only applies to components of the name and not the type of name as given in the use attribute, i.e. where an existing name is being altered, the use attribute shall contain the same value already associated with that name and PDS object identifier. If the type of an existing name was being altered, the existing name with the existing use and existing PDS object identifier would need to be "removed", and a new name would need to be "added" containing the existing name components and the new use value.
• Where a name is being added, the updateMode attribute shall contain value "added"; the id element shall not be present (an identifier to be associated with that name will be allocated by the PDS).

The following sub-elements are used to carry components of an added or altered 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 updated, this is required to be indicated with a value of "L" in the use attribute.

Where an alias name is being updated, this is required to be indicated with a value of "A" in the use attribute.

Where a preferred name is being updated, this is required to be indicated with a value of "PREFERRED" in the use attribute.

Where a previous name is being updated, this is required to be indicated with one of the following values given in the use attribute:

• "PREVIOUS-BIRTH" is used to indicate a birth name;
• "PREVIOUS-MAIDEN" is used to indicate a maiden name;
• "PREVIOUS-BACHELOR" is used to indicate a bachelor name;
• "PREVIOUS" is used to indicate any other kind of previous name.

NB: as stated above, where an existing name is being altered, the use attribute shall contain the same value already associated with that name and PDS object identifier.

Where a usual or previous name is being added or altered, 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:

• Where information about the current registered sex of the patient is being added or altered, the code attribute will contain a value from the list of codes in the Sex vocabulary; the updateMode attribute shall contain value "added" or "altered" as appropriate.
• Note that information about the sex of the patient cannot be removed.

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

The type of update being applied to the birth date shall be indicated as follows:

• The updateMode attribute shall contain value "added" or "altered" as appropriate.

NB: The date of birth cannot be removed from the PDS datatbase, therefore the updateMode attribute shall not contain value "removed".

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

• YYYYMMDDHHMM;
• YYYYMMDD.

One of the Date and Time or Date Only 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.

Where a death date is being provided, 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.

Where a death date is being added or altered, the value attribute shall contain the date value in one of the formats indicated, using one of the Date and Time, Date Only, Date Month or Date Year datatype flavours; the updateMode attribute shall contain value "added" or "altered" as appropriate.

Where a death date is being removed because erroneously present death information is to be deleted from the current data on PDS, the value attribute shall not be present; the updateMode attribute shall contain value "removed".

NB: the updateMode attribute of the deathNotification element shall contain the same value as the updateMode attribute of the deceasedTime element.

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

The type of update being applied to the birth order shall be indicated as follows:

• Where the birth order is being removed, the updateMode attribute shall contain value "removed". The value attribute shall not be present.
• Where the birth order is being added or altered, the updateMode attribute shall contain value "added" or "altered" as appropriate; the value attribute shall contain the new birth order value.

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 of people related to the patient, such as: guardians, proxies and family or close friends as contacts.

A heading for providing information about the language preferred by the person where it is not English.

A heading for providing information about a person who is representing the registering authority for a death notification.

This information shall be present where the registering authority is NHAIS.

This information shall not be present where the registering authority is not NHAIS.

Indicates that the entity is a person.

• Fixed value: "PSN" (Person)

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

Indicates that the entity is a single identifiable person.

• Fixed value: "INSTANCE" (Specific)

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

To provide the user ID of registering person within the NHAIS system.

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

• The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.5";
• The extension attribute will contain the user ID itself.

A heading for providing information about the registering authority organization responsible for a death notification.

Indicates that the entity is an organization.

• Fixed value: "ORG" (Organization)

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

Indicates that the entity is a single identifiable organization.

• Fixed value: "INSTANCE" (Specific)

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

To provide the nationally recognised identifier for the registering organization.

Where the type of registering organization is NHAIS, this identifier will be the 2/3 character NHAIS cypher.

Where the type of registering organization is not NHAIS (e.g. a PCT or NHS Trust), this identifier will be the national organisation code.

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

A NHAIS cypher 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.6";
• The extension attribute will contain the NHAIS cypher itself.

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

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.

The otherProviderPatient grouping may occur zero or one time to identify the patient's GP/GP Practice to be updated on the PDS.

The otherProviderPatient grouping may occur between zero and three times, once for each type of pharmacy details to be updated on the PDS.

NB: Primary Care Provider shall only be updated by NHAIS/NSTS or a GP/GP Practice.

NB: Only NCRS compliant pharmacies may be selected.

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 details of people related to the patient, such as: guardians, proxies and family or close friends as contacts.

The type of update being applied to the related person information shall be indicated as follows:

• Where the related person information is being removed, the updateMode attribute shall contain value "removed"; the id field (element) shall contain the PDS allocated object identifier associated with that related person. No other data shall be present.
• Where the related person information is being altered, the updateMode attribute shall contain value "altered"; the id field (element) shall contain the PDS allocated object identifier associated with that related person. All data associated with that person (both altered and unaltered) will need to be supplied as a bulk replacement principle applies for related person data.
• Where the related person information is being added, the updateMode attribute shall contain value "added"; the id field (element) shall not be present to provide a PDS allocated object identifier (an identifier to be associated with that related person will be allocated by the PDS).

Indicates the class of related person role.

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

• The classCode attribute of the scopedRelatedPersonRole element will contain a value from the list of codes in the x_RelatedPerson vocabulary.

To provide identifiers for the related person.

Where the related person information is being "altered" or "removed" (as indicated by the updateMode attribute of the scopedRelatedPersonRole element), one repeat is required to provide the PDS allocated object identifier associated with the related person details.

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

• The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.18.1";
• The extension attribute will contain the PDS Allocated Object Identifier itself.

Where the related person information is being "added" or "altered", one repeat is optional to provide the current nationally recognised identifier for the related person. 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 indicate the type of related person of the specified classCode in coded form.

This field shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the scopedRelatedPersonRole element).

This field shall not be provided where the update type is "removed" (as indicated by the updateMode attribute of the scopedRelatedPersonRole element).

Where this data is to be provided, 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 PersonRelationshipType vocabulary;
• The codeSystem attribute will contain the OID referenced in the PersonRelationshipType vocabulary.

To optionally provide an address of the related person according to the following rules:

An address shall not be present where an NHS number is provided in the id field.

Where an NHS number is not provided in the id field, an address shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the scopedRelatedPersonRole element).

This field shall not be provided where the update type is "removed" (as indicated by the updateMode attribute of the scopedRelatedPersonRole element).

Where an address is to be given, it 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 and last of these components are required to be present with any address of a related person.

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. NB: addresses updating the PDS shall conform to the NHAIS address format, where specific streetAddressLine elements contain specific address information, as follows:
• The first streetAddressLine element shall contain Premises ID (House Name) (or be present and have no value or a null flavor if there is no Premises ID);
• The second streetAddressLine element shall contain House Number and / or Thoroughfare (or be present and have no value or a null flavor if there is neither of these); at least one of the first streetAddressLine element and second streetAddressLine element shall have a non-null value;
• The third streetAddressLine element shall contain Locality (or be present and have no value or a null flavor if there is no locality);
• The fourth streetAddressLine element shall contain Post Town (this shall be a non-null value);
• The fifth streetAddressLine element shall contain County (or have no value or a null flavor or be absent if there is no county).
• A postalCode element is used to carry a postcode;
• An addressKey element is used to carry a PAF key.

The useablePeriod sub-element is optional to indicate dates from and to which the address was/is to be effective. This is 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 related person, according to the following rules:

Telecommunication numbers shall not be present where an NHS number is provided in the id field.

Where an NHS number is not provided in the id field, zero or more telecommunication numbers may be present.

Where a telecommunication number is to be given, it is carried, together with the contact method, 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, a single occurrence of the useablePeriod sub-element is required to 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. An effective date is 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 provide a date interval during which the relationship with the person was/will be 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 relationship was/will be effective, provided in YYYYMMDD format in the value attribute;
• The high sub-element may optionally be present with the date to which the the relationship was/will be effective provided in YYYYMMDD format in the value attribute.

Used to identify the order in which contacts should be contacted, in the range 1-99.

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

• The value attribute will contain the contact ranking of the related person.

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

A heading for indicating that the related person is the subject of the associated preferred contact method.

A heading for indicating that the related person is the subject of the associated call centre call-back consent.

NB: This may only be present where the related person is a proxy, i.e. where scopedRelatedPersonRole.classCode = "AGNT" (Agent - used for proxies).

A heading for indicating that the related person is the subject of the associated preferred written communication format.

A heading for providing information about the type of relationship between one role and another.

In this context, the next of kin role is part of the related person role.

A heading for providing information about the type of relationship between one role and another.

In this context, the correspondence role is part of the related person role.

A heading for providing information about the patient's NHAIS registration. In this context, it is only used when a patient has no current NHAIS posting.

NB: this data may only be updated by National Systems (i.e. NSTS) in P1R2 - any other occurrences received will be ignored. Note this may change in P2 hence pre-existing guidance on how to update this data is retained.

The type of update being applied to the NHAIS registration information shall be indicated as follows:

• Where the NHAIS registration information is being added or altered, the updateMode attribute shall contain value "added" or "altered" as appropriate. The value field shall contain the new value.
• Where the NHAIS registration information is being removed, the updateMode attribute shall contain value "removed". The value field shall not be present.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

To provide the type of observation in coded form.

In this context, the type of observation is an observation of a patient's NHAIS registration.

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

• The code attribute will contain value "14" (NHAIS registration) from the list of codes in the DemographicObservationType vocabulary;
• The codeSystem attribute will contain the OID referenced in the DemographicObservationType vocabulary.

To provide a date interval during which the NHAIS registration information was/will be 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 NHAIS registration information was/will be effective, provided in YYYYMMDD format in the value attribute;
• The high sub-element may optionally be present with the date to which the the NHAIS registration information was/will be effective provided in YYYYMMDD format in the value attribute.

To indicate that the patient is not currently registered on a local NHAIS system.

This field shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the nhaisRegistration element).

This field shall not be provided where the update type is "removed" (as indicated by the updateMode attribute of the nhaisRegistration element).

Where this data is to be provided, 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 NhaisRegistration vocabulary;
• The codeSystem attribute will contain the OID referenced in the NhaisRegistration 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.

The type of update being applied to the consent shall be indicated as follows:

• Where the consent information is being added or altered, the updateMode attribute shall contain value "added" or "altered" as appropriate. The value field shall contain the new value.
• Where the type of consent information is "Call centre call-back consent" and is being removed, the updateMode attribute shall contain value "removed". The value field shall not be present.
• NB: Where the type of consent information is "Consent to NHS Care Record Sharing", the updateMode attribute shall not contain value "removed". Consent to NHS Care Record Sharing values cannot be removed.

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.

Where provided, 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.

This field shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the consent element).

This field shall not be provided where the type of consent is "Call centre call-back consent" and the update type is "removed" (as indicated by the updateMode attribute of the consent element).

Where this data is to be provided, 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 providing information about the patient's Shared secret.

The type of update being applied to the shared secret shall be indicated as follows:

• Where the shared secret is being added or altered, the updateMode attribute shall contain value "added" or "altered" as appropriate. The value field shall contain the new value.
• Where the shared secret is being removed, the updateMode attribute shall contain value "removed". The value field shall not be present.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

To provide the type of observation in coded form.

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

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

• The code attribute will contain value "15" (Shared secret) from the list of codes in the DemographicObservationType vocabulary;
• The codeSystem attribute will contain the OID referenced in the DemographicObservationType vocabulary.

To provide the patient's shared secret (defined as personal information provided by the patient to be used by a call centre in verifying that the caller is this patient) as a text string of encrypted characters.

This field shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the sharedSecret element).

This field shall not be provided where the update type is "removed" (as indicated by the updateMode attribute of the sharedSecret element).

A heading for providing information about a patient's Healthspace registration.

The type of update being applied to the Healthspace registration shall be indicated as follows:

• Where the Healthspace registration is being added or altered, the updateMode attribute shall contain value "added" or "altered" as appropriate. The value field shall contain the new value.
• Where the Healthspace registration is being removed, the updateMode attribute shall contain value "removed". The value field shall not be present.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

To provide the type of observation in coded form.

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

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

• The code attribute will contain value "8" (Healthspace registration) from the list of codes in the DemographicObservationType vocabulary;
• The codeSystem attribute will contain the OID referenced in the DemographicObservationType vocabulary.

To provide the Healthspace registration status in coded form.

This field shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the healthspaceRegistration element).

This field shall not be provided where the update type is "removed" (as indicated by the updateMode attribute of the healthspaceRegistration element).

Where this data is to be provided, 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 HealthspaceRegistration vocabulary;
• The codeSystem attribute will contain the OID referenced in the HealthspaceRegistration vocabulary.

A heading for providing information about a death notification.

This shall be present where Person.deceasedTime is given. Otherwise not used.

Where present, the type of update being applied to the death notification registration status shall be indicated as follows:

• Where the death notification registration status is being added or altered, the updateMode attribute shall contain value "added" or "altered" as appropriate. The value field shall contain the new value.
• Where the death notification registration status is being removed because erroneously present death information is to be deleted from the current data on PDS, the updateMode attribute shall contain value "removed". The value field shall not be present.

NB: the updateMode attribute of the deathNotification element shall contain the same value as the updateMode attribute of the deceasedTime element.

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.

This field shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the deathNotification element).

This field shall not be provided where the update type is "removed" (as indicated by the updateMode attribute of the deathNotification element).

Where this data is to be provided, 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 a person who is not the patient.

This information may be present according to the following rules:

This information (i.e. name and preferred language) shall not be present where the updateMode associated with the scopedRelatedPersonRole is "removed".

This information (i.e. name and preferred language) shall not be present where the updateMode associated with the scopedRelatedPersonRole is "altered" or "removed" and an NHS number is provided in the scopedRelatedPersonRole.id field

Where the updateMode associated with the scopedRelatedPersonRole is "altered" or "removed" and an NHS number is not provided in the scopedRelatedPersonRole.id field, this information (i.e. at least a name) is required to be present.

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 a structured name for the related person.

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.

A heading for providing information about the language preferred by the person where it is not English.

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 (NCRS compliant) pharmacy.

The type of update being applied to the patient care provider information shall be indicated as follows:

• Where the patient care provider information is being removed, the updateMode attribute shall contain value "removed"; the id field (element) shall contain the PDS allocated object identifier associated with that patient care provider. No other data for the patient care provider shall be present.
• Where the patient care provider information is being altered, the updateMode attribute shall contain value "altered"; the id field (element) shall contain the PDS allocated object identifier associated with that patient care provider. A code indicating the type of patient care provider shall be present. An identifier for the patient care provider shall also be present in the HealthCareProvider.id field.
• Where the patient care provider information is being added, the updateMode attribute shall contain value "added"; the id field (element) shall not be present (an identifier to be associated with that patient care provider will be allocated by the PDS). A code indicating the type of patient care provider shall be present. An identifier for the patient care provider shall also be present in the HealthCareProvider.id field.

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 an identifier for the patient care provision details. This identifier is allocated by the PDS and needs to be referenced in any update or deletion of the patient care provision information.

This field shall be provided where the update type is "removed" or "altered" (as indicated by the updateMode attribute of the patientCareProvision element).

This field shall not be provided where the update type is "added" (as indicated by the updateMode attribute of the patientCareProvision element). An identifier to be associated with the patient care provision information will be allocated by the PDS.

Where this data is to be provided, the Identifier External datatype flavour is used to carry this information as follows:

• The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.18.1";
• The extension attribute will contain the PDS Allocated Object Identifier itself.

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.

This field shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the patientCareProvision element).

This field shall not be provided where the update type is "removed" (as indicated by the updateMode attribute of the patientCareProvision element).

Where this data is to be provided, 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. NB: This date shall not be in the future;
• 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. NB: This date shall not be in the future.

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

A heading for providing information about the language preferred by the person where it is not English.

Where this language information is associated with the patient, the type of update being applied to the language information shall be indicated as follows:

• Where the language information is being added or altered, the updateMode attribute shall contain value "added" or "altered" as appropriate. The languageCode and proficiencyLevelCode fields shall contain the new values.
• Where the language information is being removed, the updateMode attribute shall contain value "removed". No other data shall be present.

Where this language information is associated with a person related to the patient, this information may be present according to the following rules:

This information shall not be present where an NHS number is provided in the scopedRelatedPersonRole.id field

Where an NHS number is not provided in the scopedRelatedPersonRole.id field, this information may optionally be present.

The type of update being applied is specified in the scopedRelatedPersonRole element.

To provide the language in coded form.

This field shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the languageCommunication element).

This field shall not be provided where the update type is "removed" (as indicated by the updateMode attribute of the languageCommunication element).

Where this data is to be provided, 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 HumanLanguage vocabulary.

To provide the interpreter required indicator in coded form.

This field shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the languageCommunication element).

This field shall not be provided where the update type is "removed" (as indicated by the updateMode attribute of the languageCommunication element).

Where this data is to be provided, 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 InterpreterRequiredIndicator vocabulary;
• The codeSystem attribute will contain the OID referenced in the InterpreterRequiredIndicator vocabulary

An indicator specifying whether or not the language is preferred by the person.

This field shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the languageCommunication element).

This field shall not be provided where the update type is "removed" (as indicated by the updateMode attribute of the languageCommunication element).

Where this data is to be provided, as the requirement for PDS is to only provide the language preferred by the person where it is not English, the preferenceInd shall be set to "true".

A heading for providing information about how a person would prefer to be contacted.

Where this information is associated with the patient, the type of update being applied to the preferred contact method shall be indicated as follows:

• Where the preferred contact method is being added or altered, the updateMode attribute shall contain value "added" or "altered" as appropriate. The value field shall contain the new value.
• Where the preferred contact method is being removed, the updateMode attribute shall contain value "removed". The value field shall not be present.

Note: the updateMode value also applies to any preferred contact times when present.

Where this information is associated with a person related to the patient, this information may be present according to the following rules:

This information shall not be present where an NHS number is provided in the scopedRelatedPersonRole.id field

Where an NHS number is not provided in the scopedRelatedPersonRole.id field, this information may optionally be present.

The type of update being applied is specified in the scopedRelatedPersonRole element.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

To provide the type of observation in coded form.

In this context, the type of observation is an observation of patient preferred contact method.

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

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

To provide the type of preferred patient contact in coded form.

This field shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the preferredContactMethod element).

This field shall not be provided where the update type is "removed" (as indicated by the updateMode attribute of the preferredContactMethod element).

Where this data is to be provided, 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 PreferredContactMethod vocabulary;
• The codeSystem attribute will contain the OID referenced in the PreferredContactMethod vocabulary.

A heading for providing a link to information pertinent to the preferred contact method.

A heading for providing a proxy's call centre call-back consent details.

This information may be present according to the following rules:

This information shall not be present where an NHS number is provided in the scopedRelatedPersonRole.id field

Where an NHS number is not provided in the scopedRelatedPersonRole.id field, this information may optionally be present.

The type of update being applied is specified in the scopedRelatedPersonRole element.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

The moodCode is carried as an attribute of the callCentreCallBackConsent 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 the following value from the list of codes in the DemographicObservationType vocabulary:
• "6" (Call centre call-back consent).
• The codeSystem attribute will contain the OID referenced in the DemographicObservationType vocabulary.

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 related to call centre call-back consent, i.e. value "4" or "5";
• The codeSystem attribute will contain the OID referenced in the Consent vocabulary.

A heading for providing the preferred written communication format information.

Where this information is associated with the patient, the type of update being applied to the preferred written communication format information shall be indicated as follows:

• Where the preferred written communication format is being added or altered, the updateMode attribute shall contain value "added" or "altered" as appropriate. The value field shall contain the new value.
• here the preferred written communication format is being removed, the updateMode attribute shall contain value "removed". The value field shall not be present.

Where this information is associated with a person related to the patient, this information may be present according to the following rules:

This information shall not be present where an NHS number is provided in the scopedRelatedPersonRole.id field

Where an NHS number is not provided in the scopedRelatedPersonRole.id field, this information may optionally be present.

The type of update being applied is specified in the scopedRelatedPersonRole element.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

To provide the type of observation in coded form.

In this context, the type of observation is an observation of the preferred written communication format.

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

• The code attribute will contain value "13" (Preferred written communication format) from the list of codes in the DemographicObservationType vocabulary;
• The codeSystem attribute will contain the OID referenced in the DemographicObservationType vocabulary.

To provide the preferred written communication format in coded form.

This field shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the preferredWrittenCommunicationFormat element).

This field shall not be provided where the update type is "removed" (as indicated by the updateMode attribute of the preferredWrittenCommunicationFormat element).

Where this data is to be provided, 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 PreferredWrittenCommunicationFormat vocabulary;
• The codeSystem attribute will contain the OID referenced in the PreferredWrittenCommunicationFormat vocabulary.

A heading for providing details about a person related to the patient having a part of their role as a next of kin.

Indicates that the role is that of a next of kin.

• Fixed value: "NOK" (Next of kin)

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

This is only used to indicate that the person related to the patient is a next of kin in coded form.

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

• The code attribute will contain value "1" (Yes) from the NoKCode vocabulary;
• The codeSystem attribute will contain the OID referenced in the NoKCode vocabulary.

A heading for providing details about a person related to the patient having part of their a role as a contact.

Indicates that the role is that of a contact.

• Fixed value: "CON" (Contact)

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

This is only used to indicate that correspondence should be copied to the person related to the patient.

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

• The code attribute will contain value "1" (Yes) from the CorrespondenceCode vocabulary;
• The codeSystem attribute will contain the OID referenced in the CorrespondenceCode vocabulary.

A heading for providing supplementary textual comments arising from any review with a clinician regarding 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.

A heading for providing information about times when a patient would prefer to be contacted.

The type of update being applied to the preferred contact times is the same as that applied to preferred contact method and is specified by the updateMode attribute associated with preferredContactMethod.

Indicates that this is an observation.

• Fixed value: "OBS" (Observation)

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

Indicates that this is an observation which has occurred.

• Fixed value: "EVN" (Event)

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

To provide the type of observation in coded form.

In this context, the type of observation is an observation of patient preferred contact times.

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

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

To provide preferred contact times as a text string, e.g. Evenings only; Monday mornings between 09:00 and 12:00; etc.

This field shall be provided where the update type is "added" or "altered" (as indicated by the updateMode attribute of the preferredContactMethod element).

This field shall not be provided where the update type is "removed" (as indicated by the updateMode attribute of the preferredContactMethod element).