PdsRetrievalQuery - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
QUPA_RM030000UK30
ControlActEvent

The Control Act carries administrative information related to the "controlled act" that is being communicated in the message.

Used by:
[1..1] classCode (CS {CNE:CACT} ){ Fixed="CACT " }

Indicates that this is a control act.

  • Fixed value: "CACT" (Control act)

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

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

Indicates that this is an event which has occurred.

  • Fixed value: "EVN"

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

[0..1] author

A participation referring to a person who is logged in at the time the message is initiated. 

The participation is optional. It shall be present when the message is initiated by a person. It shall not be present when the message is automatically initiated by a system.

[1..1] typeCode (CS {CNE:AUT} ){ Fixed="AUT " }

Defines the type of participation of the linked party to the PDS registration, i.e. that the linked party is the author.

  • Fixed value: "AUT" (Author [originator])

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

[1..1] participant      [CMET: UKCT_MT120901UK01]

NPfIT CMET to identify a person fulfilling a specific role where the Person, Role Profile and Job Role are all mandatory. Full details of the person, role profile and job role are available from SDS.

In this context the person is the signed in user for the user session responsible for initiating the message.

[1..2] author1

A participation referring to one or more systems that are involved in the initiation of the message.

One instance of the participation is mandatory and shall carry the accredited service id of the system in use at the time the message is initiated.

One instance of the participation is optional and may carry the workstation id of the system being used by the logged in user at the time the message is initiated.

[1..1] typeCode (CS {CNE:AUT} ){ Fixed="AUT " }

Defines the type of participation of the linked party to the PDS registration, i.e. that the linked party is the author.

  • Fixed value: "AUT" (Author [originator])

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

[1..1] participant      [CMET: UKCT_MT121001UK01]

NPfIT CMET to identify a mandatory system which could be software or hardware. Full details of the system are available from SDS.

In this context the system is a system in use at the time the message is initiated.

[1..1] query (Query)

A heading for providing information about the query.

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: ControlActEvent
[1..1] 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] person.id (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.

[0..*] retrievalItem (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.

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] value (CV {CWE: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.

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.

[1..1] semanticsText (ST)

A literal text string identifying the parameter item.

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] 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.
[1..1] semanticsText (ST)

A literal text string identifying the parameter item.

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] 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/supplementary comments;
  6. "person.confidentiality" (sensitivity information status/no current NHAIS posting/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).