| PRPA_RM000207UK02 | ||||||||||
| PdsTraceMatch |
Parent class linking to details returned in the Advanced Trace 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. Historic data may optionally also be searched, and/or returned. Current and future dated data is always returned. Multiple matching records may be returned, along with a MatchingLevel (this will only be populated for an algorithmic search) for each match, indicating the confidence of the match. |
|||||||||
| 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..*] [M] subject |
A heading for the Subject of this Observation Event.
|
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this a Subject participation.
|
|||||||||
| [1..1] [M] patientRole (PatientRole) |
A link to providing details about the patient. |
|||||||||
| 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..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 providing information about the person who is the identified patient. |
|||||||||
| [0..1] subjectOf1 |
A heading for indicating that the patient is the subject of the associated matching level, where a match is found. Note: The matching level will only be populated for an algorithmic search |
|||||||||
| [1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="SBJ" } |
Indicates that this a Subject participation.
|
|||||||||
| [1..1] matchingLevel (MatchingLevel) |
A link that provides information about whether the current details of patient have been matched.
|
|||||||||
| [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 this a Subject participation.
|
|||||||||
| [1..1] previousNhsContact (PreviousNhsContact) |
A link that provides 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 this a Subject participation.
|
|||||||||
| [1..1] deathNotification (DeathNotification) |
A link that provides 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..*] playedOtherProviderPatient (OtherProviderPatient) |
A link to information about the patient while in the care of a primary care organization |
|||||||||
| [0..*] scopedRole1 [CMET: COCT_MT000201UK02] |
A link to a CMET representing zero to many addresses, where additional additional information about the address needs to be supplied. Current and Future dated data is always returned, and for the System generated effective date of such data, only the Low attribute will be set. History is only returned when historicDataIndicator is set to "1" (in the Advanced Trace Request). |
|||||||||
| [0..*] scopedRole2 [CMET: COCT_MT000202UK02] |
A link to a CMET representing zero to many telecommunication address, where additional administrative information about the
telecommunication address needs to be supplied.
Current and future dated data is always returned, and historic data is only returned if the historicDataIndicator was set to "1" (in the Advanced Trace Request). |
|||||||||
| [0..*] scopedRole3 [CMET: COCT_MT000203UK02] |
A link to a CMET representing zero to many names of a person, where additional administrative information about the name needs
to be supplied.
Current and future dated data is always returned, and historic data is only returned if the historicDataIndicator was set to "1" (in the Advanced Trace Request). |
|||||||||
| 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 a Subject participation.
|
|||||||||
| [1..1] [M] patientCareProvision (PatientCareProvision) |
A link to details of patient care provision given by a health care provider. |
|||||||||
| PatientCareProvision |
Parent class linking to and containing information about a GP or primary care organisation responsible for a patient over a period of time. Current data is always returned. History is only returned when historicDataIndicator in Advanced Trace Query is set to "1" |
|||||||||
| 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 } ) { Fixed="1" } |
Indicates the type of patient care provision. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| [0..1] effectiveTime (IVL<TS>) |
The effective dates for the care provision relationship represented as a range, supplied in the low and high sub-elements. Both the low and high sub-elements are optional, allowing open-ended ranges to be specified. The effective from date (the low sub-element) must not be in the future. |
|||||||||
| [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. |
|||||||||
| [0..1] subjectOf1 |
A heading to indicate that the PatientCareProvision is the subject of the source of this data. |
|||||||||
| [1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="SUBJ" } |
Indicates that this is a Subject relationship.
|
|||||||||
| [1..1] source (Source) |
A link to the Source of the PatientCareProvision data. |
|||||||||
| [0..1] subjectOf2 |
A heading to indicate that the PatientCareProvision is the subject of the system generated effective dates for this data. This link is only present where the historic data indicator was set to 1 (Retrieve all historic information) in the Advanced Trace 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 is a Subject relationship.
|
|||||||||
| [1..1] systemEffectiveDate (SystemEffectiveDate) |
A link to the system generated effective dates of the PatientCareProvision 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: PatientCareProvision | ||||||||||
| [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: PatientCareProvision,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: PatientCareProvision,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 |
Parent class containing details of an observation about a piece of data, specifically the times for which the data is / was
effective on the system.
|
|||||||||
| Used by: PatientCareProvision | ||||||||||
| [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 pertaining to the Primary Care
organisation, or the GP responsible for a patient 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 and future dated data, only the Low attribute will be set. Only returned when history or future data is returned.
|
|||||||||
| 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 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:
|
|||||||||
| MatchingLevel |
A heading for providing information about the matching level.
|
|||||||||
| 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="12" } |
To provide the type of observation in coded form. In this context, the type of observation is an observation of the matching level. The Coded with Code System datatype flavour is used to carry this information as follows:
|
|||||||||
| [1..1] [M] value (PQ) |
To provide a value for the Matching Level, i.e. the level of confidence in the match expressed as a percentage, to 2 decimal places. This will only be populated for an algorithmic search. The Physical Quantity datatype 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:
|
|||||||||