Cancel Request - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
PORX_RM135001UK32
CancellationRequest

This message is sent by an authorised person from the prescribing system to the ETP Component to attempt to cancel either an item on a previously sent prescription, or the whole prescription, so that it is not dispensed.

Reference: W5-5.4.2.1

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

A code indicating that the ETP Component is requested to take action based on the payload of this message

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

Indicates that this is a request or order for a service.

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

The globally unique identifier for this instance of a Cancel Request. 

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

  • the root attribute will contain a UUID
[1..1] effectiveTime (TS)

The date and timestamp of this message.

The date-timestamp must be given with the following precision:

  • YYYYMMDDHHMMSS
[1..1] recordTarget

A link to the patient for whom this prescription cancellation is being requested.

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

A code indicating that the receiving organisation is the primary recipient

  • Fixed value: "RCT"
[1..1] patient      [CMET: COCT_MT050012UK05]

A link to identify a person fulfilling the specific role for a patient for whom the prescription is being cancelled.

Where GP details are not available, then a NULL flavour of "NA" will be provided.

The following CMET data elements are required and must be provided:

Patient
id NHS Number
addr Address
Person
name Name
administrativeGenderCode Gender
birthTime Birth date, which must be given with the following precision:
  • YYYYMMDD
ProviderPatient
subjectOf
PatientCareProvision
code Fixed value "1" from the list of codes in the PatientCareProvisionType vocabulary
responsibleParty
HealthCareProvider
id SDS User's Unique Identifier

If the optional data element Person.deceasedTime is provided, it must be given with the following precision:

  • YYYYMMDD
[1..1] author

A link to the person (prescriber) making the cancel request.

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

Indicates that the role is the author of the request.

  • Fixed value: "AUT"
[1..1] agent      [CMET: UKCT_MT120201UK04]

NPfIT CMET fulfilling the specific role of a person (prescriber) issuing the Cancel Request message.  This individual need not necesarrily be directly responsible for the care of the patient (e.g. practice nurse reporting to a GP principal).

This information is mandatory.

The following CMET data elements are required and must be provided in PlayingEntityChoice:

AgentPerson
id SDS role profile code
code SDS job role code (returned in the SAML assertion following successful end-user authentication)
telecom Telephone number
Person
id SDS identifier
name Name
Organization
id Organisation SDS identifier
code Type of organisation
name Name of organisation
telecom Telephone number of organisation
addr Address of organisation
[1..1] responsibleParty
A link to the healthcare professional who is directly responsible for the care of the patient.
[1..1] typeCode (CS {CNE:RESP} ){ Fixed="RESP" }

Indicates that the HCP has primary responsibility for the patient.

  •  fixed value: "RESP"
[1..1] participant      [CMET: UKCT_MT120201UK04]

NPfIT CMET to identify a person fulfilling the specific role for a person who has direct responsibility for the patient.

This information is mandatory.

The following CMET data elements are required and must be provided in PlayingEntityChoice:

AgentPerson
id SDS role profile code
code Role descriptor
telecom Telephone number
Person
id SDS identifier
name Name

[1..1] pertinentInformation2

An Act relationship linking to the identity of the Prescription for which cancellation has been requested. 

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

Indicates that this is pertinent information.

  • Fixed value : "PERT"
[1..1] contextConductionInd (BL)

If "true", associations in the parent act are conducted across the ActRelationship to the child act.

In this context the contextConductionInd defaults to "true".

[1..1] seperatableInd (BL)

This attribute indicates whether or not the source Act is intended to be interpreted independently of the target Act.

If the source act is intended to be interpreted independently the value shall be "true" otherwise the value shall be "false".

The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.

In this context the seperatableInd defaults to "false".

[1..1] pertinentPrescriptionID (PrescriptionID)

The id of the prescription clinical event that is pertinent to this cancellation.

[0..1] pertinentInformation1
An Act relationship linking to the identity of the prescription Line Item for which cancellation has been requested.
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" }

Indicates that this is pertinent information.

  • Fixed value : "PERT"
[1..1] inversionInd (BL)

An indicator specifying that the ActRelationship.typeCode should be interpreted as if the roles of the source and target Acts were reversed. The inversion indicator is used when the meaning of ActRelationship.typeCode must be reversed.

In this instance, the inversionInd defaults to "false".

[1..1] negationInd (BL)

When "true" allows the sender to specifically state that the relationship does not apply.

In this context the negationInd defaults to "false".

