OutlineReferralResponse - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
PRPA_RM000001UK02
OutlineReferralList
A list of [0..*] referral outlines is returned from Choose and Book following an Outline Referral Query.
Used by:
[1..1] classCode (CS {CNE:LIST} ){ Fixed="LIST" }

Indicates that this is a list act.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "ORL"
[1..1] recordTarget

Refers to the patient to whom any results returned relate.

A patient may have zero requests as the patient may never have been referred. A client system (e.g. a GP system or Healthspace) could legitimately use this interface to determine if a user has any active referrals. If the patient has no active referrals then the no requests would be returned, however this is not an error condition so an empty container object would be returned.

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

Indicates that this is a record target participation.

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

Indicates patient information.

[0..*] component
Indicates the referral type to which this message refers.
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] target (ReferralTypeChoice)

A choice of referral types in Choose and Book which are associated with a record target.

Patient
Refers to the patient to whom this referral request relates.
Used by: OutlineReferralList, ReferralTypeChoice
[1..1] classCode (CS {CNE:PAT} ){ Fixed="PAT" }

Indicates that this role is of type patient.

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

Provides NHS Number, the nationally recognised identifier for the patient.

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

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

Only new, permanent NHS Numbers can be used to identify patients in Choose and Book.

ReferralTypeChoice

A choice of the following:

  • Advice and Guidance Request
  • Appointment Request
  • Uninitialised Request
Used by: OutlineReferralList
[1..1] subject
Refers to the subject of the referral, which will be the patient.
[1..1] typeCode (CS {CNE:SBJ} ){ Fixed="SBJ" }

Indicates that this is a subject participation and represents "the principle target that the service acts on".

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

Indicates the patient who is the subject of the Act.

[1..1] referrer
Refers to the clinician who made the decision to refer. This may not necessarily be the user who created the UBRN.
[1..1] typeCode (CS {CNE:REF} ){ Fixed="REF" }

Indicates that this is a referrer participation.

  • Fixed value: "REF"
[1..1] agent (Agent)

Indicates the agent performing the role of referrer.

[1..1] pertinentInformation1

Refers to the content sensitivity of the referral.

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

Indicates that this is pertinent information.

  • Fixed value: "PERT"
[1..1] pertinentContentSensitiveInd (ContentSensitiveInd)

Indicates information about the content sensitivity of the referral.

[1..1] pertinentInformation2
Refers to the status of the referral, i.e. Assessed, Referred On, etc.
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" }

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] pertinentRequestStatus (RequestStatus)

Indicates information about the status of the referral.

[1..1] either : AdviceandGuidanceRequest

Allows a referring clinician to seek advice from a service provider prior to making a referral.

             ... or ... : AppointmentRequest

Allows a referring clinician to request an appointment for the chosen service.

             ... or ... : UninitialisedRequest

An uninitialised request is created when Choose and Book receives a Request Service message from a GP system.  The system should then perform a seamless transition into Choose and Book to allow the user to intialise the request and create an appointment request or advice and guidance request.

However, if for some reason the user does not transition into Choose and Book, or the referral status message is requested before they have initialised the request, an uninitialisedRequest will be returned.

AdviceandGuidanceRequest
Allows a referring clinician to seek advice from a service provider prior to making a referral.
Used by: OutlineReferralList, ReferralTypeChoice
[1..1] classCode (CS {CNE:INFRM} ){ Fixed="INFRM" }

Indicates that this is an inform act.

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

Indicates that this Act is in request mood.

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

The UBRN (Unique Booking Reference Number).

A UBRN is a unique identifier for an Advice and Guidance or Appointment request in Choose and Book.

The Identifier External datatype 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.
[1..1] code (CV {CNE:CaBAnnotation} )

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "AAGREQ"
[1..1] effectiveTime (TS)

Date on which the patient was referred. Generally will correspond to UBRN creation date.

[1..1] activityTime (TS)

