PDS NHAIS Update Request - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
PRPA_RM000208UK03
PdsNhaisUpdateRequest

Parent class linking to a patient record containing updated information.

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

Indicates that this is a Registration act.

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

Indicates that this is a Request.

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

The type of update.

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

[0..1] author

A link to the Author of this Registration Request.

NB This must be provided where death information is being added or altered, and not used otherwise.

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

Indicates that this is an Author.

[1..1] registeringAuthority (RegisteringAuthority)

A link to details of the authority for the registration.

[1..1] [M] pertinentInformation

A link to information which is pertinent in some unspecified way.

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

Indicates Pertinent Information.

[1..1] [M] pertinentSerialChangeNumber (SerialChangeNumber)

A link to details of the Serial Change Number of the record that is to be updated.

[1..1] [M] subject

A link to the Subject of this Registration Request.

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

Indicates that this is a Subject.

[1..1] [M] patientRole (PatientRole)

A link to details of the updated patient record.

RegisteringAuthority

Parent class linking to and containing details of the authority for the registration.

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

Indicates that this is an Assigned role.

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

The type of registering authority.

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

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

The identifier of the assigned organisation acting as registration authority. This will be an NHAIS Cypher.

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

[1..1] [M] assignedRegisteringOrganization (RegisteringOrganization)

A link to details of the organisation playing the role of assigned organisation.

RegisteringOrganization

Parent class linking to details about the registering organisation, in particular a person assigned by the organisation.

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

Indicates that this is an Organisation entity.

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

Indicates that this is an Instance of an organisation.

[1..1] [M] scopedAssignedPerson (AssignedPerson)
A link to details of a person assigned to act on behalf of the organisation.

In this case, it represents an NHAIS user.

AssignedPerson

Details of a person assigned to act on behalf of an organisation.

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

Indicates that this is an Assigned role.

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

The identifier of the assigned person. In this case it is an NHAIS User ID.

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 NHAIS User ID

SerialChangeNumber

The Serial Change Number of the record on the PDS.

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

Indicates that this is an Observation act.

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

Indicates that this is an Event.

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

Indicates the type of observation. In this case, the observation is that of the serial change number of the record.

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

  • The code attribute will contain the value "2" (Serial change number) from the list of codes in the DemographicObservationType vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.35"

[1..1] [M] value (INT)

The value of the serial change number.

PatientRole

Parent class linking to and containing information about a patient.

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

Indicates that this is a Patient role.

[0..*] addr (SET<AD>)
Address(es) of the patient.

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

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

This means that the address will contain the following components:

  • Between one and five streetAddressLine elements. Excludes postcode, may be vernacular or PAF-derived. For vernacular addresses, the following formatting convention should be used:
    • Line 1: premises ID
    • Line 2: no. / thoroughfare
    • Line 3: locality
    • Line 4: post town
    • Line 5: county
    • Lines 1 or 2 and line 4 are mandatory
  • A postalCode element to carry a postcode (optional)
  • An addressKey element to carry a PAF key (optional)
  • The use attribute to denote the type of address. Only the value "H" is permitted here. (mandatory)
  • A useablePeriod element to contain the dates for which the address is / was current as a range, supplied in the low and high sub-elements. Both the low and high sub-elements are optional, allowing open-ended ranges to be specified. This mechanism allows previous addresses of any of the two types listed above to be carried in the message and distinguished from current addresses. The particular flavour of the timestamp datatype used here is Date Only. This means that the dates must be in the format YYYYMMDD. (optional)

Additionally, in order to control the update semantics, the following will also be present:

  • An updateMode attribute to indicate whether the item should be "added", "altered", or "removed" (mandatory)
  • An id attribute to carry the PDS allocated object identifier for the data item (optional)

These attributes should be used in the following way:

  • If the updateMode is set to "removed", the id attribute is mandatory, and none of the other attributes and elements shall be present, except for the use attribute, which is always mandatory.
  • If the updateMode is set to "altered", the id attribute is mandatory. The use attribute must contain the same value already associated with the address data item identified by the id attribute. (The value of the use attribute cannot be altered using this mechanism; in order to do so, the item must first be removed and then added again with the new use value.) The minimum set of streetAddressLine elements (1 or 2 and 4) shall be present.
  • If the updateMode is set to "added", the id attribute must not be present. The minimum set of streetAddressLine elements (1 or 2 and 4) shall be present.
