| PRPA_RM000201UK03 | ||||||||||
| PDSResponse |
A heading for providing information about the retrieval of requested patient demographic data from PDS. The patient's current nationally recognised identifier will always be present in a successful retrieval. In addition, the PDS will always return the Serial Change Number. Any other data items will only be present if they had been requested in the PDS Retrieval Query this is a response to. |
|||||||||
| 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 heading for providing a link to information pertinent to the PDSResponse.
|
|||||||||
| [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.
|
|||||||||
| [1..1] [M] subject |
A heading for providing a link to the subject of the PDSResponse Observation Event. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this a Subject participation.
|
|||||||||
| [1..1] [M] patientRole (PatientRole) |
A heading for providing details about the patient. |
|||||||||
| SerialChangeNumber |
The Serial Change Number of the record on the PDS |
|||||||||
| Used by: PDSResponse | ||||||||||
| [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:
|
|||||||||
| [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: PDSResponse | ||||||||||
| [1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="PAT" } |
Indicates that this is a Patient role.Indicates that this is a Patient role.
|
|||||||||
| [0..1] confidentialityCode (CV {CNE:InformationSensitivity } ) |
To indicate the nature of any sensitive information about the patient in coded form.
Only values "B", "S" and "Y" are returned by this Trace, where:
|
|||||||||
| [1..1] [M] id (II) |
The current NHS number of the patient. This will be one of:
|
|||||||||
| [0..1] patientPerson (Person) |
A link to details of the person playing the role of patient.
|
|||||||||
| [0..*] recordTargetOf |
A heading for indicating that the patient is the subject of the location of the patient's paper record.
|
|||||||||
| [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..*] replacementOf |
A heading for providing information about the type of relationship between one role and another. In this context, the patient role is a replacement of the supercededId role. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:RoleLinkType } ) { Fixed="REPL" } |
Indicates that the patient role is a replacement of the supercededId role.
The typeCode is carried as an attribute of the replacementOf element. |
|||||||||
| [1..1] oldVersion (SupercededId) |
A link for providing details about nationally recognised identifiers for the patient that have been superceded, such as old format NHS numbers or Temporary NHS number issued by an NHAIS registration authority which has subsequently been superceded by a NHS number. |
|||||||||
| [0..1] subjectOf1 |
A heading for indicating that the patient is the subject of the associated Healthspace registration.
|
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this a Subject participation.
|
|||||||||
| [1..1] healthspaceRegistration (HealthspaceRegistration) |
A link for providing information about a patient's Healthspace registration.
|
|||||||||
| [0..1] subjectOf2 |
A heading for indicating that the patient is the subject of the associated death notification.
This shall not be present where the person.deceasedTime field is not present. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this a Subject participation.
|
|||||||||
| [1..1] deathNotification (DeathNotification) |
A link for providing information about a death notification. |
|||||||||
| [0..*] subjectOf3 |
A heading for indicating that the patient is the subject of the associated consent.
|
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this a Subject participation.
|
|||||||||
| [1..1] consent (Consent) |
A link for providing information about patient consent.
|
|||||||||
| [0..1] subjectOf4 |
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 this a Subject participation.
|
|||||||||
| [1..1] preferredContactMethod (PreferredContactMethod) | ||||||||||
| [0..1] subjectOf5 |
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 this a Subject participation.
|
|||||||||
| [1..1] preferredWrittenCommunicationFormat (PreferredWrittenCommunicationFormat) | ||||||||||
| [0..1] subjectOf6 |
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 this a Subject participation.
|
|||||||||
| [1..1] sharedSecret (SharedSecret) |
A link for providing information about the patient's Shared secret. |
|||||||||
| [0..1] subjectOf7 |
A heading for indicating that the patient is the subject of the associated NHAIS registration information.
|
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this 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] subjectOf8 |
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 this a Subject participation.
|
|||||||||
| [1..1] previousNhsContact (PreviousNhsContact) |
A link for providing information about whether the patient has had previous NHS contact.
|
|||||||||
| [0..1] subjectOf9 |
A heading for indicating that the patient is the subject of the reason a service user has been removed.
|
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this a Subject participation.
|
|||||||||
| [1..1] nHAISRemovalRegistrationEvent (NHAISRemovalRegistrationEvent) |
A link to the reason a service user has been removed, where the service user is defined by the NhaisRegistration vocabulary.
|
|||||||||
| 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:
|
|||||||||
| [0..1] birthTime (TS) |
To provide the date the patient was born. The date/time may be given in one of the following formats:
One of the Date and Time, Date Only, Date Month or Date Year datatype flavours is used to carry this information as follows:
|
|||||||||
| [0..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:
One of the Date and Time, Date Only, Date Month or Date Year datatype flavours is used to carry this information as follows:
|
|||||||||
| [0..1] multipleBirthOrderNumber (INT) |
Describes the sequence in the case of multiple births (e.g. twins, triplets etc).
For births that are not a part of a multiple birth, this will be set to 1. Note that permissible values are 1-9, with any value between
|
|||||||||
| [0..1] birthplace (Birthplace) |
A link for providing details of the patient's place of birth.
|
|||||||||
| [0..1] languageCommunication (LanguageCommunication) | ||||||||||
| [0..*] playedOtherProviderPatient (OtherProviderPatient) |
A link providing details about the patient when associated with other providers, such as registered GP/GP Practice or pharmacies
nominated by the patient.
|
|||||||||
| [0..*] scopedRelatedPersonRole (RelatedPersonRole) |
A link providing details of people related to the patient, such as: guardians, proxies and family or close friends as contacts. |
|||||||||
| [0..*] scopedRole (COCT_MT000201UK02) |
A link to a CMET representing an address when additional additional information about the address needs to be supplied.
|
|||||||||
| [0..*] scopedRole1 (COCT_MT000202UK02) |
A link to a CMET representing a telecommunication address, when additional administrative information about the telecommunication address needs to be supplied. |
|||||||||
| [0..*] scopedRole2 (COCT_MT000203UK02) |
A link to a CMET representing a name of a person, when additional administrative information about the name needs to be supplied. |
|||||||||
| Birthplace |
Details of a person's place of birth. |
|||||||||
| Used by: Person | ||||||||||
| [1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="BIRTHPL" } |
Indicates that this is a Birthplace role.
|
|||||||||
| [1..1] [M] addr (AD) |
Details of the patient's place of birth in as much detail as is available, i.e., may just be the country the patient was born
in, but could also be the county and/or the town. The permissible elements are listed below, at least one which must be populated.
The AD.NPfIT.CodedCountry datatype flavour will be used to express this attribute, and will contain the following components:
|
|||||||||
| 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 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 this 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 GP, 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:
NB Only one of each type of pharmacy data ("P1","P2" or "P3") can be provided. |
|||||||||
| [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). The effective from date (the low sub-element) must not be in the future. |
|||||||||
| [1..1] [M] 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:
|
|||||||||
| [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] assignedEntity (AssignedEntity) |
A link to details of the organisation or health care professional which is the performer of the patient care provision. |
|||||||||
| [0..1] subjectOf1 |
A heading to indicate that the PatientCareProvision is the subject of the system generated effective dates for this data. These system generated effective dates will be in the form of a range, and will be provided with primary care data but is not relevant to pharmacy data. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="SUBJ" } |
Indicates that this a Subject actRelationship.
|
|||||||||
| [1..1] systemEffectiveDate (SystemEffectiveDate) |
A link to the System Generated Effective date. |
|||||||||
| [0..1] subjectOf2 |
A heading to indicate that the PatientCareProvision is the subject of the source of this data. The source of this data is provided with primary care data but is not relevant to pharmacy data.
This link is only present where the historic data indicator was set to 1 (Retrieve all historic information) in the Retrieval
Query message to which this is a response. Where the historic data indicator was set to 0 (No history required), this link
will not be present.
|
|||||||||
| [1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="SUBJ" } |
Indicates that this a Subject actRelationship.
|
|||||||||
| [1..1] source (Source) |
A link to the source of the data. |
|||||||||
| Source |
Parent class containing details of an observation about a piece of data, specifically the system that was the source of the
data.
|
|||||||||
| Used by: PatientCareProvisionEvent | ||||||||||
| [1..1] either : SourceIdentified |
This class should be used if the source system takes the form of an identifier. |
|||||||||
| ... or ... : SourceCoded |
This class should be used if the source system takes the form of a National System code. |
|||||||||
| SourceIdentified |
Parent class containing details of a source system, when it takes the form of an identifier.
|
|||||||||
| Used by: PatientCareProvisionEvent,RelatedPersonRole,ClinicalDocumentEvent,ServiceDeliveryLocation,Source | ||||||||||
| [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:AdministrativeObservationType } ) { Fixed="01" } |
Indicates the type of observation. In this case, the observation is that of a source system. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| [1..1] [M] value (II) |
The source system. This will be one of:
The Identifier External datatype flavour is used to carry this information as follows: If it is a SDS Accredited System Identifier (ASID):
If it is a NHS Directory Services Organisation Code:
|
|||||||||
| SourceCoded |
Parent class containing details of a source system, when it takes the form of a National System code. |
|||||||||
| Used by: PatientCareProvisionEvent,RelatedPersonRole,ClinicalDocumentEvent,ServiceDeliveryLocation,Source | ||||||||||
| [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:AdministrativeObservationType } ) { Fixed="01" } |
Indicates the type of observation. In this case, the observation is that of a source system. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| [1..1] [M] value (CV {CNE:NationalSystemCode } ) |
A code identifying the National System. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| SystemEffectiveDate |
A heading for system generated effective dates for this data item.
|
|||||||||
| Used by: PatientCareProvisionEvent,RelatedPersonRole,ServiceDeliveryLocation,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:AdministrativeObservationType } ) { Fixed="02" } |
Indicates the type of observation about system generated effective dates, for the data item over a period of time. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| [1..1] [M] value (IVL<TS>) |
System generated effective dates for this data item as a range, supplied in the Low and High attributes of the IVL_TS. For
current data, only the Low attribute will be set. Only returned when history or future data is returned.
|
|||||||||
| AssignedEntity |
The entity 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 entity acting as health care provider. This will be one of:
The Identifier External datatype flavour is used to carry this information as follows:
If it is a GP Practice Code or National Pharmacy Code:
A national GP code is carried in the following way:
|
|||||||||
| RelatedPersonRole |
Details of people related to the patient. These may be proxy, legal guardian, or family/close contact type relationships. |
|||||||||
| Used by: Person | ||||||||||
| [1..1] [M] classCode (CS {CNE:x_RelatedPerson } ) |
Indicates the type of related person role. The Coded Only datatype flavour is used to carry this information as follows:
|
|||||||||
| [1..1] [M] code (CV {CNE:PersonRelationshipType } ) |
Indicates further typing of the related person within the overall related person role, i.e. the type of agent (proxy), guardian or personal relationship. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| [0..1] effectiveTime (IVL<TS>) |
The time period in which the relationship was 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. |
|||||||||
| [1..1] [M] id (II) |
A unique identifier for the related person details. This identifier is allocated by the PDS. The Identifier External datatype flavour is used to carry this information as follows:
|
|||||||||
| [0..1] positionNumber (INT) |
The order in which contact should normally be made with the related person. (Also known as contact ranking.) The value should be in the range 1-99. |
|||||||||
| [0..1] player (RelatedPerson) |
A link to details of the person playing the role of related person. |
|||||||||
| [0..1] part3 |
A heading to a role that is a Part of this role. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:RoleLinkType } ) { Fixed="PART" } |
Indicates that the role of being a next of kin is a part of the role of being a related person.
|
|||||||||
| [1..1] partNextOfKin (NextOfKin) |
A link providing details about a related person having a part of their role as a next of kin.
|
|||||||||
| [0..1] part4 |
A heading to a role that is a Part of this role. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:RoleLinkType } ) { Fixed="PART" } |
Indicates that this is a Part role link. |
|||||||||
| [1..1] partCorrespondence (Correspondence) |
A link to details of the correspondence status of the related person. |
|||||||||
| [0..1] subjectOf1 |
A heading for indicating that the related person is the subject of the associated preferred contact method. This preferred contact method may be present where an NHS number for the related person is not present, and shall not be present where an NHS number for the related person is present. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this a Subject participation.
|
|||||||||
| [1..1] preferredContactMethod (PreferredContactMethod) |
A link to the preferred contact method. |
|||||||||
| [0..1] subjectOf2 |
A heading for indicating that the related person is the subject of the associated preferred written communication format information. The related persons preferred written communication format may be present where a NHS number for the related person is not present, and shall not be present where a NHS number for the related person is present. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this a Subject participation.
|
|||||||||
| [1..1] preferredWrittenCommunicationFormat (PreferredWrittenCommunicationFormat) |
A link to the preferred written communication format. |
|||||||||
| [0..1] subjectOf3 |
A heading indicating that the related person is the subject of the call centre call-back. This is only relevant where the role type is AGNT (Agent - used for Proxies). |
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this a Subject participation.
|
|||||||||
| [1..1] callCentreCallBackConsent (CallCentreCallBackConsent) |
A link to the consent status for call centre call-back. |
|||||||||
| [0..1] subjectOf4 |
A heading to indicate that the related person is the subject of the source of this data. This link is only present where the historic data indicator was set to 1 (Retrieve all historic information) in the Retrieval Query message to which this is a response. Where the historic data indicator was set to 0 (No history required), this link will not be present. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this a Subject participation.
|
|||||||||
| [1..1] relatedPersonRoleSource (RelatedPersonRoleSource) |
A link to the source of the data. |
|||||||||
| [0..1] subjectOf5 |
A heading for indicating that the RelatedPersonRole is the subject of the system generated effective date.
This link is only present where the historic data indicator was set to 1 (Retrieve all historic information) in the Retrieval
Query message to which this is a response. Where the historic data indicator was set to 0 (No history required), this link
will not be present.
|
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this a Subject participation.
|
|||||||||
| [1..1] systemEffectiveDate (SystemEffectiveDate) |
A link to the system generated effective dates. |
|||||||||
| RelatedPerson |
Parent class linking to and containing information about a related person which is specific to the person. |
|||||||||
| Used by: RelatedPersonRole | ||||||||||
| [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] languageCommunication (LanguageCommunication) | ||||||||||
| [0..1] playedRelatedPatient (RelatedPatient) |
A link to details of the related person when playing the role of patient. |
|||||||||
| [0..*] scopedRole3 [CMET: COCT_MT000202UK02] |
A link to a CMET representing a telecommunication address, when additional administrative information about the telecommunication
address needs to be supplied.
This may be present where an NHS number for the related person is not present, and shall not be present where an NHS number for the related person is present. |
|||||||||
| [0..1] scopedRole4 [CMET: COCT_MT000201UK02] |
A link to a CMET representing an address when additional additional information about the address needs to be supplied. This may be present where an NHS number for the related person is not present, and shall not be present where an NHS number for the related person is present.
Note
The use attribute of the AD datatype in the CMET describes the use made of the address, and will always be "H" - Usual Address
in this case. |
|||||||||
| [0..1] scopedRole5 [CMET: COCT_MT000203UK02] |
A link representing a name of a person, related to the patient, when additional administrative information about the name needs to be supplied. This may be present where an NHS number for the related person is not present, and shall not be present where an NHS number for the related person is present. Note This will be usual name only (the use attribute of the PN dataType in the CMET is restricted to "L" (Usual) for the RetrievePatientResponse messages). |
|||||||||
| RelatedPatient |
Details of the related person when playing a role of patient. |
|||||||||
| Used by: RelatedPerson | ||||||||||
| [1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="PAT" } |
Indicates that this is a Patient role.
|
|||||||||
| [1..1] [M] id (II) |
The current NHS number of the patient. This will only be the new style NHS number. The Identifier External datatype flavour is used to carry this information as follows for the new style NHS number:
|
|||||||||
| LanguageCommunication |
Parent class containing details of a person's language preferences, where the preferred language is not English. |
|||||||||
| Used by: RelatedPerson | ||||||||||
| [1..1] [M] languageCode (CS {CNE:HumanLanguage } ) |
The Coded Only datatype flavour is used to carry this information as follows:
|
|||||||||
| [1..1] [M] preferenceInd (BL) |
This identifies the patient's preferred language, always 1 ("true") in this case. |
|||||||||
| [1..1] [M] proficiencyLevelCode (CV {CNE:InterpreterRequiredIndicator } ) |
Indicates whether an interpreter is required for this person. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| CallCentreCallBackConsent |
Details of a person's consent status for call centre call-back. |
|||||||||
| Used by: RelatedPersonRole | ||||||||||
| [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 } ) { Fixed="6" } |
A code to indicate the type of consent. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| [1..1] [M] value (CV {CNE:Consent } ) |
The value of the consent status.
|
|||||||||
| PreferredContactMethod |
Details of a person's preferred contact method. |
|||||||||
| Used by: RelatedPersonRole,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="9" } |
Indicates the type of observation. In this case, the observation is that of a person's preferred contact method. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| [0..1] value (CV {CNE:PreferredContactMethod } ) |
The value of the preferred contact method. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| [0..1] pertinentInformation |
A heading for providing a link to information which is pertinent in some unspecified way. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="PERT" } |
Indicates that this a Subject actRelationship.
|
|||||||||
| [1..1] pertinentPreferredContactTimes (PreferredContactTimes) |
A link to details of the person's preferred contact times.
|
|||||||||
| PreferredContactTimes |
Details of a person's preferred contact times. |
|||||||||
| Used by: PreferredContactMethod | ||||||||||
| [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="10" } |
Indicates the type of observation. In this case, the observation is that of a person's preferred contact times. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| [1..1] [M] value (ST) |
Text describing preferred contact times, e.g. "Evenings Only". |
|||||||||
| PreferredWrittenCommunicationFormat |
Details of the person's preferred written communication format. |
|||||||||
| Used by: RelatedPersonRole,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="13" } |
Indicates the type of observation. In this case, the observation is that of the person's preferred written communication format.
The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| [1..1] [M] value (CV {CNE:PreferredWrittenCommunicationFormat } ) |
The preferred written communication format. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| RelatedPersonRoleSource |
Parent class containing details of an observation about a piece of data, specifically the system that was the source of the data. |
|||||||||
| Used by: RelatedPersonRole | ||||||||||
| [1..1] either : SourceIdentified |
This class should be used if the source system takes the form of an identifier |
|||||||||
| ... or ... : SourceCoded |
This class should be used if the source system takes the form of a National System code. |
|||||||||
| Correspondence |
A heading for providing details about a person related to the patient having part of their a role as a contact. |
|||||||||
| Used by: RelatedPersonRole | ||||||||||
| [1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="CON" } |
Indicates that this is an Observation act.
|
|||||||||
| [1..1] [M] code (CV {CNE:CorrespondenceCode } ) { Fixed="1" } |
This is only used to indicate that correspondence should be copied to the person related to the patient. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| NextOfKin |
Details of a next of kin role |
|||||||||
| Used by: RelatedPersonRole | ||||||||||
| [1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="NOK" } |
Indicates that this is a Next Of Kin role.
|
|||||||||
| [1..1] [M] code (CV {CNE:NOKCode } ) { Fixed="1" } |
This is only used to indicate that the person related to the patient is a next of kin in coded form. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| NHAISRegistrationEvent |
Information relating to the registration of a patient's details onto an NHAIS system. |
|||||||||
| 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:
|
|||||||||
| [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. |
|||||||||
| [1..1] [M] custodian |
A link to the Custodian of this Registration act.
|
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="CST" } |
Indicates that this is a Custodian participation.
|
|||||||||
| [1..1] [M] assignedDevice (AssignedDevice) |
A link to the assigned device. |
|||||||||
| 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.
|
|||||||||
| 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:
|
|||||||||
| [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 |
|||||||||
| [0..1] id (II) |
A unique identifier for the object. This identifier is allocated by the PDS, and will be optional unless a paper record transfer
flag is supplied.
|
|||||||||
| [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:
|
|||||||||
| [0..*] 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) |
A link to details of a location where the paper medical record should be stored. |
|||||||||
| [0..1] subjectOf1 |
A heading for indicating that the ClinicalDocumentEvent is the subject of the associated source of the data.
This link is only present where the historic data indicator was set to 1 (Retrieve all historic information) in the Retrieval
Query message to which this is a response. Where the historic data indicator was set to 0 (No history required), this link
will not be present.
|
|||||||||
| [1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="SUBJ" } |
Indicates that this a Subject actRelationship. |
|||||||||
| [1..1] clinicalDocumentEventSource (ClinicalDocumentEventSource) |
A link to the source of this data. |
|||||||||
| [0..1] subjectOf2 |
A heading for indicating that the ClinicalDocumentEvent is the subject of the associated system generated effective date. This link is only present where the historic data indicator was set to 1 (Retrieve all historic information) in the Retrieval Query message to which this is a response. Where the historic data indicator was set to 0 (No history required), this link will not be present. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="SUBJ" } |
Indicates that this a Subject actRelationship.
|
|||||||||
| [1..1] systemEffectiveDate (SystemEffectiveDate) |
A link to the System Generated Effective date. |
|||||||||
| [0..1] subjectOf3 |
A heading describing the link to an Observation that this act is the subject of. |
|||||||||
| [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. Note: This must be present if a paper record tracking UID (ClinicalDocumentEvent.id) is provided. |
|||||||||
| 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:
|
|||||||||
| [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:
|
|||||||||
| ClinicalDocumentEventSource |
Parent class containing details of an observation about a piece of data, specifically the system that was the source of the data. |
|||||||||
| Used by: ClinicalDocumentEvent | ||||||||||
| [1..1] either : SourceIdentified |
This class should be used if the source system takes the form of an identifier. |
|||||||||
| ... or ... : SourceCoded |
This class should be used if the source system takes the form of a National System code. |
|||||||||
| 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. |
|||||||||
| [1..1] [M] 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:
|
|||||||||
| [1..1] [M] location (BackOffice) |
A link to details of the back office location. |
|||||||||
| [0..1] subjectOf1 |
A heading for indicating that the Service Delivery Location role is the subject of the system generated effective date. This link is only present where the historic data indicator was set to 1 (Retrieve all historic information) in the Retrieval Query message to which this is a response. Where the historic data indicator was set to 0 (No history required), this link will not be present. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this a Subject participation. |
|||||||||
| [1..1] systemEffectiveDate (SystemEffectiveDate) |
A link to the system generated effective dates. |
|||||||||
| [0..1] subjectOf2 |
A heading to indicate that the Service Delivery Location role is the subject of the source of this data. This link is only present where the historic data indicator was set to 1 (Retrieve all historic information) in the Retrieval Query message to which this is a response. Where the historic data indicator was set to 0 (No history required), this link will not be present. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:SBJ } ) |
Indicates that this a Subject participation.
|
|||||||||
| [1..1] serviceDeliveryLocationSource (ServiceDeliveryLocationSource) |
A link to the source of the data. |
|||||||||
| 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 Entity is a place. |
|||||||||
| [1..1] [M] determinerCode (CS {CNE:EntityDeterminer } ) { Fixed="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). |
|||||||||
| ServiceDeliveryLocationSource |
Parent class containing details of an observation about a piece of data, specifically the system that was the source of the data. |
|||||||||
| Used by: ServiceDeliveryLocation | ||||||||||
| [1..1] either : SourceIdentified |
This class should be used if the source system takes the form of an identifier. |
|||||||||
| ... or ... : SourceCoded |
This class should be used if the source system takes the form of a National System code. |
|||||||||
| NHAISRemovalRegistrationEvent |
Information relating to the removal of a patient's details from an NHAIS system. |
|||||||||
| 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:
|
|||||||||
| [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. |
|||||||||
| [1..1] [M] reasonCode (CV {CNE:NHAISRemovalReasonCode } ) |
The reason for removal. The Coded with Code System datatype flavour is used to carry this information as follows:
The Value X in the NHAISRemovalReasonCode vocabulary has some additional rules with regard to retrieving this data.
If the source system is DSA, the full removal type is returned, otherwise only X= "No current NHAIS Posting" is returned where
relevant.
|
|||||||||
| SharedSecret |
Details of the patient's shared secret. |
|||||||||
| 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="15" } |
Indicates the type of observation. In this case, the observation is that of the patient's shared secret. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| [1..1] [M] value (ST) |
The patient's shared secret, also known as certificate text, is a string of encrypted characters. |
|||||||||
| 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 act.
|
|||||||||
| [1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" } |
Indicates that this is an Event
|
|||||||||
| [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:
|
|||||||||
| [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:
|
|||||||||
| Consent |
Details of a person's consent status for care record sharing or call centre call-back. |
|||||||||
| 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:
|
|||||||||
| [0..1] effectiveTime (TS) |
The date the consent value last changed. Shall be present where the type of consent is "4" (Consent to NHS Care Record sharing), and must not be present otherwise. The Date Only datatype flavour is used to carry this information as follows:
|
|||||||||
| [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:
|
|||||||||
| 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:
|
|||||||||
| [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:
|
|||||||||
| HealthspaceRegistration |
Details of the patient's registration status with HealthSpace. |
|||||||||
| 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="8" } |
Indicates the type of observation. In this case, the observation is that of the HealthSpace registration status of the patient. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| [1..1] [M] value (CV {CNE:HealthspaceRegistration } ) |
The value of the HealthSpace registration status. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| SupercededId |
A heading for providing details about previous NHS Numbers the patient may have had.
|
|||||||||
| Used by: PatientRole | ||||||||||
| [1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="PAT" } |
Indicates that this is a Patient role.
|
|||||||||
| [0..1] effectiveTime (IVL<TS>) |
To provide the System Effective Date interval during which the superceded ID was effective. The Interval of Points in Time flavor is used to carry this information as follows:
|
|||||||||
| [1..1] [M] id (II) |
The current NHS number of the patient. This will be one of:
The Identifier External datatype flavour is used to carry this information as follows: If it is an NHS Number:
If it is an Old Format or Temporary NHS Number:
|
|||||||||