The date and time of the most recent action recorded.

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

Priority of the referral or advice and guidance request. This is the existing MiM vocabulary PriorityType.

Normally defaulted to '1' (routine).

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the PriorityType vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.95"
  • The code attribute shall contain a value from the PriorityType vocabulary.
AppointmentRequest
An entitlement to book into a list of clinically appropriate services defined by the Referring Clinician.
Used by: OutlineReferralList, ReferralTypeChoice
[1..1] classCode (CS {CNE:ENC} ){ Fixed="ENC" }

Indicates that this is an encounter Act.

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

Indicates that this Act is in appointment request mood.

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

The UBRN (Unique Booking Reference Number).

A UBRN is a unique identifier for an Advice and Guidance or Appointment Request in Choose and Book.

The Identifier External datatype 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.
[1..1] code (CV {CNE:CaBAnnotation} )

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "APREQ"
[1..1] effectiveTime (TS)

Date on which the patient was referred. Generally will correspond to UBRN creation date.

[1..1] activityTime (TS)

The date and time of the most recent action recorded.

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

Priority of the referral or advice and guidance request. This is the existing MiM vocabulary PriorityType.

Normally defaulted to '1' (routine).

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the PriorityType vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.95"
  • The code attribute shall contain a value from the PriorityType vocabulary.
[1..1] reasonCode (CV {CNE:CaBReasonCode} )

This code allows an appointment request to be flagged as a 'diagnostic appointment request', thus allowing it to have attributes such as a 'diagnostic order' or 'diagnostic result'. If the CaBReasonCode is not set to 'diagnostic', then the appointment request is of a standard nature and may not carry the above diagnostic attributes.

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBReasonCode vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.153"
  • The code attribute shall contain an appropriate code from the CaBReasonCode vocabulary.
[0..1] component3
Refers to the number of days past lead time for referral letter.
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] breachOffset (BreachOffset)

Indicates information relating to the breach offset for this appointment request.

[0..1] component2
Refers to the date by which the patient should be seen by the specialist.
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] dueByDate (DueByDate)

Indicates information relating to the due by date for this Appointment Request.

[1..1] component1
Refers to the action requested within the referral, e.g. diagnosis, treatment, etc.
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] requestedAction (RequestedAction)

Indicates information about the action requested within the referral.

[0..1] fulfillment
Refers to the appointment which fulfils this Appointment Request. Choose and Book will return the most recently booked appointment, if one exists.
[1..1] typeCode (CS {CNE:FLFS} ){ Fixed="FLFS" }

Indicates that this is a relationship of type fulfils.

  • Fixed value: "FLFS"
[1..1] appointment (Appointment)

Indicates information about the appointment which fulfils this Appointment Request.

UninitialisedRequest

An uninitialised request is created when Choose and Book receives a Request Service message from a GP system.  The system should then perform a seamless transition into Choose and Book to allow the user to initialise the request and create an appointment request or advice and guidance request.

However, if for some reason the user does not transition into Choose and Book, or the referral status message is requested before they have initialised the request, an uninitialisedRequest will be returned.

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

Indicates that this is a patient care provision Act.

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

Indicates that this is an event.

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

The UBRN (Unique Booking Reference Number).

A UBRN is a unique identifier for an Advice and Guidance or Appointment Request in Choose and Book.

The Identifier External datatype 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.
[1..1] code (CV {CNE:CaBAnnotation} )

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "UNREQ"
[1..1] effectiveTime (TS)

Date on which the patient was referred. Generally will correspond to UBRN creation date.

[1..1] activityTime (TS)

The date and time of the most recent action recorded.

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

Priority of the referral or advice and guidance request. This is the existing MiM vocabulary PriorityType.

Normally defaulted to '1' (routine).

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the PriorityType vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.95"
  • The code attribute shall contain a value from the PriorityType vocabulary.