[1..1] [M] id (II)
The current NHS number of the patient. This will be one of:
  • NHS Number
  • Old Format NHS Number
  • Temporary NHS Number (issued by an NHAIS registration authority)

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

If it is an NHS Number:

  • The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.4.1"
  • The extension attribute will contain the NHS Number

If it is an Old Format or Temporary NHS Number:

  • The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.3"
  • The extension attribute will contain the Old Format or Temporary NHS Number

NB This attribute is used for matching only and cannot be updated.
[0..1] patientPerson (Person)

A link to details of the person playing the role of patient.

[0..1] recordTargetOf

A link to a record which is a part of the medical record associated with this role.

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

Indicates that this is a Record Target participation.

[1..1] clinicalDocumentEvent (ClinicalDocumentEvent)

A link to information about a clinical document associated with the patient, in this case the patient's paper medical record.

[0..1] subjectOf1

A link to an Observation that this role is the subject of.

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

Indicates that this is a Subject participation.

[1..1] deathNotification (DeathNotification)

A link to details of the patient's death notification status.

[0..1] subjectOf2

A link to an Registration that this role is the subject of.

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

Indicates that this is a Subject participation.

[1..1] nHAISRegistrationEvent (NHAISRegistrationEvent)

A link to information relating to the addition of a patient's details to an NHAIS system.

[0..1] subjectOf3

A link to an Registration that this role is the subject of.

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

Indicates that this is a Subject participation.

[1..1] nHAISRemovalRegistrationEvent (NHAISRemovalRegistrationEvent)

A link to information relating to the removal of the patient's details from the NHAIS system.

Person

Parent class linking to and containing information about a patient which is specific to the person.

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

Indicates that this is a Person entity.

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

Indicates that this is an Instance of a person.

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

The administrative gender of the person.

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

  • The code attribute will contain a value from the list of codes in the Sex vocabulary.

Additionally, in order to control the update semantics, the following will also be present:

  • An updateMode attribute to indicate whether the item should be "added" or "altered". This item cannot be "removed".

[0..1] birthTime (TS)

The date (and optionally time) of birth of the person.

The particular flavours of the timestamp datatype allowed here are:

  • Date and Time
  • Date Only

Additionally, in order to control the update semantics, the following will also be present:

  • An updateMode attribute to indicate whether the item should be "added" or "altered". This item cannot be "removed".

[0..1] deceasedTime (TS)
The date (and optionally time) of death of the person.

The particular flavours of the timestamp datatype allowed here are:

  • Date and Time
  • Date Only
Additionally, in order to control the update semantics, the following will also be present:
  • An updateMode attribute to indicate whether the item should be "added", "altered" or "removed".

This attribute should be used in the following way:

  • If the updateMode is set to "removed", the value attribute shall not be present.
  • If the updateMode is set to "added" or "altered", the value attribute shall be present.
  • The value of the updateMode attribute shall be the same as the value of the updateMode attribute of the deathNotification class.
[0..*] name (SET<PN>)
Name(s) of the person.

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

  • A family element to carry the surname or family name of the person (optional)
  • Up to 2 given elements to carry the given names of the person. If the person has more than 2 given names, these will be concatenated in the second given name attribute with a space between each name. The order of the elements is also significant, so the first occurrence of the given element will carry the first given name, and the second occurrence will carry the second, third, etc. given names (optional)
  • A prefix element to carry a prefix for the name, such as Mr, Mrs, etc. (optional)
  • A suffix element to carry a suffix for the name, such as Jnr, Snr, etc. (optional)
  • A use attribute to denote the type of name (mandatory)
  • A validTime element to contain the dates for which the name is / was current as a range, supplied in the low and high sub-elements. Both the low and high sub-elements are optional, allowing open-ended ranges to be specified. The particular flavour of the timestamp datatype used here is Date Only. This means that the dates must be in the format YYYYMMDD. (optional)
Additionally, in order to control the update semantics, the following will also be present:
  • An updateMode attribute to indicate whether the item should be "added", "altered", or "removed" (mandatory)
  • An id attribute to carry the PDS allocated object identifier for the data item (optional)

