Request Appointment - tabular view

No Current Link To VocabularyCoded With Extensions
PRSC_RM040000UK08
RequestAppointmentConfirmation

The Request Appointment Confirmation

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:RQO} ){ Fixed="RQO " }

Indicates that this is a request.

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

UUID identifying this instance of a service request. This identifier is universally unique across all records. It is in the form of a UUID.

[1..1] subject

Refers to the patient for whom the appointment is being confirmed. 

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

Indicates that the patient is the subject of the request.

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

Information about the patient who is the subject.

[0..1] component

Refers to the correspondence suppression flag which is a component.

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

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] correspondenceSuppression (CorrespondenceSuppression)

Information about the correspondence suppression flag.

[0..1] pertinentInformation2

Refers to information that is pertinent to this confirmation request

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

Indicates that this is pertinent information.

  • Fixed value: "PERT"
[1..1] pertinentCallbackConsent (CallbackConsent)

Information about the callback consent.

[1..1] pertinentInformation1

Refers to information that is pertinent to this confirmation request.

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

Indicates that this is pertinent information.

  • Fixed value: "PERT" 
[1..1] pertinentReferral (ReferralInformation)

Information about the referral.

[1..1] inFulfillmentOf

Refers to the original request for a scheduled service.

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

Indicates that this is fulfilling a request.

  • Fixed value: "FLFS"
[1..1] priorRequestedService (RequestedService)

Information about the previous service request that the confirmed appointment is in fulfilment of.

[1..1] fulfillment

Refers to the appointment that has been scheduled to fulfill the requested service.

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

Indicates that this is fulfilling a request.

  • Fixed value: "FLFS"
[1..1] appointmentSlot (AppointmentSlot)

Information about the appointment that is fulfilling the service request.

Patient

Details about the patient.

Used by: RequestAppointmentConfirmation
[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.

CorrespondenceSuppression

An indicator to whether correspondence must be suppressed.

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

A code to indicate this is a observation

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

A code to indicate this is an event

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

A code to indicate whether to suppress correspondence.

The Coded with Code System datatype flavour is used to carry this information as follows:

  • The code attribute will contain value "1" (suppress corresponce) from the list of codes in the  CorrespondenceSuppression vocabulary;
  • The codeSystem attribute will contain the OID referenced in the CorrespondenceSuppression vocabulary.

Example

<!-- To indicate "Suppress correspondence" -->
<code code="1" codeSystem="2.16.840.1.113883.2.1.3.2.4.17.90"

CallbackConsent

An indicator of consent to contact the patient by telephone.

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

Indicates an interaction between the patient and the eBooking System.

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

Indicates that there is an intention to call back the patient.

  • Fixed value: "PRP"
[1..1] specialCourtesiesCode (CV {CNE:CallbackConsent} )

A code indicating whether the patient has consented to a call back

The Coded with Code System datatype flavour is used to carry this information as follows:

  • The code attribute will contain value "1" (suppress corresponce) from the list of codes in the  CallbackConsent vocabulary;
  • The codeSystem attribute will contain the OID referenced in the CallbackConsent vocabulary.

Example

<!-- To indicate that the patient has not consented -->
<code code="0" codeSystem="2.16.840.1.113883.2.1.3.2.4.17.99/>

ReferralInformation

Information about the referral.

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

Code to indicate inform.

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

Code to indicate this is an event.

  • Fixed value: "EVN"
[1..1] effectiveTime (TS)

The date of the decision to refer.

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

A code specifying the level of urgency applying to the referral.

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 PriorityType vocabulary;
  • The codeSystem attribute will contain the OID referenced in the PriorityType  vocabulary
  • The code attribute shall default to value "1", Routine
[1..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 is the author of the request.

  • Fixed value "AUT"
[1..1] agentPersonSDS (AgentPersonSDS)

Identify person fulfilling a specific role where the Person, Role Profile, Job Role and associated Organisation are all mandatory. Full details of the person, role profile, job role and associated Organisation are available from SDS.

RequestedService

Details about the requested service.

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

Indicates that a service is being supplied.

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

Indicates that there is a promise to fulfil a service request.

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

This identifier is unique within the eBooking Service. It identifies the Unique Booking Reference Number(UBRN) allocated to the service request for which an appointment has been made

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

  • The root attribute shall contain an OID with the value 2.16.840.1.113883.2.1.3.2.4.1
  • The extension attribute shall contain the UBRN

 Example

<id root="2.16.840.1.113883.2.1.3.2.4.1" extension="1000000001"

AppointmentSlot

Details about an appointment slot.

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

Indicates that an appointment is being supplied.

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

Indicates that this is a slot.

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

This identifies the Unique Slot Reference Number(USRN) allocated to the appointment slot that is being confirmed.

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"/>

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] languageCommunication (LanguageCommunication)

Information about the primary language used by the patient.

LanguageCommunication

Indicates the language preference of the person who is the patient.

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 GMP National Code

 

[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.

AgentPersonSDS

Details about the Agent

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

Indicates that this is an Agent

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

An SDS identifier that uniquely identifies the Role of the Agent.   This 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] agentPersonSDS (PersonSDS)

A link to the Agent playing the role.

[1..1] representedOrganisationSDS (OrganisationSDS)

A link to the Organisation represented by the agent.

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 of the organisation that is the GP Practice.

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.1.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.

PersonSDS

Details of the Person

Used by: AgentPersonSDS
[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] id (II)

An identifier of the person.

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

The person is identified using an SDS User Identifier carried in the following way:

  • The root attribute shall contain an OID with the value 1.2.826.0.1285.0.2.0.65
  • The extension attribute shall contain the SDS User Id

 

OrganisationSDS

Details of the agent's organisation

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

Indicates that this 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"
[1..1] id (II)

An identifier of the Organisation.

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

The HCP is identified using an SDS Organisation Identifier carried in the following way:

  • The root attribute shall contain an OID with the value 1.2.826.0.1285.0.1.10
  • The extension attribute shall contain the SDS Organisation Id