PdsNhsNumberConfirmation - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
PRPA_RM000202UK02
PdsNhsNumberConfirmation

Parent class linking to details returned in the confirmation query response. As well as confirming that the NHS number specified in the query exists on the PDS, a number of data fields are also retrieved from the PDS.

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

Indicates that this is an Observation act.

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

Indicates that this is an Event.

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

The Serial Change Number of the record associated with the NHS Number that is being confirmed.

[1..1] [M] subject

A link to the Subject of this Observation Event.

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

Indicates that this is a subject.

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

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

SerialChangeNumber

The Serial Change Number of the record on the PDS.

Used by: PdsNhsNumberConfirmation
[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: PdsNhsNumberConfirmation
[1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="PAT" }
Indicates that this is a Patient role.
[0..*] addr (SET<AD>)

Address(es) of the patient.

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

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

This means that the address will contain the following components:

  • Between one and five streetAddressLine elements. Excludes postcode, may be vernacular or PAF-derived. For vernacular addresses, the following formatting convention should normally apply although there may be some exceptions:
    • Line 1: premises ID
    • Line 2: no. / thoroughfare
    • Line 3: locality
    • Line 4: post town
    • Line 5: county
    • Lines 1 or 2 and line 4 should normally be mandatory although there may be some exceptions
  • A postalCode element to carry a postcode (optional)
  • An addressKey element to carry a PAF key (optional)
  • A desc element to carry a free-text description of the nature of the address (e.g. "On holiday") (optional, may only be present for a temporary address, i.e. if the use attribute is "TMP")
  • The use attribute to denote the type of address. Only the values "H" (Home address) and "TMP" (Temporary address) are permitted here. (mandatory)
  • A useablePeriod element to contain the dates for which the address is / will be current as a range, supplied in the low and high sub-elements. Only current and future dated addresses are provided here. (optional)
[0..1] confidentialityCode (CV {CNE:InformationSensitivity } )

Indicates whether or not the patient's details are marked as sensitive.

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

  • The code attribute will contain a value from the list of codes in the InformationSensitivity vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.16.1"
[1..1] [M] id (II)
The current NHS number of the patient. This will be one of:
  • NHS Number
  • Old Format NHS Number
  • Temporary NHS Number (issued by an NHAIS registration authority)

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

If it is an NHS Number:

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

If it is an Old Format or Temporary NHS Number:

  • The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.3"
  • The extension attribute will contain the Old Format or Temporary NHS Number
[0..1] patientPerson (Person)

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

[0..*] 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] consent (Consent)

A link to details of the patient's consent statuses.

[0..1] subjectOf2

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

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

Indicates that this a Subject participation.

[1..1] deathNotification (DeathNotification)

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

Person
Parent class linking to and containing information about a patient which is specific to the person.
Used by: PatientRole
[1..1] [M] classCode (CS {CNE:EntityClass } ) { Fixed="PSN" }
Indicates that this is a Person entity.
[1..1] [M] determinerCode (CS {CNE:EntityDeterminer } ) { Fixed="INSTANCE" }
Indicates that this is an Instance of a person.
[0..1] administrativeGenderCode (CS {CNE:Sex } )

The administrative gender of the person.

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

  • The code attribute will contain a value from the list of codes in the Sex vocabulary.
[0..1] birthTime (TS)

The date of birth of the person.

The particular flavour of the timestamp datatype allowed here is:

  • Date Only
[0..1] deceasedTime (TS)

The date and time of death of the person.

[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. Only the values "L" (usual), "A" (alias) and "PREFERRED" (preferred) are permitted here (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. Only current and future dated names are provided here. (optional)
[0..*] playedOtherProviderPatient (OtherProviderPatient)

A link to details relevant to the person when playing the role of patient of (i.e. in the care of) other providers.

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.

NB Only one of each type of pharmacy data may be provided.

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

Indicates that this is a Subject participation.

[1..1] [M] patientCareProvision (PatientCareProvision)

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

PatientCareProvision

Parent class linking to and containing information about a primary care organisation or nominated pharmacy responsible for a patient over a period of time.

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

Indicates that this is a Patient Care Provision act.

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

Indicates that this is an Event.

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

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 a value from the list of codes in the PatientCareProvisionType vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.37"
[0..1] effectiveTime (IVL<TS>)

The effective dates for the care provision relationship represented as a range, supplied in the low and high sub-elements. Both the low and high sub-elements are optional, allowing open-ended ranges to be specified.

May only be present where the PatientCareProvisionType is "1" (Primary care).

[1..1] [M] performer

A link to the Performer of this PatientCareProvision.

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

Indicates that this is a performer.

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

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

AssignedOrganization

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

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

Indicates that this is an Assigned role.

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

The identifier of the assigned organisation acting as health care provider. This will be one of:

  • GP Practice Code - where the PatientCareProvisionType is "1" (Primary Care)
  • National Pharmacy Code - where the PatientCareProvisionType is "P1","P2" or "P3"

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

If it is a GP Practice Code or National Pharmacy Code:

  • The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.4.3"
  • The extension attribute will contain the GP Practice Code or National Pharmacy Code
Consent

Details of consent status for care record sharing or call centre call-back. Patients may opt in or out of having their care records shared with other clinicians, or receiving callbacks from NHS call centres.

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:DemographicConsentObservationType } )

A code to indicate 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 DemographicConsentObservationType vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.164"
[0..1] effectiveTime (TS)

The date the consent value last changed.

May only be present where the type of consent is "4" (Consent to NHS Care Record sharing)

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

  • The value attribute will contain the date value in the format YYYYMMDD
[1..1] [M] value (CV {CNE:Consent } )

The value of the consent 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 Consent vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.16.2"
DeathNotification

The Death Notification status of the patient.

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

Indicates that this is an Observation act.

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

Indicates that this is an Event.

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

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

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

  • The code attribute will contain the value "3" (Death notification) from the list of codes in the DemographicObservationType vocabulary
  • The codeSystem attribute will contain the OID "2.16.840.1.113883.2.1.3.2.4.17.35"
[1..1] [M] value (CV {CNE:DeathNotification } )

The value of the death notification status.

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

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