These attributes should be used in the following way:

  • If the updateMode is set to "removed", the id attribute is mandatory, and none of the other optional attributes and elements shall be present. The value of the use attribute associated with the name data item identified by the id attribute must not be "L" (usual), as a usual name cannot be removed.
  • If the updateMode is set to "altered", the id attribute is mandatory. The use attribute must contain the same value already associated with the name data item identified by the id attribute. (The value of the use attribute cannot be altered using this mechanism; in order to do so, the item must first be removed and then added again with the new use value.)
  • If the updateMode is set to "added", the id attribute must not be present.
Note: Family name shall not be present when a name is being removed, but is mandatory when the name is being added or altered.
[0..1] playedOtherProviderPatient (OtherProviderPatient)

A link to information about the patient while in the care of other providers.

[0..1] scopedRole      [CMET: COCT_MT000200UK02]

A link to information relating to the patient's GP registration. This can only be added/updated at the same time as the PatientCareProvisionEvent class, and is updated as a single unit.

OtherProviderPatient

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

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

Indicates that this is a Patient role.

[1..1] [M] subjectOf

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

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

Indicates that this is a Subject participation.

[1..1] [M] patientCareProvisionEvent (PatientCareProvisionEvent)

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

PatientCareProvisionEvent
Parent class linking to and containing information about a primary care organisation responsible for a patient over a period of time.
Additionally, in order to control the update semantics, the following will also be present:
  • An updateMode attribute to indicate whether the item should be "added", "altered", or "removed" (mandatory)
Used by: OtherProviderPatient
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="PCPR" }

Indicates that this is a Patient Care Provision act.

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

Indicates that this is an Event.

[0..1] code (CV {CNE:PatientCareProvisionType } ) { Fixed="1" }
Indicates the type of patient care provision.

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

  • The code attribute will contain the value "1" (Primary care) from the list of codes in the PatientCareProvisionType vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.37"

This attribute shall be used in conjunction with the updateMode attribute of PatientCareProvision in the following way:

  • This attribute shall not be present when the updateMode is set to "removed"
  • This attribute shall be present when the updateMode is set to "added" or "altered"

[0..1] effectiveTime (IVL<TS>)
The effective dates for the care provision relationship represented as a range, supplied in the low and high sub-elements. Both the low and high sub-elements are optional, allowing open-ended ranges to be specified.

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

This attribute shall be used in conjunction with the updateMode attribute of PatientCareProvision in the following way:

  • When the updateMode is set to "removed", this attribute may optionally be present to indicate a business effective to date.
  • This attribute shall be present when the updateMode is set to "added"
  • This attribute shall be present when the updateMode is set to "altered"

[0..1] id (II)

A unique identifier for the patient care provision details. This identifier is allocated by the PDS.

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

This attribute shall be used in conjunction with the updateMode attribute of PatientCareProvision in the following way:

  • This attribute shall be present when the updateMode is set to "altered" or "removed"
  • This attribute shall not be present when the updateMode is set to "added"

[0..1] performer

A link to the Performer of this PatientCareProvision.

This link shall be used in conjunction with the updateMode attribute of PatientCareProvision in the following way:

  • This link shall not be present when the updateMode is set to "removed"
  • This link must be present when the updateMode is set to "added" or "altered"

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

Indicates that this is a performer.

[1..1] [R] assignedOrganization (AssignedOrganization)

A link to details of the organisation which is the performer of the patient care provision.

AssignedOrganization

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

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

Indicates that this is an Assigned role.

[1..1] [M] id (II)
The identifier of the assigned organisation acting as health care provider. This will be a GP Practice Code.

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.4.3"
  • The extension attribute will contain the GP Practice Code
ClinicalDocumentEvent

Parent class linking to and containing information about a patient's paper medical record.

In addition to the attributes below, in order to control the update semantics, the following will also be present:

  • An updateMode attribute to indicate whether the item should be "added", "altered" or "removed" (mandatory)

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

Indicates that this is a Clinical Document act.

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

Indicates that this is an Event.

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

The type of clinical document. In this case, it is the patient's paper medical record.

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

  • The code attribute will contain the value "16521000000101" (Lloyd George record folder) from the list of codes in the SnomedCT vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.15"
[0..1] effectiveTime (IVL<TS>)

The time period in which this information is valid, represented as a range, supplied in the low and high sub-elements. Both the low and high sub-elements are optional, allowing open-ended ranges to be specified.

