Withdraw ETP Message - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
PORX_RM136001UK31
ETPWithdraw

This message is used Dispensing and Prescribing Systems to withdraw messages from the ETP System.

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

A code indicating that the WithdrawETPMessage is for information purposes only

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

A code to indicate this is an event.

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

The globally unique identifier for this instance of a Withdraw ETP Message. 

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 between the focal act and the patient for whom the withdrawal is being requested.

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

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

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

A link to identify a person fulfilling the specific role for a patient  for whom the ETP message is being withdrawn.

[1..1] author

A link to the individual who is the author of the ETP Withdraw 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_MT120301UK02]

NPfIT CMET to identify a person fulfilling the specific role of the healthcare professional who requested this withdrawal.

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
id SDS identifier
name Name
Organization
id Organisation SDS identifier
name Name of organisation
telecom Telephone number of organisation
addr Address of organisation
[1..1] pertinentInformation3
A link to information identifying the root clinical event of the ETP message that is too be withdrawn.
[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] pertinentWithdrawID (WithdrawID)

The id that is carried within the root clinical event of the ETP message that is pertinent to this withdrawal.

[0..1] pertinentInformation1
An act relationship used to provide information on repeat dispensing prescriptions.
[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] pertinentRepeatInstanceInfo (RepeatInstanceInfo)

Details for the repeat dispensing.

[1..1] pertinentInformation2
An act relationship used to provide information on the type of withdrawal. 
[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] pertinentWithdrawType (WithdrawType)

Details for the type of withdrawal.

[1..1] pertinentInformation5
An act relationship used to provide information on the reasons for withdrawal
[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] pertinentWithdrawReason (WithdrawReason)
Details for the reason for withdrawal.
[0..*] pertinentInformation4
An act relationship linking to a dispense notification that is to be withdrawn.
[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 "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] pertinentDispenseNotificationRef (DispenseNotificationRef)

A reference to a dispense notification pertinent to this withdrawal.

Patient

Details about the patient.

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

Indicates that the role is that of a patient.

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

The NHS number that identifies the patient.

  • the root attribute contains the value of the Patient NHS Number OID = 2.16.840.1.113883.2.1.4.1
  • the extension attribute contains the 10 digit NHS number.
WithdrawID

A reference to the root clinical event of the ETP message being withdrawn.

Used by: ETPWithdraw
[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 the identifier carried within the root clinical event of the ETP message that is to be withdrawn.

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

  • The code attribute will contain the fixed value "WID" 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)

The identifier that is universally unique across all records and that is carried within the root clinical event of the ETP message that is to be withdrawn.

This shall be the 18 character Short Form Prescription Identifier where it exists.

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

The 36 character clinical statement DCE UUID shall be used where a Short Form Prescription Identifier does not exist.  

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

  • the root attribute shall contain the value of the DCE UUID
RepeatInstanceInfo
Act representing the details of an instance of a repeat dispensing prescription.
Used by: ETPWithdraw
[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 indicating that this information refers to one in a series of Repeat Prescription Instances.

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

  • The code attribute will contain the fixed value "RPI" 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 (INT)

The ordinal number of this Repeat Prescription Instance in the sequence of Repeats for this Item.

WithdrawType

Details of the type of withdrawal

Used by: ETPWithdraw
[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 of the type of withdrawal.

  • Fixed value: "PWT"
[1..1] value (CV {CWE:PrescriptionWithdrawType} )

Coded information specifying why an ETP Prescription or Dispense message is being withdrawn.

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 PrescriptionWithdrawType vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the PrescriptionWithdrawType vocabulary
WithdrawReason

Details of the reason for withdrawal

Used by: ETPWithdraw
[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 of the reason for requesting the withdrawal.

  • Fixed value: "PWR"
[1..1] value (CV {CWE:PrescriptionWithdrawReason} )

Coded information specifying why an ETP Prescription or Dispense message is being withdrawn.

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 PrescriptionWithdrawReason vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the PrescriptionWithdrawReason vocabulary
DispenseNotificationRef

Details of an original dispense notification.

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

A code indicating that the DispenseNotification focal act was for information purposes only

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

Indicates that this is an event

  • Fixed value: "EVN"
[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 an original dispense notification if one exists.