| QUSC_RM000002UK01 | ||||||||||
| QueryByParameter |
A heading for providing information about the query, in this case a
request to Choose and Book for details about a specific referral. | |||||||||
| Used by: | ||||||||||
| [0..1] enquirerNHSNumber (EnquirerNHSNumber) |
A heading for providing information about the NHS number of the patient
making the request. This value is only provided if the enquirer is a
patient. | |||||||||
| [0..1] enquirerRoleProfileCode (EnquirerRoleProfileCode) |
A heading for providing information about the Enquirer Role Profile Code the role profile code of the user making the request, if the user is a
professional user. | |||||||||
| [1..1] patientNHSNumber (PatientNHSNumber) |
A heading for providing information about the Patient NHS number, A
number used to identify a person uniquely within the NHS in England and
Wales.
This parameter value is mandatory and must contain a value. | |||||||||
| [1..1] uBRN (UBRN) |
The unique reference of the referral or advice and guidance request about
which the requestor would like more information. The UBRN is mandatory and must be present in order to make a detailed referral query. | |||||||||
| [0..1] clinicalInformationRequired (clinicalInformationRequired) |
A Boolean value indicating whether the person carrying out the query has
requested clinical information to be returned with the response.
If the requesting party does not have the authority to view the requested clinical information, the response will contain an error. | |||||||||
| EnquirerNHSNumber |
A heading for providing information about the NHS number of the patient
making the request. This value is only provided if the enquirer is a
patient. | |||||||||
| Used by: QueryByParameter | ||||||||||
| [1..1] value (II) |
To provide the value of the parameter item (identified in the associated
semanticsText element) to be searched. An NHS Number for the enquirer must always be provided when the enquirer is a patient. If provided, normally this will be the same as the patient's NHS number but in the case of a proxy acting on behalf of a patient, it will be different.
As with PatientNHSNumber, the Identifier External datatype flavour is used to carry this information
as follows:-
| |||||||||
| [1..1] semanticsText (ST) |
A literal text string identifying the parameter item. | |||||||||
| EnquirerRoleProfileCode |
A heading for providing information about the Enquirer Role Profile Code
the role profile code of the user making the request, if the user is a
professional user. | |||||||||
| Used by: QueryByParameter | ||||||||||
| [1..1] value (II) |
To provide the value of the parameter item (identified in the associated
semanticsText element) to be searched.
The role profile code of the user making the request, is required to check if the requester is authorised to request information about referrals. The role profile code is an SDS identifier that uniquely identifies the role profile of the person. This is carried in the following way:
| |||||||||
| [1..1] semanticsText (ST) |
A literal text string identifying the parameter item. | |||||||||
| PatientNHSNumber |
A heading for providing information about the Patient NHS number, A
number used to identify a person uniquely within the NHS in England and
Wales. This parameter value is mandatory and must contain a value. | |||||||||
| Used by: QueryByParameter | ||||||||||
| [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 NHS number of the patient about whom the request is being made. This identifier will be:
A NHS number is carried in the following way:
| |||||||||
| [1..1] semanticsText (ST) |
A literal text string identifying the parameter item. | |||||||||
| UBRN |
The unique reference of the referral or advice and guidance request about
which the requestor would like more information. The UBRN is mandatory and must be present in order to make a detailed referral query. | |||||||||
| Used by: QueryByParameter | ||||||||||
| [1..1] value (II) |
To provide the value of the parameter item (identified in the associated
semanticsText element) to be searched. This identifier is unique within
the Choose and Book service. It identifies the Unique Booking Reference Number (UBRN)
allocated to the requested service that the appointment is fulfilling.
| |||||||||
| [1..1] semanticsText (ST) |
A literal text string identifying the parameter item. | |||||||||
| clinicalInformationRequired |
A Boolean value indicating whether the person carrying out the query has
requested clinical information to be returned with the response.
If the requesting party does not have the authority to view the requested clinical information, the response will contain an error. | |||||||||
| Used by: QueryByParameter | ||||||||||
| [1..1] value (BL) |
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 true or false value indicating whether the user has requested clinical information about the referral. The default value for this attribute is false. If true and the user is authorised then clinical information will be returned in the response in addition to the admin information that is returned by default. | |||||||||
| [1..1] semanticsText (ST) |
A literal text string identifying the parameter item. | |||||||||