DetailedReferralResponse - tabular view

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

AdditionalRequirement

Choose and Book allows users to specify that a patient may have requirements over and above the medical needs of the patient. For example the patient may not speak English and may require an interpreter.

Additional requirements are administrative information.

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

[1..1] text (ST)

A text string that defines the additional requirement of the patient.

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

A string that is displayed to users to represent the requirement type. Example values include:

Interpreter
Transport
Advocacy

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

The codeSystem attribute shall contain the OID for the TypeDisplayValue vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.146"
The code attribute shall contain an appropriate code from the TypeDisplayValue vocabulary.

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

[1..1] component

Refers to information about the status of the additional requirement request, e.g. requested, no longer required, etc.


[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }		Indicates that this is a component. Fixed value: "COMP"

[1..1] requirementStatus (RequirementStatus)		Indicates requirement status information.

[0..*] pertinentInformation

Refers to comments about the additional requirement/s.


[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" }		Indicates that this is pertinent information. Fixed value: "PERT"

[1..1] pertinentRequirementComment (RequirementComment)		Indicates requirement comments information.

BreachOffset

Number of days past lead time for referral letter.

Although the breachOffset is administrative information, it is unlikely that an application would wish to allow a patient to view this.

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

DiagnosticOrder

The diagnostic request contains the clinical instructions to a diagnostic service to perform a certain procedure on the patient.

An appointment request may only have an associated diagnostic order if AppointmentRequest.reasonCode is set to 'diagnostic'.

The information is clinical.

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

[1..1] effectiveTime (TS)

The time that the diagnostic order was added.

[0..1] value (ST)

An optional comment about the diagnostic order.

[1..1] performer

Refers to the user responsible for adding the clinical information.


[1..1] typeCode (CS {CNE:PRF} ){ Fixed="PRF" }		Indicates that this is a performer participation. Fixed value: "PRF"

[1..1] agent (Agent)		Indicates information about the agent who added the diagnostic order.

[0..*] component

Refers to any clinical attachments belonging to this diagnostic order.


[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }		Indicates that this is a component. Fixed value: "COMP"

[1..1] clinicalAttachment (ClinicalAttachment)		Indicates information about a clinical attachment.

DueByDate

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

This is administrative information.

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

SupplementaryInfo

Supplementary clinical information relating to this referral, which can be added by service provider users.

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

[1..1] effectiveTime (TS)

The date and time that the supplementary information was added.

[0..1] value (ST)

An optional comment in the form of a string. This may constitute the supplementary information if no clinical attachment has been added by the user.

[1..1] performer

Refers to the user responsible for adding the clinical information.


[1..1] typeCode (CS {CNE:PRF} ){ Fixed="PRF" }		Indicates that this is a performer participation. Fixed value: "PRF"

[1..1] agent (Agent)		Indicates information about the agent who added the supplementary clinical information.

[0..*] component

Refers to any clinical attachments belonging to the supplementary clinical information.


[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }		Indicates that this is a component. Fixed value: "COMP"

[1..1] clinicalAttachment (ClinicalAttachment)		Indicates information about a clinical attachment.

ReferralLetterChoice

The referral letter is the clinical communication between a referring clinician and a service provider clinician.

An appointment request may have a referral letter in addition to a diagnostic request if the AppointmentRequest.reasonCode attribute is set to 'diagnostic'.

[1..1] either : UKCT_MT170001UK02

A CMET which encapsulates a structured referral letter.

... or ... : UnstructuredLetter

Clinical information which as a whole constitutes an unstructured referral letter.

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.

The appointment is administrative information.

[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] component19

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] pertinentInformation2

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.

[0..1] pertinentInformation1

Refers to the administrative outcome of the appointment.