[0..1] component2
Refers to an indicator of the specialty that will be used to search for services when the seamless transition is performed.
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] specialty (Specialty)

Indicates information relating to the specialty which will be used to search for services for this Uninitialised Request.

[1..1] component1
Refers to an indicator of the type of request to be created after the seamless transition is performed.
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] requestType (RequestType)

Indicates information relating to the specialty which will be used to search for services for this Uninitialised Request.

Agent
An agent, identifiable through SDS, with associated organisation details.
Used by: ReferralTypeChoice
[1..1] classCode (CS {CNE:AGNT} ){ Fixed="AGNT" }

Indicates that this role is of type agent.

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

The SDS User ID of the agent.

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

  • 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, known as the User's Unique Identifier (UUID) in the External Interface Specification.
[1..1] representedOrganization (Organization)

Indicates information about the organisation that the agent represents.

ContentSensitiveInd

Information about the content sensitivity of the referral. This will be set to 'true' if the request is content sensitive.

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

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "CSI"
[1..1] value (BL)

This is a Boolean datatype.

Defaulted to false.

RequestStatus
Refers to the status of the referral, i.e. Assessed, Referred On, etc.
Used by: ReferralTypeChoice
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" }

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "REQST"
[1..1] value (CV {CNE:RequestStatus} )

A code which indicates the status of a request.

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the RequestStatus vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.136"
  • The code attribute shall contain an appropriate value from the RequestStatus vocabulary.

RequestStatus will be an external list of values maintained by Choose and Book.

Organization
Refers to an organisation which is identifiable through SDS.
Used by: Agent
[1..1] classCode (CS {CNE:ORG} ){ Fixed="ORG" }

Indicates that this entity is of type organisation.

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

Indicates that the entity is a single identifiable instance.

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

The SDS Organisation ID for this instance of an organisation.

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

  • 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.
BreachOffset

Number of days past lead time for referral letter.

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

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "BRO"
[1..1] value (PQ)

The number of days past lead time for a referral letter.

This will be represented as a PQ (Physical Quantity) datatype to allow for the specification of a unit (e.g. days) as well as a value.

DueByDate
The date by which the patient should be seen by the specialist.
Used by: AppointmentRequest
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" }

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "DBD"
[1..1] activityTime (TS)

The date by which the patient should be seen by the specialist.

RequestedAction
Refers to a code describing the action requested within the referral.
Used by: AppointmentRequest
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" }

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "RQACT"
[1..1] value (CV {CNE:ServiceTypeRequested} )

A code describing the action requested within the referral.

 The Coded Value (CV) datatype shall be used to carry this information as follows:

  •  The codeSystem attribute shall contain the OID for the ServiceTypeRequested vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.16.24"
  • The code attribute shall contain an appropriate code from the ServiceTypeRequested vocabulary.
Appointment

An appointment slot, uniquely identified by a USRN (Unique Slot Reference Number).

Choose and Book will return the appointment most recently booked for the appointment request, provided one exists.

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

Indicates that this Act is of type encounter.

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

Indicates that this Act is in appointment mood.

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

The USRN (Unique Slot Reference Number).

A USRN is a unique identifier for an appointment slot in Choose and Book.

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

  •  The root attribute shall contain a UUID.
[1..1] code (CV {CNE:CaBAnnotation} )

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "APP"
[1..1] effectiveTime (IVL<TS>)

The time, date and duration of the appointment.

The appointment date and time must be returned, the duration of the appointment may be returned.

The IVL<TS> datatype allows all three to be represented.

[0..1] performer
Refers to the allocated clinician for this appointment.
[1..1] typeCode (CS {CNE:PRF} ){ Fixed="PRF" }

Indicates that this is a performer participation.

  • Fixed value: "PRF"
[1..1] agent (Agent2)

Indicates information about the allocated clinician.

[1..1] component

