PdsRetrievalQuery - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
QUPA_RM000003UK02
Query
A heading for providing information about the query, in this case, a request to find a Service User record on the PDS and retrieve data from it.
Used by:
[1..1] [M] historicDataIndicator (HistoricDataIndicator)
A heading for providing information about the historicDataIndicator parameter. The historicDataIndicator parameter shall occur one time to indicate whether or not historic data relating to the retrievalItem parameters is required to be returned in the response to the query.
[1..1] [M] person.id (Person.id)
A heading for providing information about the perspn.id parameter.

The person.id parameter shall exactly once.
[0..*] retrievalItem (RetrievalItem)
A heading for providing information about the person identifier parameter.

The person identifier parameter may occur zero or one time providing an identifier of the person being searched for.
Person.id
A heading for providing information about the person identifier parameter.

The person identifier parameter may occur zero or one time providing an identifier of the person being searched for.
Used by: Query
[1..1] [M] semanticsText (ST) { Fixed="Person.id" }
A literal text string identifying the parameter item.
[1..1] [M] value (II)

To provide the value of the parameter item (identified in the associated semanticsText element) to be searched.

In this context, the value element provides an identifier of the person that is to be searched for. This identifier will be one of:

  • NHS number;
  • Temporary NHS number issued by an NHAIS registration authority;
  • Old format NHS number.

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

A NHS number is carried in the following way:

  • The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.4.1";
  • The extension attribute will contain the NHS number itself.

A Temporary NHS number issued by an NHAIS registration authority or an old format NHS number 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.3";
  • The extension attribute will contain the Temporary NHS number issued by an NHAIS registration authority or the old NHS number itself.
HistoricDataIndicator
A heading for providing information about the historicDataIndicator parameter. The historicDataIndicator parameter shall occur one time to indicate whether or not historic data relating to the retrievalItem parameters is required to be returned in the response to the query.
Used by: Query
[1..1] [M] semanticsText (ST) { Fixed="HistoricDataIndicator" }
A literal text string identifying the parameter item.
[1..1] [M] value (CV {CNE:HistoricDataIndicator } )

To provide the value of the parameter item (identified in the associated semanticsText element) to be searched.

In this context, the value element provides a code to indicate whether or not historic data relating to the retrievalItem parameters is required to be returned in the response to the query.

When set to "1", the history is returned for the following items:

  • Named
  • Address
  • Telecom
  • Relationship
  • CareProvider
  • SupersededIds (Effective To dates only)

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 HistoricDataIndicator vocabulary;
  • The codeSystem attribute will contain the OID referenced in the HistoricDataIndicator vocabulary.

NB: Where a PDS Retrieval Query message is part of a batch of PDS Retrieval Query messages, only value "0" (No history required) shall be used.

RetrievalItem
A heading for providing information about the retrievalItem parameter.The retrievalItem parameter shall occur zero, one or many times, each occurrence present identifying a data item / group of data items to be retrieved.Where no retrievalItem parameters are provided, just the Serial Change Number shall be retrieved.
Used by: Query
[1..1] [M] semanticsText (ST)

A literal text string identifying the item to be retrieved.

The following literal text strings shall be used to identify the data items/groups of data that are to be retrieved:

  1. "supercededId" (all previous or superceded nationally recognised identifiers);
  2. "person.nameUsual" (current usual name);
  3. "person.nameOther" (previous/alias/preferred names);
  4. "person.otherDemographics" (birth date/death date/status of death notification/sex/delivery time/birth order);
  5. "consent" (Consent to NHS Care Record sharing/date last changed);
  6. "person.confidentiality" (Sensitivity information status/reason for removal/previous NHS contact);
  7. "callCentreData" (call centre call-back consent/shared secret);
  8. "person.addressTelecom" (usual addresses/temporary addresses/correspondence addresses/telecommunication contact details);
  9. "person.misc" (preferred language/interpreter required/preferred contact method/preferred contact times/preferred communication format/healthspace);
  10. "pharmacy" (all pharmacy details);
  11. "guardian" (all legal guardian details);
  12. "proxy" (all proxy details);
  13. "personalRelationship" (all family/close contacts details);
  14. "primaryCare" (primary care registration information);
  15. "person.fullDemographics" (all of 1-6 above);
  16. "person.allData" (all person data);
  17. "person.placeOfBirth" (Place of Birth);
  18. "person.reasonForRemoval" (Reason for Removal related data);
  19. "paperRecordTracking" (Details the location of the patients Paper Records);
  20. "nhaisPosting" (NHAIS Posting data)

NOTE: when DSA or NHAIS is retrieving person.reasonForRemoval, they get back the actual value (or nothing if there is a null value), but when other systems are retrieving person.reasonForRemoval, they get back value X (or nothing if there is a null value).