[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" }		Indicates that this is pertinent information. Fixed value: "PERT"

[1..1] pertinentAdminResult (AdminResult)		Indicates administrative result information.

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:

Appointment Request
Diagnostic
Advice & Guidance

This is administrative information.

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.

Specialty

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

This is administrative information.

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.

UnstructuredLetter

An unstructured referral letter is clinical information.

It may be uploaded via the Choose and Book front-end as an attachment.

Used by: AppointmentRequest, ReferralLetterChoice

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

Indicates that this is an inform Act.

Fixed value: "INFRM"

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

[0..1] text (ST)

An optional comment which may constitute the unstructured referral letter if no clinical attachment is added by the user.

[1..1] effectiveTime (TS)

The date and time that the unstructured referral letter was added.

[1..1] performer

Refers to the user responsible for adding the clinical information.


[1..1] typeCode (CS {CNE:PRF} ){ Fixed="PRF" }		Indicates that this is a performer participation. Fixed value: "PRF"

[1..1] agent (Agent)		Indicates information about the agent who added the unstructured referral letter.

[0..*] component

Refers to any clinical attachments belonging to the unstructured referral letter.


[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }		Indicates that this is a component. Fixed value: "COMP"

[1..1] clinicalAttachment (ClinicalAttachment)		Indicates information about a clinical attachment.

AAGResponse

A response to an advice and guidance request.

Advice and guidance response details are clinical information.

Used by: AAGRequestDetails

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

[1..1] effectiveTime (TS)

The date and time that the advice and guidance response was added.

[0..1] value (ST)

An optional comment which may constitute the advice and guidance response if no clinical attachment is added by the user.

[1..1] performer

Refers to the user responsible for adding the clinical information.


[1..1] typeCode (CS {CNE:PRF} ){ Fixed="PRF" }		Indicates that this is a performer participation. Fixed value: "PRF"

[1..1] agent (Agent)		Indicates information about the agent who added the advice and guidance response.

[0..*] component

Refers to any clinical attachments belonging to the advice and guidance response.


[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }		Indicates that this is a component. Fixed value: "COMP"

[1..1] clinicalAttachment (ClinicalAttachment)		Indicates information about a clinical attachment.

MaxIndWaitTime

This is used to further filter the priority, if the priority is '2 week wait' then the indicative wait time (IWT) is ignored. If the priority is urgent or routine then it is used to filter out services with no urgent or routine slots (as appropriate) within the specified IWT.

This is clinical information.

[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:CriteriaCode} )

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

The codeSystem attribute shall contain the OID for the CriteriaCode vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.142"
The code attribute shall contain the vocabulary code "MIWT"

[1..1] value (PQ)

The maximum indicative wait time (in days).

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.

CriteriaChoice

A choice of search criteria which may be searched on in order to find appropriate services.

At least one (or more) of the choices below must be specified in a search.

[1..1] either : NamedClinician

The SDS User ID of the named clinician used in the search.

... or ... : SearchKeyword

Enables the search for services which have been defined as supporting a particular clinical term.

... or ... : SearchServiceClassification

Allows the user to search by specialty and optionally by clinic type as well.

SearchDistance

It is possible to specify that the list of services returned by a search be limited to those within a certain distance of a specified postcode.

The search distance is clinical information.

[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:CriteriaCode} )

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

The codeSystem attribute shall contain the OID for the CriteriaCode vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.142"
The code attribute shall contain the vocabulary code "SDIST"

[1..1] value (PQ)

The maximum distance from a postcode, in miles.

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

[1..1] component

Refers to the postcode that the distance is calculated from.


[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }		Indicates that this is a component. Fixed value: "COMP"

[1..1] postcode (Postcode)		Indicates postcode information.

SearchOrganisation

Allows a user to search for services using an organisation name or organisation code.

This is clinical information.

[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:CriteriaCode} )

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

The codeSystem attribute shall contain the OID for the CriteriaCode vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.142"
The code attribute shall contain the vocabulary code "SO"

[1..1] subject

Refers to the organisation that is the subject of this search.


[1..1] typeCode (CS {CNE:SBJ} ){ Fixed="SBJ" }		Indicates that this is a subject participation. Fixed value: "SBJ"

[1..1] healthCareProvider (HealthCareProvider2)		Indicates information about the search organisation.

ExtendedChoiceIndicator

Indicates whether the search included organisations on the extended choice network.