Refers to the choice of services which may be associated with an appointment. The choices are:

  • Directly bookable service
  • Indirectly bookable service
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] target (ServiceChoice)

Indicates service choice information.

[1..1] pertinentInformation
Refers to the status of the appointment, i.e. scheduled, attended, etc.
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" }

Indicates that this is pertinent information.

  • Fixed value: "PERT"
[1..1] pertinentAppointmentStatus (AppointmentStatus)

Indicates appointment status information.

Specialty
An indicator of the specialty to be used when searching for services when the seamless transition is performed.
Used by: UninitialisedRequest
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" }

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "SPEC"
[1..1] value (CV {CNE:Specialty} )

An indicator of the specialty to be used when searching for services when the seamless transition is performed.

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the Specialty vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.156"
  • The code attribute shall contain an appropriate code from the Specialty vocabulary.

Specialty will be an external list of values maintained by Choose and Book.

RequestType

An indicator of the type of request to be created after the seamless transition is performed.  This will be an externally maintained list of values.

Example values are:

  1. Appointment Request
  2. Diagnostic
  3. Advice & Guidance
Used by: UninitialisedRequest
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" }

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "REQTY"
[1..1] value (CV {CNE:RequestType} )

An indicator of the type of request to be created after the seamless transition is performed. 

 The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the RequestType  vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.152"
  • The code attribute shall contain an appropriate code from the RequestType vocabulary.

RequestType will be an external list of values maintained by Choose and Book.

Agent2

An agent, identifiable through SDS.

Agent2 does not have any directly associated organisation details, but is associated with with the service's service provider organisation/location.

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

Indicates that this role is of type agent.

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

The SDS User ID of the agent.

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

  • 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, known as the User's Unique Identifier (UUID) in the External Interface Specification.
ServiceChoice
The choice of services which may be associated with an appointment. The choices are:
  • Directly bookable service
  • Indirectly bookable service
Used by: Appointment
[1..1] component
Refers to a service, which may be associated with an appointment.
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] service (Service)

Indicates information about a service.

[1..1] either : DirectlyBookable

A directly bookable service is one that that is integrated with Choose and Book. Thus professional users and patients are able to view available appointment slots and book these via Choose and Book.

             ... or ... : IndirectlyBookable

An indirectly bookable service is one that that is not integrated with Choose and Book. Thus professional users and patients are not able to view available appointment slots and book via Choose and Book.

AppointmentStatus

The status of the appointment, i.e. scheduled, attended, etc.

Example values are:
- Scheduled
- Cancelled
- Attended
- Presumed Attended
- Did Not Attend

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

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "ASTAT"
[1..1] value (CV {CNE:AppointmentStatus} )

A code which denotes the status of the appointment.

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the AppointmentStatus vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.147"
  • The code attribute shall contain an appropriate value from the AppointmentStatus vocabulary.

AppointmentStatus will be an external list of values maintained by Choose and Book.

DirectlyBookable
A directly bookable service is one that that is integrated with Choose and Book. Thus professional users and patients are able to view available appointment slots and book these via Choose and Book. When a slot is booked this is reflected in the service provider PAS and Choose and Book.
Used by: Appointment, ServiceChoice
[1..1] classCode (CS {CNE:PCPR} ){ Fixed="PCPR" }

Indicates that this is a patient care provision Act.

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

Indicates that this Act is in definition mood.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "DB"
[0..1] activityTime (TS)

The time of the first slot available in the service.

IndirectlyBookable
An indirectly bookable service is one that that is not integrated with Choose and Book. Thus professional users and patients are not able to view available appointment slots and book via Choose and Book. The patient must telephone the Booking Manager at the service. The booking manager searches for a slot on the PAS and records this manually in Choose and Book.
Used by: Appointment, ServiceChoice
[1..1] classCode (CS {CNE:PCPR} ){ Fixed="PCPR" }

Indicates that this is a patient care provision Act.

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