The particular flavour of the timestamp datatype used here is Date Only. This means that dates must be in the format YYYYMMDD

This attribute shall be used in conjunction with the updateMode attribute of ClinicalDocumentEvent in the following way:

  • This attribute shall not be present when the updateMode is set to "removed"
  • This attribute shall be present when the updateMode is set to "added" or "altered"

[0..1] id (II)

A unique identifier for the object. This identifier is allocated by the PDS.

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

This attribute shall be used in conjunction with the updateMode attribute of ClinicalDocumentEvent in the following way:

  • This attribute shall be present when the updateMode is set to "altered" or "removed"
  • This attribute shall not be present when the updateMode is set to "added"

[0..1] priorityCode (CV {CNE:PaperRecordTransferPriority } )

The priority of the transfer.

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 PaperRecordTransferPriority vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.190"

This attribute shall be used in conjunction with the updateMode attribute of ClinicalDocumentEvent in the following way:

  • This attribute shall not be present when the updateMode is set to "removed"
[0..1] location

A link to a Location for the act.

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

Indicates that this is a Location participation.

[1..1] serviceDeliveryLocation (ServiceDeliveryLocation)

A link to details of a location where the paper medical record should be stored.

[0..1] subjectOf

A heading describing the link to an Observation that this act is the subject of.

This attribute shall be used in conjunction with the updateMode attribute of ClinicalDocumentEvent in the following way:

  • This attribute shall not be present when the updateMode is set to "removed"

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

Indicates that this is a Subject relationship.
[1..1] transferStatus (TransferStatus)

A link to details of the transfer status of this clinical document.
TransferStatus

The transfer status of a patient's paper medical record.

NB The update mode of this class is the same as the update mode of the ClinicalDocumentEvent class.

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

Indicates that this is an Observation act.
[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }

Indicates that this is an Event.
[1..1] [M] code (CV {CNE:DemographicObservationType } ) { Fixed="19" }

Indicates the type of observation. In this case, the observation is that of the transfer status of a patient's paper medical record.

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

  • The code attribute will contain the value "19" (Paper record transfer status) from the list of codes in the DemographicObservationType vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.35"
[1..1] [M] value (CV {CNE:PaperRecordTransferFlag } )

The transfer status of the paper record, also known as Paper Record Transfer Flag.

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 PaperRecordTransferFlag vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.167"
ServiceDeliveryLocation

A location where services are provided. In this case, it represents the Back Office location for the PCT in which the patient resides.

In addition to the attributes below, in order to control the update semantics, the following will also be present:

  • An updateMode attribute to indicate whether the item should be "added", "altered" or "removed" (mandatory)

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

Indicates that this is a Service Delivery Location role.

[0..1] effectiveTime (IVL<TS>)

The time period in which this information is valid, represented as a range, supplied in the low and high sub-elements. Both the low and high sub-elements are optional, allowing open-ended ranges to be specified.

The particular flavour of the timestamp datatype used here is Date Only. This means that dates must be in the format YYYYMMDD

This attribute shall be used in conjunction with the updateMode attribute of ServiceDeliveryLocation in the following way:

  • This attribute shall not be present when the updateMode is set to "removed"
  • This attribute shall be present when the updateMode is set to "added" or "altered"

[0..1] id (II)

A unique identifier for the object. This identifier is allocated by the PDS.

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

This attribute shall be used in conjunction with the updateMode attribute of ServiceDeliveryLocation in the following way:

  • This attribute shall be present when the updateMode is set to "altered" or "removed"
  • This attribute shall not be present when the updateMode is set to "added"

[0..1] location (BackOffice)

A link to details of the back office location.

BackOffice

Parent class containing details of a back office location of a patient's paper medical record.

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

Indicates that this is a place.

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

Indicates that this is an instance of a place.

[1..1] [M] name (ST)

An identifier of the back office location.

This will be an NHAIS Cypher.

NHAISRemovalRegistrationEvent
Information relating to the removal of a patient's details from an NHAIS system. In addition to the attributes below, in order to control the update semantics, the following will also be present:
  • An updateMode attribute to indicate whether the item should be "added", "altered" or "removed" (mandatory)
Used by: PatientRole
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="REG" }

Indicates that this is a Registration act.

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

Indicates that this is an Event.

