Cancel Response - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
PORX_RM135201UK31
CancellationResponse

This message is sent by the ETP Component to the author of a Cancel message to inform them whether or not the previously requested cancellation for an item or prescription has been successfully cancelled.

Reference: W5-5.4.3.1

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

A code indicating that the Cancellation Response is transmitting information in response to the initial request

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

A code to indicate this is an event.

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

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

This is the unique number of the event that identifies the payload of the message.

[1..1] effectiveTime (TS)

Date and time stamp Cancellation Response message is issued by the ETP Component.

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

  • YYYYMMDDHHMM
[1..1] recordTarget

A link to the patient for whom this cancellation response is being sent.

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

A code indicating that the patient's records will hold the information relating to this Cancellation.

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

NPfIT CMET to identify a person fulfilling the specific role for a patient  for this cancellation response is being sent.

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
[0..1] performer

A participation used to provide a link to information about the individual who downloaded the prescription from the ETP Component.

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

Indicates that this is a performer, i.e. the individual who downloaded the prescription.

  • Fixed value: "PRF"
[1..1] contextControlCode (CS {CNE:OP} ){ Fixed="OP" }

A code that specifies how this Participation contributes to the context of the current Act, and whether it may be propagated to descendent Acts whose association allows such propagation.

The value of contextControlCode should be set appropriately according to the context of the participation being modelled.

  • Default value: "OP" - Overriding and propagating

The default value of "OP" indicates that the association adds to the existing context associated with the Act, and will propagate to any descendant Acts reached by conducting ActRelationships.

In this instance, a code that this professional propagates through to the CancellationResponse as the individual who downloaded the prescription.

[1..1] time (TS)

The date and time stamp of when the download took place.

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

  • YYYYMMDDHHMM
[1..1] participant      [CMET: UKCT_MT120201UK03]

NPfIT CMET to identify a person fulfilling the specific role for a person who downloaded the prescription from the ETP Component.

This information is optional and omitted, unless the prescription has been downloaded.

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

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 : details of the person playing the Agent role
id SDS identifier
name Name
Organization : details of the scoping GP practice
id Organisation SDS identifier
code Type of organisation
name Name of organisation
telecom Telephone number of organisation
addr Address of organisation
[1..1] author

A participation used to provide a link to the prescriber who issued the initial Cancellation Message.

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

Indicates that the role is the author of the request.

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

NPfIT CMET to identify a person fulfilling the specific role of the prescriber who sent the initial Cancellation Request message.

This information is mandatory.

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

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 : details of the person playing the Agent role
id SDS identifier
name Name
Organization : details of the scoping GP practice
id Organisation SDS identifier
code Type of organisation
name Name of organisation
telecom Telephone number of organisation
addr Address of organisation
[0..1] responsibleParty
A participation used to provide 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 Consultant 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 the responsible Healthcare professional.

This information is mandatory.

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

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 : details of the person playing the Agent role
id SDS identifier
name Name
Organization : details of the scoping GP practice
id Organisation SDS identifier
code Type of organisation
name Name of organisation
telecom Telephone number of organisation
addr Address of organisation
[1..1] pertinentInformation2

A link to the original prescription against which the initial Cancellation Request message was issued.

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

[0..1] pertinentInformation1

A link to a prescription Line Item against which the initial Cancellation Request message was issued.

This information is optional and omitted if the cancellation is against the whole prescription, otherwise it must be specified.

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

The id of the line item pertinent to this cancellation response.

[0..1] pertinentInformation3
A link to information about the success of the Cancellation Request message.
[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 "false".

[1..1] pertinentResponse (Response)

The response pertinent to this cancellation.

[1..1] pertinentInformation4
A link to the initial Cancellation Request message.
[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 context the inversionInd defaults to "true".

[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] pertinentCancellationRequestRef (CancellationRequestRef)

The Cancellation Request pertinent to this Cancellation Response.

PrescriptionID

A reference to the original prescription against which the Cancellation Request message was issued, using the Short Form Prescription Identifier.

Used by: CancellationResponse
[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
Details about the Line Item(s)  on the original prescription against which the Cancellation Request is/are being issued.
Used by: CancellationResponse
[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 promise of 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 link to the original prescription line item(s) against which the cancellation requests  were issued.

Response

Response against the Cancellation Request message. Reference: NPFIT-ETP-PZ-0159-v1.2 Table 9.

Used by: CancellationResponse
[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"
[0..1] code (CV {CNE:PrescriptionAnnotation} )

Indicates that this a response by the ETP Component to the Cancellation Request message.

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

  • The code attribute will contain the fixed value "CRR" 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 (CV {CWE:CancellationResponseReason} )

Coded representation of the cancellation response 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 CancellationResponseReason vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the CancellationResponseReason vocabulary.
CancellationRequestRef

Details about the original Cancellation Request message.

Used by: CancellationResponse
[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 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 link to the original Cancellation Request what prompted this response.