Indicates that this Act is in definition mood.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "IB"
[1..1] location
Refers to the location at which telephone bookings can be made.
[1..1] typeCode (CS {CNE:LOC} ){ Fixed="LOC" }

Indicates that this is a location participation.

  • Fixed value: "LOC"
[1..1] incidentalServiceDeliveryLocation (IncidentalServiceDeliveryLocation)

Indicates information about the telephone booking location.

[0..1] pertinentInformation
Refers to the hours of operation for this indirectly bookable service.
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" }

Indicates that this is pertinent information.

  • Fixed value: "PERT"
[1..1] pertinentHoursOfOperation (HoursOfOperation)

Indicates information about hours of operation.

Service

In the outline communication a service will always be associated with an appointment.

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

Indicates that this is an encounter Act.

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

Indicates that this Act is in definition mood.

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

Identifier of the service. This is a value maintained internally within Choose and Book.

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.18.15"
  • The extension attribute shall contain the service ID.
[1..1] code (CV {CNE:CaBAnnotation} )

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "SVCE"
[1..1] title (ST)

The name of the service.

[1..1] location
Refers to the location at which the service is provided.
[1..1] typeCode (CS {CNE:LOC} ){ Fixed="LOC" }

Indicates that this is a location participation.

  • Fixed value: "LOC"
[1..1] serviceDeliveryLocation (ServiceDeliveryLocation)

Indicates information about the service location.

[1..1] origin
Refers to contact details for the service.
[1..1] typeCode (CS {CNE:ORG} ){ Fixed="ORG" }

Indicates that this is an origin participation.

  • Fixed value: "ORG"
[1..1] contactParty (ContactParty)

Indicates contact details information.

[1..1] responsibleParty
Refers to the organisation that provides the service.
[1..1] typeCode (CS {CNE:RESP} ){ Fixed="RESP" }

Indicates that this is a responsible party participation.

  • Fixed value: "RESP"
[1..1] healthCareProvider (HealthCareProvider)

Indicates information about the healthcare provider.

[1..*] component
Refers to the service classification/s to which the service belongs.
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] serviceClassification (ServiceClassification)

Indicates service classification information.

[0..1] pertinentInformation4
Refers to the referral priority indicative wait time for the service.
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" }

Indicates that this is pertinent information.

  • Fixed value: "PERT"
[1..1] pertinentIndicativeWaitTime (IndicativeWaitTime)

Indicates information about the indicative wait time.

[1..1] pertinentInformation1
Refers to information about the commissioned indicator for this service.
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" }

Indicates that this is pertinent information.

  • Fixed value: "PERT"
[1..1] pertinentCommissionedInd (CommissionedInd)

Indicates commissioned indicator information.

[0..1] pertinentInformation3
Refers to service definer instructions regarding the service.
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" }

Indicates that this is pertinent information.

  • Fixed value: "PERT"
[1..1] pertinentInstructions (Instructions)

Indicates instructive information.

[1..1] pertinentInformation2
Refers to information about the version of the service.
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" }

Indicates that this is pertinent information.

  • Fixed value: "PERT"
[1..1] pertinentVersion (Version)

Indicates service version information.

IncidentalServiceDeliveryLocation
Represents the booking location - specifically the telephone contact details - of an indirectly bookable service.
Used by: IndirectlyBookable
[1..1] classCode (CS {CNE:ISDLOC} ){ Fixed="ISDLOC" }

Indicates that this is an incidental service delivery location.

  • Fixed value: "ISDLOC"
[1..1] telecom (TEL)

The phone number a patient uses to book an appointment.

HoursOfOperation
The hours during which a patient can book an appointment.
Used by: IndirectlyBookable
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" }

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "HOO"
[1..1] value (ST)

The hours of operation are represented as a string because in the Choose and Book application they are captured as free text.

ServiceDeliveryLocation
Represents the location at which the service is provided.
Used by: Service
[1..1] classCode (CS {CNE:SDLOC} ){ Fixed="SDLOC" }