This is clinical information.

[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:CriteriaCode} )

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

The codeSystem attribute shall contain the OID for the CriteriaCode vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.142"
The code attribute shall contain the vocabulary code "ECI"

[1..1] value (BL)

A Boolean value.

Defaulted to false.

IgnoreAgeRestriction

Indicates whether the clinician performing the search elected to override restrictions on age defined at service level, which might have prevented certain services from being returned in the search.

This is clinical information.

[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:CriteriaCode} )

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

The codeSystem attribute shall contain the OID for the CriteriaCode vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.142"
The code attribute shall contain the vocabulary code "IAR"

[1..1] value (BL)

A Boolean value.

Defaulted to false.

IgnoreGenderRestriction

Indicates whether the clinician performing the search elected to override restrictions on gender defined at service level, which might have prevented certain services from being returned in the search.

This is clinical information.

Used by: SearchServiceClassification

[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:CriteriaCode} )

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

The codeSystem attribute shall contain the OID for the CriteriaCode vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.142"
The code attribute shall contain the vocabulary code "IGR"

[1..1] value (BL)

A Boolean value.

Defaulted to false.

ServiceChoice

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

Directly bookable service

Indirectly bookable service

Used by: ActiveServiceShortlist, Appointment

[1..1] component

Refers to a service, which may be associated with either an appointment or an active service shortlist.


[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

RequirementStatus

Details of the additional requirement status.

Used by: AdditionalRequirement

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

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

A code which represents the status of the additional requirement. Example values might include:

Requested
Eligible
Cancel, no longer required

Note that the mapping of status display values to a status meaning is not [1..1].

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

The codeSystem attribute shall contain the OID for the StatusDisplayValue vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.134"
The code attribute shall contain an appropriate value from the StatusDisplayValue vocabulary.

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

[1..1] component

Refers to the meaning of the status value.


[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }		Indicates that this is a component. Fixed value: "COMP"

[1..1] statusMeaning (StatusMeaning)		Indicates information about the meaning of the status value.

RequirementComment

A comment about any additional requirement/s relating to the patient who is the subject of the referral.

Additional requirement comments are administrative information. However, it is not anticipated that these will be made available to patients via HealthSpace.

Used by: AdditionalRequirement

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

[1..1] text (ST)

The additional requirement comment, in the form of a string.

[1..1] effectiveTime (TS)

The date and time that the comment was added.

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

A code which represents the status of the additional requirement. Example values might include:

Requested
Eligible
Cancel, no longer required

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

The codeSystem attribute shall contain the OID for the StatusDisplayValue vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.134"
The code attribute shall contain an appropriate value from the StatusDisplayValue vocabulary.

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

[1..1] performer

Refers to the user responsible for adding the additional requirement comment.


[1..1] typeCode (CS {CNE:PRF} ){ Fixed="PRF" }		Indicates that this is a performer participation. Fixed value: "PRF"

[1..1] agent (Agent)		Indicates information about the user responsible for adding the additional requirement comment.

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.

AdminResult

The administrative outcome of the appointment. This will only be returned if the appointment's status is Attended. Example values include:

Advise referrer
Refer on
Refer on outside Choose and Book

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

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

The coded outcome of an appointment.

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

The codeSystem attribute shall contain the OID for the AdminResult vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.148"
The code attribute shall contain an appropriate code from the AdminResult vocabulary.

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

[1..1] component

Refers to the type of this administrative result (e.g. diagnostic, assessment, general)


[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }		Indicates that this is a component. Fixed value: "COMP"

[1..1] adminResultType (AdminResultType)		Information about the administrative result type.

[0..1] pertinentInformation

Refers to the clinical result for this referral.


[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" }		Indicates that this is pertinent information. Fixed value: "PERT"

[1..1] pertinentClinicalResult (ClinicalResult)		Indicates clinical result information.

NamedClinician

The SDS User ID of the named clinician used in the search.

This is clinical information.

Used by: SearchCriteria, CriteriaChoice

[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:CriteriaCode} )

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

The codeSystem attribute shall contain the OID for the CriteriaCode vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.142"
The code attribute shall contain the vocabulary code "NC"

[1..1] subject

Refers to the named clinician who is the subject of the Act.


[1..1] typeCode (CS {CNE:SBJ} ){ Fixed="SBJ" }		Indicates that this is a subject participation. Fixed value: "SBJ"

[1..1] agent (Agent2)		Indicates information about the agent who is the named clinician.

SearchKeyword

It is possible to search for services which have been defined as supporting a particular clinical term (whether this is a condition treated or procedure performed). The search can be further refined by using the searchKeyword in conjunction with other search criteria.

This is clinical information.

Used by: SearchCriteria, CriteriaChoice

[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:CriteriaCode} )

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

