PRPA_RM000209UK01 | ||||||||||
PdsTraceMatch |
Parent class linking to details returned in the query response. As well as confirming that the NHS number 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] 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. |
|||||||||
PatientRole |
Parent class linking to and containing information about a patient.
|
|||||||||
Used by: PdsTraceMatch | ||||||||||
[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:
This means that the address will contain the following components:
|
|||||||||
[0..1] confidentialityCode (CV {CNE:InformationSensitivity } ) |
To indicate the nature of any sensitive information about the patient in coded form. The Coded with Code System datatype flavour is used to carry this information as follows:
Only values "B", "S" and "Y" are returned by Batch Trace, where:
|
|||||||||
[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:
|
|||||||||
[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:
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:
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, current and future telecommunication numbers to be distinguished. These effective dates are indicated, in the following way:
|
|||||||||
[0..1] patientPerson (Person) |
A link to details of the person playing the role of patient.
|
|||||||||
[0..1] subjectOf2 |
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. |
|||||||||
[1..1] previousNhsContact (PreviousNhsContact) |
A heading for providing information about whether the patient has had previous NHS contact.
|
|||||||||
[0..1] subjectOf3 |
A heading for indicating that the patient is the subject of the associated death notification. This shall be present where the patient's death date/time is given in the person.deceasedTime field. This shall not be present where the person.deceasedTime field is not present. |
|||||||||
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that the patient is the subject of the associated death notification. |
|||||||||
[1..1] deathNotification (DeathNotification) |
A heading for providing information about a death notification. |
|||||||||
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..*] 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:
|
|||||||||
[0..*] playedOtherProviderPatient (OtherProviderPatient) |
A heading for providing details about the patient when associated with other providers, such as the patient's registered GP/GP Practice. |
|||||||||
OtherProviderPatient |
Parent class linking to information about the patient while in the care of other providers. |
|||||||||
Used by: Person | ||||||||||
[1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="PAT" } |
Indicates that this is a Patient role. |
|||||||||
[1..1] [M] subjectOf |
A link to a PatientCareProvision that this role is the subject of. |
|||||||||
[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this is a Subject participation. |
|||||||||
[1..1] [M] patientCareProvision (PatientCareProvision) |
A link to details of patient care provision given by a health care provider. |
|||||||||
PatientCareProvision |
A heading for defining a relationship between a patient and his/her primary care provider (registered GP / GP Practice). Note Current and future dated will always be returned and that historic data will also be returned where an advanced trace was performed. If a cross-check trace is invoked and is successful, historic data will not be returned. |
|||||||||
Used by: OtherProviderPatient | ||||||||||
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="PCPR" } |
Indicates that this is a patient care provision. |
|||||||||
[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" } |
Indicates that this is a defined patient care provision event which has occurred. |
|||||||||
[1..1] [M] code (CV {CNE:PatientCareProvisionType } ) { Fixed="1" } |
Indicates the type of patient care provision.
|
|||||||||
[0..1] effectiveTime (IVL<TS>) |
To provide a date interval during which the patient care provision was effective. The Date Only 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 which is the performer of the patient care provision.
|
|||||||||
AssignedEntity |
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 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:
A national GP code is carried in the following way:
|
|||||||||
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. |
|||||||||
[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:
|
|||||||||
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.
|
|||||||||
[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:
|
|||||||||