Indicates that this is a service delivery location.

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

The SDS Organisation ID for this instance of an organisation.

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

  • 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.
ContactParty

Contact details for the service. These are required but the exact detail that is required may change over time. Thus none of the attributes are mandatory.

At least one of either addr, telecom or Entity.name must be present in an instance.

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

Indicates that this is a contact party role.

  • Fixed value: "CON"
[0..1] addr (AD)

The address of the contact party.

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

The telephone number and text telephone number of the contact party.

There is not currently an approved address type prefix for text telephone numbers; however, a proposal to add the following to the HL7 datatype specification has been made: x-text-tel

The SET<TEL> datatype is used to allow two contact numbers to be stored. The first number in the set will always be the regular telephone number and the second will always be the text telephone number.

See XML examples for more information.

[0..1] contactEntity (Entity)

Information about the contact entity.

HealthCareProvider
Represents the organisation that provides the service.
Used by: Service
[1..1] classCode (CS {CNE:PROV} ){ Fixed="PROV" }

Indicates that this is a healthcare provider role.

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

The SDS code of the organisation.

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

  • 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.
ServiceClassification
A service may belong to more than one specialty/clinic type combination. Currently referrals in Choose and Book are limited to one specialty and clinic type combination for all services on the shortlist but this restriction will be lifted in the future.
Used by: Service
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" }

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "SCLSS"
[1..1] value (CV {CNE:Specialty} )

The specialty of the classification.

Specialty codes in Choose and Book are actually treatment function codes.

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the Specialty vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.156"
  • The code attribute shall contain an appropriate code from the Specialty vocabulary.

Specialty will be an external list of values maintained by Choose and Book.

[1..1] component
Refers to the clinic type of the classification.
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] clinicType (ClinicType)

Indicates clinic type information.

IndicativeWaitTime
The indicative wait time shows the amount of time that a patient is likely to have to wait for an appointment in the service, based on the priority assigned to the referral.
Used by: Service
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" }

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "IWT"
[1..1] value (PQ)

The number of days a patient is likely to have to wait for an appointment in the service, based on the priority assigned to the referral.

This will be represented as a PQ (Physical Quantity) datatype to allow for the specification of a unit (e.g. days) as well as a value.

CommissionedInd
Indicates if the service is locally commissioned.  This may be false if the service is on the Extended Choice Network.
Used by: Service
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" }

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "CI"
[1..1] value (BL)

Boolean value.

Defaulted to true.

Instructions
The instructions entered by the service definer.
Used by: Service
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" }

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "IN"
[1..1] text (ST)

The instructions entered by the service definer.

Version
The version of the service.
Used by: Service
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" }

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "SV"
[1..1] value (INT)

The version number of the service.

Entity
An entity representing a contact party.
Used by: ContactParty
[1..1] classCode (CS {CNE:ENT} ){ Fixed="ENT" }

Indicates that this is an entity.

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

Indicates that this entity is a single identifiable instance.

    Fixed value: "INSTANCE"

[1..1] name (TN)

The name of the contact party entity.

The trivial name (TN) datatype is used to represent the organisation name.

ClinicType

The clinic type of the classification.

Clinic types are specific to a specialty.

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

Indicates that this is an observation.

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

Indicates that this is an event.

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

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the CaBAnnotation vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.140"
  • The code attribute shall contain the vocabulary code "CLINT"
[1..1] title (ST)

The name of the clinic type associated with the code.

[1..1] value (CV {CNE:ClinicType} )

A code denoting the clinic type of the classification.

The Coded Value (CV) datatype shall be used to carry this information as follows:

  • The codeSystem attribute shall contain the OID for the ClinicType vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.151"
  • The code attribute shall contain an appropriate code from the ClinicType vocabulary.

ClinicType will be an external list of values maintained by Choose and Book.