The codeSystem attribute shall contain the OID for the CriteriaCode vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.142"
The code attribute shall contain the vocabulary code "SKEYW"

[1..1] value (CD {CNE:SnomedCT} ){ Fixed="SnomedCT" }

The searchKeyword is a SNOMED coded value.

The Concept Descriptor (CD) datatype shall be used to carry this information as follows:

The codeSystem attribute shall contain the OID for SNOMEDCT with the value "2.16.840.1.113883.2.1.3.2.4.15"
The code attribute shall carry an appropriate SNOMED code.
The displayName attribute may carry the display name of the SNOMED code.

SearchServiceClassification

Allows the user to search by specialty and optionally by clinic type as well.

The search service classification is clinical information.

Used by: SearchCriteria, CriteriaChoice

[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:CriteriaCode} )

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

The codeSystem attribute shall contain the OID for the CriteriaCode vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.142"
The code attribute shall contain the vocabulary code "SSC"

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

A code denoting the specialty for this service classification. The specialties held in Choose and Book are 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.

[0..1] component

Refers to the clinic type for this service classification.


[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }		Indicates that this is a component. Fixed value: "COMP"

[1..1] clinicType (ClinicType)		Indicates information about the clinic type for this service classification.

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: ActiveServiceShortlist, ServiceChoice, Appointment

[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: ActiveServiceShortlist, ServiceChoice, Appointment

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

ClinicalAttachment

A clinical file which may be optionally attached to clinical information relating to the referral.

The MIME type of the file must be one of the MIME types supported by Choose and Book.

Used by: AAGResponse, AAGRequestDetails, DiagnosticOrder, SupplementaryInfo, UnstructuredLetter, ClinicalResult

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

[1..1] title (ST)

The name of the attached file at it exists on the source system.

[1..1] value (ED)

This field carries two pieces of information within the ED datatype:

The MIME type of the attached file. This must be one of the MIME types supported by Choose and Book.
The URL of the attached file.

The ED datatype shall be used to carry this information as follows:

The mediaType attribute shall carry the MIME type information (e.g. text/rtf)
The value attribute of the reference element shall carry the URL.

See XML examples for more information.

Postcode

The postcode that the distance is calculated from. This may be a complete postcode or partial postcode (prefix only).

Used by: SearchDistance

[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:CriteriaCode} )

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

The codeSystem attribute shall contain the OID for the CriteriaCode vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.142"
The code attribute shall contain the vocabulary code "PC"

[1..1] subject

Refers to the postcode that is the subject of this criteria search.


[1..1] typeCode (CS {CNE:SBJ} ){ Fixed="SBJ" }		Indicates that this is a subject participation. Fixed value: "SBJ"

[1..1] postcodeRole (PostcodeRole)		Indicates postcode information.

HealthCareProvider2

It is possible to search for services using an organisation name or organisation code. Only one of organisationCode and organisationName should be supplied.

The search organisation is clinical information.

Used by: SearchOrganisation

[1..1] classCode (CS {CNE:PROV} ){ Fixed="PROV" }

Indicates that this is a healthcare provider role.

[0..1] id (II)

The SDS code of the organisation being searched on.

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.

[0..1] healthCareEntity2 (Entity2)

Indicates information about the healthcare entity.

Service

In the CIM, a service will always be associated with either an appointment OR an activeServiceShortlist.