[1..1] seperatableInd (BL)

This attribute indicates whether or not the source Act is intended to be interpreted independently of the target Act.

If the source act is intended to be interpreted independently the value shall be "true" otherwise the value shall be "false".

The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.

In this context the seperatableInd defaults to "true".

[1..1] pertinentLineItemRef (LineItemRef)

A reference to the Line Item pertinent to this cancellation.

This information is optional if the cancellation request is not for a prescription Line Item, and may  be omitted.

[1..*] pertinentInformation

An act relationship linking to information regarding the reason for cancellation.

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

Indicates pertinent information.

  • Fixed value
[1..1] contextConductionInd (BL)

If "true", associations in the parent act are conducted across the ActRelationship to the child act.

In this context the contextConductionInd defaults to "true".

[1..1] seperatableInd (BL)

This attribute indicates whether or not the source Act is intended to be interpreted independently of the target Act.

If the source act is intended to be interpreted independently the value shall be "true" otherwise the value shall be "false".

The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.

In this context the seperatableInd defaults to "false".

[1..1] pertinentCancellationReason (CancellationReason)

The CancellationReason pertinent to this cancellation. At least one (but more than one may be provided) reason must be provided for the Cancellation Request.

[0..1] pertinentInformation3
An act relationship linking to the identity of the Prescription (clinical statement) for which cancellation has been requested.
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" }

Indicates that this is pertinent information.

  • Fixed value : "PERT"
[1..1] contextConductionInd (BL)

If "true", associations in the parent act are conducted across the ActRelationship to the child act.

In this context the contextConductionInd defaults to "false".

[1..1] seperatableInd (BL)

This attribute indicates whether or not the source Act is intended to be interpreted independently of the target Act.

If the source act is intended to be interpreted independently the value shall be "true" otherwise the value shall be "false".

The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.

In this context the seperatableInd defaults to "true".

[1..1] pertinentOriginalPrescriptionRef (OriginalPrescriptionRef)

A reference to the Prescription pertinent to this cancellation.

PrescriptionID

A reference to the prescription for which cancellation is being requested, using the Short Form Prescription Identifier.

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

Indicates that this act 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:PrescriptionAnnotation} )

Indicates that this represents a Prescription Identifier.

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

  • The code attribute will contain the fixed value "PID" from the list of codes in the PrescriptionAnnotation vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the PrescriptionAnnotation vocabulary.
[1..1] value (II)

Prescription identifier that is universally unique across all records and consists of the Short Form Prescription Identifier.

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

  • the root attribute shall contain the value of the Short Form Prescription Identifier OID = 2.16.840.1.113883.2.1.3.2.4.18.8
  • the extension attribute shall contain the 18 character Short Form Prescription Identifier as described in the ETP Prescribing Systems Compliance Specification document (ref: NPFIT-ETP-EDB-0025.09).
LineItemRef
A reference to the Line Item clinical event for which cancellation is being requested.
Used by: CancellationRequest
[1..1] classCode (CS {CNE:SBADM} ){ Fixed="SBADM" }

A code to indicate introducing or applying a substance to a subject.

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

Indicates that this is a request or order for a service.

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

The unique identifier of the target act being referred to.  This shall be a DCE UUID carried in the root attribute of the id element.

In this instance, this is a globally unique number to identify the target prescription Line Item to be processed.

CancellationReason
Reasons why the cancellation was issued. Reference: NPFIT-ETP-PZ-0159-v1.2 Table 8.
Used by: CancellationRequest
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" }

Indicates that this act 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:PrescriptionAnnotation} )

Code representation for prescription charge exemption status.

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

  • The code attribute will contain the fixed value "CR" from the list of codes in the PrescriptionAnnotation vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the PrescriptionAnnotation vocabulary.
[0..1] text (ST)

Additional textual (human readable) information for the cancellation to supplement the standard text provided.

[1..1] value (CV {CWE:CancellationReason} )

Coded information specifying the cancellation reason.

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

  • The code attribute will contain a value from the list of codes in the CancellationReason vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the CancellationReason vocabulary.
OriginalPrescriptionRef
A reference to the Prescription clinical event for which cancellation is being requested.
Used by: CancellationRequest
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" }

Indicates that this act is an observation

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

Indicates that this is a request or order for a service.

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

The unique identifier of the target act being referred to.  This shall be a DCE UUID carried in the root attribute of the id element.

In this instance, this is a globally unique number to identify the target Prescription to be processed.