PdsAllocateNhsNumberRequest - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
PRPA_RM000203UK03
PdsRegistrationRequest
A heading for providing information about a request to allocate a NHS number for a patient.
Used by:
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="REG" }

Indicates that this is a registration.

  • Fixed value: "REG" (Registration)

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

[1..1] [M] moodCode (CS {CNE:ActMood } ) { 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 PdsRegistrationRequest element.

[1..1] [M] author
A heading for providing a link to the party authoring the PDS registration request.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { 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] [M] registeringAuthority (RegisteringAuthority)
A heading for providing details of the authority for the PDS registration.
[1..1] [M] subject
A heading for providing a link to the subject of the PDS registration request, i.e. the patient.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { 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] [M] patientRole (PatientRole)
A heading for providing details about the patient.
RegisteringAuthority
A heading for providing details of the authority for the PDS registration.
Used by: PdsRegistrationRequest
[1..1] [M] classCode (CS {CNE:RoleClass } ) { 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] [M] 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.
[1..1] [M] id (II)

The identifier of the assigned organisation acting as registration authority. This will be one of:

  • NHAIS Cypher
  • NACS code

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

If it is an NHAIS Cypher:

  • 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

If it is an NACS code:

  • The root attribute will contain an OID with the value "1.2.826.0.1285.0.2.1.54"
  • The extension attribute will contain the national organisation code

[0..1] assignedRegisteringOrganization (RegisteringOrganization)

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

NB: This must be present when RegisteringAuthority is NHAIS.

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 the entity is an organization.

  • Fixed value: "ORG" (Organization)

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

[1..1] [M] determinerCode (CS {CNE:EntityDeterminer } ) { 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] [M] scopedAssignedPerson (AssignedPerson)

A link to details of a person assigned to act on behalf of the organisation.

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 the role is that of an entity acting in the employ of an Organization

  • Fixed value: "ASSIGNED" (Assigned entity)
[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

PatientRole
A heading for providing details about the patient.
Used by: PdsRegistrationRequest
[1..1] [M] classCode (CS {CNE:RoleClass } ) { 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..*] [M] addr (SET<AD>)

To provide one or more addresses of the patient.

An address is composed of the following components:

  • Between one and five unstructured address lines;
  • Postcode;
  • A PAF (postal address file) key;
  • In the case of a temporary address, a textual description of nature of the address may also be provided;
  • An effective from date may be provided for every address; an effective to date may also be provided for any address.

The first and last of these components are required to be present with any address.

The type of address is required to be identified by using one of the following codes in the use attribute:

  • H - usual address;
  • TMP - temporary address;
  • PST - correspondence 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 shallconform 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 address, the useablePeriod sub-element is required 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 is required to 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.
[0..*] telecom (SET<TEL>)

To provide zero or more telecommunication numbers of the patient, together with the contact method for each. These two items of information are carried 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, 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. These effective dates are 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.

NB: Implementation note : The "TEL" datatype has previously accepted non-compliant data which does not conform to the URL pattern. This appears to be a limitation of XML Schema toolkits which do not enforce the presence of a scheme component as noted in http://www.ietf.org/rfc/rfc2396.txtRFC 2396

[1..1] [M] patientPerson (Person)
A heading for providing information about the person who is the identified patient.
[0..*] recordTargetOf
A heading for indicating that the patient is the subject of the location of the patients paper record.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="RCT" }
Indicates that this is a Record Target participation.
[1..1] clinicalDocumentEvent (ClinicalDocumentEvent)
[0..1] subjectOf1

The participation of the patient in their NHAIS registration event.

This is only supplied by NHAIS.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }

Indicates that the patient is the subject of the associated NHAIS Registration

  • Fixed value: "SBJ" (Subject)

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

[1..1] nHAISRegistrationEvent (NHAISRegistrationEvent)
[0..1] subjectOf2
A heading for indicating that the patient is the subject of the associated preferred contact method.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }

Indicates that the patient is the subject of the associated preferred contact method.

  • Fixed value: "SBJ" (Subject)

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

[1..1] preferredContactMethod (PreferredContactMethod)
A heading for providing information about how a person would prefer to be contacted.
[0..1] subjectOf3
A heading for indicating that the patient is the subject of the associated preferred written communication format information.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }

Indicates that the patient is the subject of the associated preferred written communication format information.

  • Fixed value: "SBJ" (Subject)

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

[1..1] preferredWrittenCommunicationFormat (PreferredWrittenCommunicationFormat)
A heading for providing the preferred written communication format information.
[0..1] subjectOf4
A heading for indicating that the patient is the subject of the associated shared secret.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }

Indicates that the patient is the subject of the associated Shared secret.

  • Fixed value: "SBJ" (Subject)

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

[1..1] sharedSecret (SharedSecret)
A heading for providing information about the patient's Shared secret.
[1..1] [M] subjectOf5
A heading for indicating that the patient is the subject of the associated previous NHS contact information.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }

Indicates that the patient is the subject of the associated previous NHS contact information.

  • Fixed value: "SBJ" (Subject)

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

[1..1] [M] previousNhsContact (PreviousNhsContact)
A heading for providing information about whether the patient has had previous NHS contact.
Person
A heading for providing information about the person who is the identified patient.
Used by: PatientRole
[1..1] [M] classCode (CS {CNE:EntityClass } ) { 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] [M] determinerCode (CS {CNE:EntityDeterminer } ) { 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] [M] administrativeGenderCode (CV {CNE:Sex } )

To provide the current registered sex of the patient in coded form.

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

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

To provide the date the patient was born.

The date shall be given in the following format:

  • YYYYMMDD.

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

  • The value attribute will contain the date value in the format indicated.
[1..*] [M] 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 (mandatory)
  • 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. (optional)

One occurrence of current usual name (use type "L") shall be provided; up to one occurrence of a preferred name (use type "PREFERRED") may be provided; and any number of the other types (alias and previous) may also be provided.

[0..1] languageCommunication (LanguageCommunication)

A link to information about the verbal language preferred by the person where this is not English.
[0..*] playedOtherProviderPatient (OtherProviderPatient)
A heading for providing details about the patient when associated with other providers, such as registered GP Practice or pharmacies nominated by the patient.
[0..1] scopedRole      [CMET: COCT_MT000200UK02]

A link to information relating to the patients GP registration.

This is only supplied by NHAIS.
OtherProviderPatient
A heading for providing details about the patient when associated with other providers, such as registered GP Practice or pharmacies nominated by the patient.The otherProviderPatient grouping may occur zero or one time to identify the patient's GP Practice to be registered on the PDS.The otherProviderPatient grouping may occur between zero and three times, once for each type of pharmacy details to be registered on the PDS.NB: Primary Care Provider shall only be updated by NHAIS/NSTS or a GP Practice.NB: Only NCRS compliant pharmacies may be selected.
Used by: Person
[1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="PAT" }

Indicates that the role is that of a patient.

  • Fixed value: "PAT" (Patient)

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

[1..1] [M] subjectOf
A heading for indicating that the patient is the subject of the associated patient care provision.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" }

Indicates that the patient is the subject of the associated patient care provision.

  • Fixed value: "SBJ" (Subject)

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

[1..1] [M] patientCareProvision (PatientCareProvision)
A heading for defining a relationship between a patient and his/her primary care provider (registered GP Practice) or for a specific healthcare facility such as a type of pharmacy.
PatientCareProvision
A heading for defining a relationship between a patient and his/her primary care provider (registered GP Practice) or for a specific healthcare facility such as a type of pharmacy.
Used by: OtherProviderPatient
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="PCPR" }

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.

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

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.

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

To provide the type of defined patient care provision, such as primary care provider (registered GP Practice) or a type of pharmacy, in coded form.

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

  • The code attribute will contain a value from the list of codes in the PatientCareProvisionType vocabulary;
  • The codeSystem attribute will contain the OID referenced in the PatientCareProvisionType vocabulary.
[0..1] [R] effectiveTime (IVL<TS>)

To provide a date interval during which the patient care provision was effective.

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.
[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] assignedOrganisation (AssignedOrganisation)
A heading for providing details about a provider responsible for the patient care provision. In this context, this will be either GP Practice the patient is registered with or a type of pharmacy.
AssignedOrganisation

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

LanguageCommunication
A heading for providing information about the language preferred by the person where it is not English.
Used by: Person
[1..1] [M] languageCode (CS {CNE:HumanLanguage } )

To provide the language in coded form.

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

  • The code attribute will contain a value from the list of codes in the HumanLanguage vocabulary.
[1..1] [M] preferenceInd (BL)

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

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

[1..1] [M] proficiencyLevelCode (CV {CNE:InterpreterRequiredIndicator } )

To provide the interpreter required indicator 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 InterpreterRequiredIndicator vocabulary;
  • The codeSystem attribute will contain the OID referenced in the InterpreterRequiredIndicator vocabulary.
ClinicalDocumentEvent
Parent class linking to and containing information about a patient's paper medical record.
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"
[1..1] [M] 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.

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

The priority of the paper record transfer

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

  • The code attribute will contain the value of either "U" or "N" 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"
[0..1] location
A heading describing the link about the location for the Act
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="LOC" }
Indicates that this a Location participation.
[1..1] [R] serviceDeliveryLocation (ServiceDeliveryLocation)
[0..1] subjectOf
Indicates that the document event is the subject of the act.
[1..1] [M] typeCode (CS {CNE:SUBJ } )
Indicates that the relationship that of a subject.
[1..1] transferStatus (TransferStatus)
TransferStatus
The transfer status of a patients paper medical record.
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.
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 as a range, supplied in the Low and High attributes of the IVL_TS.The particular flavour of the timestamp datatype used here is Date Only (full dates without time). This means that dates must be in the format YYYYMMDD

[1..1] [M] location (BackOffice)