The service details are administrative information.

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 within the Choose and Book system.

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..*] component35

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] pertinentInformation3

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] pertinentInformation5

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] pertinentInformation2

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.

[0..1] pertinentInformation4

Refers to the distance of this service from the postcode defined in the search criteria.


[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" }		Indicates that this is pertinent information. Fixed value: "PERT"

[1..1] pertinentServiceDistance (ServiceDistance)		Indicates service distance information.

[1..1] pertinentInformation1

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.

StatusMeaning

Provides the meaning of the status display value.

Used by: RequirementStatus

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

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

A code which provides the meaning of the status display value. Example values might include:

To be resolved
Not provided
Booked

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

The codeSystem attribute shall contain the OID for the StatusMeaning vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.135"
The code attribute shall contain an appropriate code from the StatusMeaning vocabulary.

AdminResultType

Denotes the type of administrative result, e.g. diagnostic, general, clinical assessment.

The result type may only be diagnostic if the associated appointment request is of type diagnostic.

Used by: AdminResult

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

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

A code denoting the type of administrative result.

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

The codeSystem attribute shall contain the OID for the AdminResultType vocabulary with the value "2.16.840.1.113883.2.1.3.2.4.17.154"
The code attribute shall contain an appropriate code from the AdminResultType vocabulary.

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

ClinicalResult

The clinical result of an appointment.

There are several types of clinical result, these include:

General appointment result
Clinical assessment result
Diagnostic result

The result type can be discerned from the value of the AdminResultType code of the administrative result.

Used by: AdminResult

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

[1..1] effectiveTime (TS)

The date and time that the clinical result was added.

[0..1] value (ST)

An optional comment which may constitute the clinical result response if no clinical attachment is added by the user.

[1..1] performer

Refers to the user responsible for adding the clinical information.


[1..1] typeCode (CS {CNE:PRF} ){ Fixed="PRF" }		Indicates that this is a performer participation. Fixed value: "PRF"

[1..1] agent (Agent)		Indicates information about the agent who added the clinical result.

[0..*] component

Refers to any clinical attachments belonging to this clinical result.


[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" }		Indicates that this is a component. Fixed value: "COMP"

[1..1] clinicalAttachment (ClinicalAttachment)		Indicates information about a clinical attachment.

Agent2

An agent, identifiable through SDS.

Agent2 does not have any associated organisation details, but is associated with a service's service provider organisation/location or (in the case of NamedClinician) with the organisations on the active service shortlist.

Used by: NamedClinician, 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.

ClinicType

The clinic type of the classification.

Clinic types are specific to a specialty.

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

Entity2

An entity representing an organisation.

Used by: HealthCareProvider2

[1..1] classCode (CS {CNE:ENT} ){ Fixed="ENT" }

Indicates that this is an entity.

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

Indicates that this entity is a single identifiable instance.

Fixed value: "INSTANCE"

[0..1] name (TN)

The name of the organisation entity.

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

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.

PostcodeRole

Represents the role of the postcode used to search for services within a specified distance.

Used by: Postcode

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

Indicates that this is a role.

[1..1] addr (AD)

The postcode will be stored within the postalCode element of the AD datatype.

ServiceDeliveryLocation

Represents the location at which the service is provided.

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

Contact details are administrative information.

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

[1..1] classCode (CS {CNE:PROV} ){ Fixed="PROV" }

Indicates that this is a healthcare provider role.

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

This is administrative information.

[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] clinicType2 (ClinicType2)		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.

[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

Indiciates if the service is locally commissioned. This may be false if the service is on the Extended Choice Network.

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

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

ServiceDistance

The distance of each service on the shortlist from the postcode as calculated at the time the search was performed.

The distance of the service from the postcode will only be returned if the following conditions are true:

the service is associated with an activeServiceShortlist
the activeServiceShortlist is associated to a searchCriteria which is associated to searchDistance information (i.e. the user specified a maximum distance from a specified postcode in the search criteria).

This is clinical information.

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

[1..1] value (PQ)

The distance from a postcode, in miles.

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

Version

The version of the service.