Request Service - tabular view

No Current Link To VocabularyCoded With Extensions
PRPA_RM010000UK04
RequestService

The Request Service represents a request for a service from a service requester to the eBooking Service.

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

Indicates that this is a patient care provision.

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

Indicates that this is a request.

  • Fixed value "EVN"
[1..1] id (II)

A unique identifier for this instance of a service request. 

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

  • A UUID is held in the root attribute

 Example

<id root="BBBBE23A-A9D1-A411-F824-9F7A00A33757"/>

[1..1] effectiveTime (TS)

The date and time that the request service was made.

[1..1] priorityCode (CV {CNE:PriorityType} )

A code specifying the level of urgency attributed to the request.

The Coded Only datatype flavour is used to carry this information as follows:

  • The code attribute will contain a value from the list of codes in the PriorityType vocabulary;
  • The codeSystem attribute will contain the OID referenced in the PriorityType vocabulary
  • The code attribute shall default to "1", Routine

Example

<code="3" codeSystem="2.16.840.1.113883.2.1.3.2.4.17.95"/>

[1..1] subject

Refers to the patient for whom this service is being requested.

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

Indicates that the role is the subject of the request.

  •  Fixed value "SBJ"
[1..1] patient (Patient)

Information about the patient who is the subject.

[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 " }

Indicates that the role has author responsibility.

  • Fixed value: "AUT"
[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.

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

Indicates that the role has author responsibility.

  • Fixed value: "AUT"
[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.

Patient

Details about the patient.

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

Indicates that the role is that of a patient.

  • Fixed value "PAT"
[1..1] id (II)

To provide the current nationally recognised identifier for the patient. This identifier will be one of:

  • NHS number;
  • Temporary NHS number issued by an NHAIS registration authority;
  • PDS allocated temporary NHS number.

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

An NHS number is carried in the following way:

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

A Temporary NHS number issued by an NHAIS registration authority is carried in the following way:

  • The root attribute shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.3";
  • The extension attribute shall contain the Temporary NHS number issued by an NHAIS registration authority itself.

A PDS allocated temporary NHS number is carried in the following way:

  • The root attribute shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.4";
  • The extension attribute shall contain the PDS allocated temporary NHS number itself.

Examples

<!-- NHS number -->
<id root="2.16.840.1.113883.2.1.4.1" extension="9999999484"/>

<!-- Temporary NHS number issued by an NHAIS registration authority -->
<id root="2.16.840.1.113883.2.1.3.2.4.3" extension="BRS123456"/>

<!-- PDS allocated temporary NHS number -->
<id root="2.16.840.1.113883.2.1.3.2.4.4" extension="PDS1234567890"/>

[0..1] patientPerson (Person)

Information about the person who is the identified patient.

[0..1] sourceOf

A role link that links the patient to the GP he/she is registered with.

[1..1] typeCode (CS {CNE:registeredWith} )

Indicates that the patient is registered with the GP.

  • Fixed value "registeredWith"
[1..1] target (GpRegisteredWith)

Information about the GP the patient is registered with.

Person

Details about the person who is the patient.

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

Indicates that the entity is a person.

  • Fixed value "PSN"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that the entity is a single identifiable person.

  • Fixed value "INSTANCE"
[1..*] name (SET<PN>)

One or more names of the patient.

The entire current name shall be provided using "CURRENT" in the use attribute.

Zero or more previous names may be provided using "PREVIOUS" in the use attribute.

Zero or one preferred  name may be provided using "PREFERRED" in the use attribute.

[0..*] telecom (SET<TEL>)

Zero or more telecommunication numbers of the patient.

[1..1] administrativeGenderCode (CS {CNE:Sex} )

The code of the sex of the patient.

[1..1] birthTime (TS)

The date and time the patient was born.

Time may be given if available otherwise the date may be truncated from the right as required.

eg: YYYYDDMM or YYYYMM or YYYY

[1..*] addr (SET<AD>)

One or more addresses of the patient.  

The type of address, eg. permanent or temporary, is identified by the inclusion of the use attribute.

[0..1] disabilityCode (CV {CNE:HearingStatus} )

An optional code identifying a hearing disability.

The Coded Only datatype flavour is used to carry this information as follows:

  • The code attribute will contain a value from the list of codes in the HearingStatus vocabulary;
  • The codeSystem attribute will contain the OID referenced in the HearingStatus vocabulary

Example

<code="1" codeSystem="2.16.840.1.113883.2.1.3.2.4.17.98"/>

[0..*] guardian (Guardian)

Information about the patient's legal guardian.

[0..*] scopedProxy (Proxy)

Information about the patient's appointed proxy.

[0..1] languageCommunication (LanguageCommunication)

Information about the primary language used by the patient.

Guardian

Details about the role of guardian.

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

Indicates that the role is that of a guardian.

  • Fixed value: "GUARD"
[1..1] code (CV {CNE:PersonRelationshipType} )

Identifies the type of relationship between legal guardian and patient.

The Coded Only datatype flavour is used to carry this information as follows:

  • The code attribute will contain a value from the list of codes in the PersonRelationshipType vocabulary;
  • The codeSystem attribute will contain the OID referenced in the PersonRelationshipType vocabulary

 Example
<code code="001" codeSystem="2.16.840.1.113883.2.1.3.4.16.15"/>

[1..1] guardianOtherPerson (OtherPerson)

Information about the person who is the patient's guardian.

Proxy

Details about the role of proxy

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

Indicates that the role is that of contact for the patient.

  • Fixed value: "CON"
[0..1] code (CV {CNE:PersonRelationshipType} )

Identifies the type of relationship between proxy and patient.

The Coded Only datatype flavour is used to carry this information as follows:

  • The code attribute will contain a value from the list of codes in the PersonRelationshipType vocabulary;
  • The codeSystem attribute will contain the OID referenced in the PersonRelationshipType vocabulary

 Example
<code code="001" codeSystem="2.16.840.1.113883.2.1.3.4.16.15"/>

[0..1] certificateText (ST)

Holds the word or text to be used to authenticate the proxy's identity by the BMS.

[1..1] contactOtherPerson (OtherPerson)

Information about the person who is the patient's proxy.

LanguageCommunication

Indicates the language preference of the person who is either the patient, patient's proxy or patient's guardian.

Used by: Person
[1..1] languageCode (CS {CNE:HumanLanguage} )

A code specifying the language preferred for all communications. 

[1..1] preferenceInd (BL)

An indicator specifying whether or not the language is preferred by the entity for use in this context.

GpRegisteredWith

Details about the GP the patient is registered with.

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

Indicates the role of GP the patient is registered with.

  • Fixed value "ROL"
[1..1] id (II)

An identifier of the GP the patient is registered with.

The Identifier External datatype flavour is used to carry this information.

A national GP code is carried in the following way:

  • The root attribute shall contain an OID with the value 1.2.826.0.1285.0.2.0.67 
  •  The extension attribute shall contain the SDS Role Profile ID 
[1..1] playingGpPerson (GpPerson)

Information about the person who is the GP the patient is registered with.

[1..1] scopingGpPractice (GpPractice)

Information about the GP practice that scopes the role of registered GP.

OtherPerson

Details of the other person who can be either the guardian or the proxy.

Used by: Guardian, Proxy
[1..1] classCode (CS {CNE:PSN} ){ Fixed="PSN " }

Indicates that the entity is a person.

  • Fixed value "PSN"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that the entity is a single identifiable person.

  • Fixed value "INSTANCE"
[0..1] id (II)

If present, this is the current nationally recognised identifier for the guardian or proxy. This identifier will be one of:

  • NHS number;
  • Temporary NHS number issued by an NHAIS registration authority;
  • PDS allocated temporary NHS number.

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

An NHS number is carried in the following way:

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

A Temporary NHS number issued by an NHAIS registration authority is carried in the following way:

  • The root attribute shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.3";
  • The extension attribute shall contain the Temporary NHS number issued by an NHAIS registration authority itself.

A PDS allocated temporary NHS number is carried in the following way:

  • The root attribute shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.4";
  • The extension attribute shall contain the PDS allocated temporary NHS number itself.

Examples

<!-- NHS number -->
<id root="2.16.840.1.113883.2.1.4.1" extension="9999999484"/>

<!-- Temporary NHS number issued by an NHAIS registration authority -->
<id root="2.16.840.1.113883.2.1.3.2.4.3" extension="BRS123456"/>

<!-- PDS allocated temporary NHS number -->
<id root="2.16.840.1.113883.2.1.3.2.4.4" extension="PDS1234567890"/>

[1..1] name (PN)

One or more names of the patient.

The entire current name shall be provided using "CURRENT" in the use attribute.

Zero or more previous names may be provided using "PREVIOUS" in the use attribute.

Zero or one preferred  name may be provided using "PREFERRED" in the use attribute.

[0..*] telecom (SET<TEL>)

Zero or more telecommunication numbers of the patient.

[0..1] administrativeGenderCode (CS {CNE:Sex} )

The code of the sex of the patient.

[0..1] birthTime (TS)

The date and time the patient was born.

Time may be given if available otherwise the date may be truncated from the right as required.

eg: YYYYDDMM or YYYYMM or YYYY

[0..1] addr (AD)

One or more addresses of the patient.  

The type of address, eg. permanent or temporary, is identified by the inclusion of the use attribute.

[0..1] disabilityCode (CV {CNE:HearingStatus} )

An optional code identifying a hearing disability.

The Coded Only datatype flavour is used to carry this information as follows:

  • The code attribute will contain a value from the list of codes in the HearingStatus vocabulary;
  • The codeSystem attribute will contain the OID referenced in the HearingStatus vocabulary

Example

<code="1" codeSystem="2.16.840.1.113883.2.1.3.2.4.17.98"/>

GpPerson

Details about the person who is the GP the patient is registered with.

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

Indicates that the entity is a person.

  • Fixed value "PSN"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that the entity is a single identifiable person.

  • Fixed value "INSTANCE"
[1..1] name (PN)

The name of the person who is the GP.

GpPractice

Details about the organisation that is the GP Practice associated with the GP the patient is registered with.

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

Indicates that the entity is an organisation.

  • Fixed value "ORG"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that the entity is a single identifiable organisation.

  • Fixed value "INSTANCE"
[0..1] id (II)

An identifier of the GP practice.

The Identifier External datatype flavour is used to carry this information.

A GP practice code is carried in the following way:

  • The root attribute shall contain an OID with the value 1.2.826.0.1285.0.2.5.4.10 
  •  The extension attribute shall contain the NHS Organisation Code

 

[1..1] name (ON)

The name of  the GP practice.

[1..*] telecom (SET<TEL>)

One or more telecommunication numbers of the GP practice.

[1..1] addr (AD)

The address of the GP practice.

The type of address, eg. permanent or temporary, may be identified by the inclusion of the use attribute.