[1..1] [M] code (CV {CNE:DemographicRegistrationType } ) { Fixed="02" }
Indicates the type of registration. In this case, it is the removal of a record from an NHAIS system.

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

  • The code attribute will contain the value "02" (NHAIS Removal) from the list of codes in the DemographicRegistrationType vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.165"
[0..1] effectiveTime (IVL<TS>)
The time period in which the information is valid, represented as a range, supplied in the low and high sub-elements. Both the low and high sub-elements are optional, allowing open-ended ranges to be specified.

The particular flavour of the timestamp datatype used here is Date Only. This means that the dates must be in the format YYYYMMDD.
This attribute shall be used in conjunction with the updateMode attribute of NHAISRemovalRegistrationEvent in the following way:
  • This attribute (but only the high sub-element) may optionally be present when the updateMode is set to "removed"
  • This attribute shall be present when the updateMode is set to "added" or "altered"
[0..1] reasonCode (CV {CNE:NHAISRemovalReasonCode } )
The reason for removal.

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 NHAISRemovalReasonCode vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.168"

This attribute shall be used in conjunction with the updateMode attribute of NHAISRemovalRegistrationEvent in the following way:

  • This attribute shall not be present when the updateMode is set to "removed"
  • This attribute shall be present when the updateMode is set to "added" or "altered"

NHAISRegistrationEvent
Information relating to the registration of a patient's details onto an NHAIS system. In addition to the attributes below, in order to control the update semantics, the following will also be present:
  • An updateMode attribute to indicate whether the item should be "added", "altered" or "removed" (mandatory)
Used by: PatientRole
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="REG" }

Indicates that this is a Registration act.

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

Indicates that this is an Event.

[1..1] [M] code (CV {CNE:DemographicRegistrationType } ) { Fixed="01" }
Indicates the type of registration. In this case, it is the registration of a record onto an NHAIS system.

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

  • The code attribute will contain the value "01" (NHAIS Registration) from the list of codes in the DemographicRegistrationType vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.165"
[0..1] effectiveTime (IVL<TS>)
The time period in which the information is valid, represented as a range, supplied in the low and high sub-elements. Both the low and high sub-elements are optional, allowing open-ended ranges to be specified.

The particular flavour of the timestamp datatype used here is Date Only. This means that the dates must be in the format YYYYMMDD.

This attribute shall be used in conjunction with the updateMode attribute of NHAISRegistrationEvent in the following way:

  • This attribute shall not be present when the updateMode is set to "removed"
  • This attribute shall be present when the updateMode is set to "added" or "altered"

[0..1] custodian

A link to the Custodian of this Registration act.

This link shall be used in conjunction with the updateMode attribute of NHAISRegistrationEvent in the following way:

  • This link shall not be present when the updateMode is set to "removed"

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

Indicates that this is a Custodian participation.

[1..1] assignedDevice (AssignedDevice)

A link to details of the assigned entity (in this case a device) acting as custodian.

AssignedDevice

Details of an assigned device, which in this case is a system acting as an assigned device.

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

Indicates that this is an Assigned role.

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

The identifier of the NHAIS system to which the patient is registered, which is an NHAIS Cypher. This 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 ID of the NHAIS system, which is an NHAIS Cypher.

DeathNotification
The death notification status of the patient. In addition to the attributes below, in order to control the update semantics, the following will also be present:
  • An updateMode attribute to indicate whether the item should be "added", "altered" or "removed" (mandatory)

This attribute should be used in the following way:

  • The value of the updateMode attribute shall contain the same value as the updateMode attribute of the deceasedTime attribute of the Person class
Used by: PatientRole
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }

Indicates that this is an Observation act.

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

Indicates that this is an Event.

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

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

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

  • The code attribute will contain the value "3" (Death notification) from the list of codes in the DemographicObservationType vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.35"

[0..1] value (CV {CNE:DeathNotification } )
The value of the death notification status.

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

  • The code attribute will contain a value from the list of codes in the DeathNotification vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.16.5"

NB Only DSA, NSTS, NN4B and ONS can update the PDS with the value "2" (Formal)

This attribute shall be used in conjunction with the updateMode attribute of DeathNotification in the following way:

  • This attribute shall not be present when the updateMode is set to "removed"
  • This attribute shall be present when the updateMode is set to "added" or "altered"