A link to details of the back office location.
BackOffice
An Entity which stores or coordinates the transfer of paper records.
Used by: ServiceDeliveryLocation
[1..1] [M] classCode (CS {CNE:PLC } )
Indicates that this Entity is a place.
[1..1] [M] determinerCode (CS {CNE:INSTANCE } )
Indicates that this Entity represents a distinct single instance.
[1..1] [M] name (ST)

An identifier of the back office location. This can be identified by: NHAIS Cypher; Scottish Area Health Board code; codes NI (Northern Ireland) and NBO (National Back Office).

PreviousNhsContact
A heading for providing information about whether the patient has had previous NHS contact.
Used by: PatientRole
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }

Indicates that this is an observation.

  • Fixed value: "OBS" (Observation)

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

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

Indicates that this is an observation which has occurred.

  • Fixed value: "EVN" (Event)

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

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

To provide the type of observation in coded form.

In this context, the type of observation is an observation of previous NHS contact information.

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

  • The code attribute will contain value "17" (Previous NHS contact) from the list of codes in the DemographicObservationType vocabulary;
  • The codeSystem attribute will contain the OID referenced in the DemographicObservationType vocabulary.
[1..1] [M] value (CV {CNE:PreviousNhsContact } )

To provide the previous NHS contact information 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 PreviousNhsContact vocabulary;
  • The codeSystem attribute will contain the OID referenced in the PreviousNhsContact vocabulary.
SharedSecret
A heading for providing information about the patient's Shared secret.
Used by: PatientRole
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }

Indicates that this is an observation.

  • Fixed value: "OBS" (Observation)

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

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

Indicates that this is an observation which has occurred.

  • Fixed value: "EVN" (Event)

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

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

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.
[1..1] [M] value (ST)
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.
PreferredWrittenCommunicationFormat
A heading for providing the preferred written communication format information.
Used by: PatientRole
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }

Indicates that this is an observation.

  • Fixed value: "OBS" (Observation)

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

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

Indicates that this is an observation which has occurred.

  • Fixed value: "EVN" (Event)

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

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

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.
[1..1] [M] value (CV {CNE:PreferredWrittenCommunicationFormat } )

To provide the preferred written communication format 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 PreferredWrittenCommunicationFormat vocabulary;
  • The codeSystem attribute will contain the OID referenced in the PreferredWrittenCommunicationFormat vocabulary.
PreferredContactMethod
A heading for providing information about how a person would prefer to be contacted.
Used by: PatientRole
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }

Indicates that this is an observation.

  • Fixed value: "OBS" (Observation)

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

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

Indicates that this is an observation which has occurred.

  • Fixed value: "EVN" (Event)

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

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

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.
[0..1] value (CV {CNE:PreferredContactMethod } )

To provide the type of preferred patient contact 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 PreferredContactMethod vocabulary;
  • The codeSystem attribute will contain the OID referenced in the PreferredContactMethod vocabulary.
[0..1] pertinentInformation
A heading for providing a link to information pertinent to the preferred contact method.
[1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="PERT" }

Defines the type of relationship of the preferred contact times to the preferred contact method, i.e. that the preferred contact times are pertinent to the preferred contact method.

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

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

[1..1] pertinentPreferredContactTimes (PreferredContactTimes)
A heading for providing information about times when a patient would prefer to be contacted.
PreferredContactTimes
A heading for providing information about times when a patient would prefer to be contacted.
Used by: PreferredContactMethod
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }

Indicates that this is an observation.

  • Fixed value: "OBS" (Observation)

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

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

Indicates that this is an observation which has occurred.

  • Fixed value: "EVN" (Event)

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

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

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.
[1..1] [M] value (ST)
To provide preferred contact times as a text string, e.g. Evenings only; Monday mornings between 09:00 and 12:00; etc.
NHAISRegistrationEvent
A heading for providing information about the NHAIS system to which the patient is registered.
Used by: PatientRole
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="REG" }
Indicates that this is a registration.
  • Fixed value: "REG" (Registration)
The classCode is carried as an attribute of the NhaisRegistrationEvent element.

[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }
Indicates that this is a registration which has occurred.
  • Fixed value: "EVN" (Event)
The moodCode is carried as an attribute of the NhaisRegistrationEvent element.

[1..1] [M] code (CV {CNE:DemographicRegistrationType } ) { Fixed="01" }
A coded value representing the type of demographic registration.

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

  • The code attribute will contain the fixed value "14".
  • The codeSystem attribute will contain the OID referenced in the DemographicObservationType vocabulary.
[0..1] effectiveTime (IVL<TS>)
The dates for which this registration applies. The High attribute of the IVL_TS instance is optional where the registration still applies at the time the instance is created, thus the Complete or After flavours of IVL may be used.
[1..1] [M] custodian
The custodian of the NHAIS registration.
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="CST" }
Indicates that this participation is a Custodian.
  • Fixed value: "CST" (Custodian)
The typeCode is carried as an attribute of the custodian element.
[1..1] [M] assignedDevice (AssignedDevice)
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.