PdsDeathUpdateRequest - tabular view

No Current Link To VocabularyCoded With Extensions
PRPA_RM150000UK12
PdsUpdateRequest

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

Used by:
[1..1] classCode (CS {CNE:REG} ){ Fixed="REG " }

Indicates that this is a registration.

  • Fixed value: "REG" (Registration)

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

[1..1] moodCode (CS {CNE:RQO} ){ Fixed="RQO " }

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.

[1..1] code (CV {CNE:UpdateType} )

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

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

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

Indicates that the patient's record is the subject.

  • Fixed value: "SBJ" (Subject)

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

[1..1] patientRole (PatientRole)

A heading for providing details about the patient.

[1..1] author

A heading for providing a link to the party authoring the registration request.

[1..1] typeCode (CS {CNE:AUT} ){ Fixed="AUT " }

Defines the type of participation of the linked party to the PDS registration, i.e. that the linked party is the author (registration authority).

  • Fixed value: "AUT" (Author [originator])

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

[1..1] registeringAuthority (RegisteringAuthority)

A heading for providing details of the authority for the PDS registration.

[1..1] pertinentInformation

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

[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT " }

Defines the type of relationship of the Serial Change Number to the registration request, i.e. that the Serial Change Number is pertinent to the registration request.

  • Fixed value: "PERT" (Has pertinent information)

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

[1..1] pertinentSerialChangeNumber (SerialChangeNumber)

A heading for providing the Serial Change Number for a Service User record on the PDS.

PatientRole

A heading for providing details about the patient.

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

Indicates that the role is that of a patient.

  • Fixed value: "PAT" (Patient)

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

[1..1] id (II)

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.
[1..1] patientPerson (Person)

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

[1..1] subjectOf

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] typeCode (CS {CNE:SBJ} ){ Fixed="SBJ " }

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

  • Fixed value: "SBJ" (Subject)

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

[1..1] deathNotification (DeathNotification)

A heading for providing information about a death notification.

RegisteringAuthority

A heading for providing details of the authority for the PDS registration.

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

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.

[1..1] code (CV {CNE:RegisteringAuthorityType} )

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.
[0..1] assignedRegisteringPerson (RegisteringPerson)

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.

[1..1] representedRegisteringOrganization (RegisteringOrganization)

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

SerialChangeNumber

A heading for providing the Serial Change Number for a Service User record on the PDS.

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

Indicates that this is an observation.

  • Fixed value: "OBS" (Observation)

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

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

Indicates that this is an observation which has occurred.

  • Fixed value: "EVN" (Event)

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

[1..1] code (CV {CNE:DemographicObservationType} )

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.
[1..1] value (INT)

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

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

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

Indicates that the entity is a person.

  • Fixed value: "PSN" (Person)

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

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

Indicates that the entity is a single identifiable person.

  • Fixed value: "INSTANCE" (Specific)

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

[1..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:

  • Where a death date is being added or altered, the value attribute shall contain the date value in one of the formats indicated; the updateMode attribute shall contain value "added" or "altered" as appropriate.
  • A death date shall not be removed using this message - it may only be removed via the PDS administrative portal.
RegisteringPerson

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.

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

Indicates that the entity is a person.

  • Fixed value: "PSN" (Person)

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

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

Indicates that the entity is a single identifiable person.

  • Fixed value: "INSTANCE" (Specific)

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

[1..1] id (II)

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

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

Used by: RegisteringAuthority
[1..1] classCode (CS {CNE:ORG} ){ Fixed="ORG " }

Indicates that the entity is an organization.

  • Fixed value: "ORG" (Organization)

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

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

Indicates that the entity is a single identifiable organization.

  • Fixed value: "INSTANCE" (Specific)

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

[1..1] id (II)

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
DeathNotification

A heading for providing information about a death notification.

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.
  • The death notification registration status shall not be removed using this message - it may only be removed via the PDS administrative portal.
Used by: PatientRole
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS " }

Indicates that this is an observation.

  • Fixed value: "OBS" (Observation)

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

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

Indicates that this is an observation which has occurred.

  • Fixed value: "EVN" (Event)

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

[1..1] code (CV {CNE:DemographicObservationType} )

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.
[1..1] value (CV {CWE:DeathNotification} )

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.