Dispense Notification With Claim Info - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
PORX_RM142004UK31
DispenseNotification

This message is used by the dispensing system to notify the ETP Component of details of a dispensing event, so that the patient's clinical record can be updated, and to send information for a reimbursement claim for that completed prescription dispensing event, such that the ETP Component an forward a claim for reimbursement to the appropriate payment authority. 

Reference: W5-2.4.4.1

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

A code indicating that the DispenseNotification focal act 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 Dispense Notification With Claim. 

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

  • the root attribute will contain a UUID .
[1..1] code (CD {CNE:EventTypeSnCT} )

A fixed code from the EventTypeSnCT UK subset that describes this as a Dispensed Medication  event.

The Coded Plain datatype flavour is used to carry this information as follows:

  • the code attribute will contain the fixed value "163541000000107", from the list of codes in the EventTypeSnCT vocabulary;
  • the codeSystem attribute will contain the OID value referenced in the EventTypeSnCT vocabulary,
  • the displayName attribute will contain the textual (human readable) description associated with the code.   
[1..1] effectiveTime (TS)

The date and time stamp of this message.

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

  • YYYYMMDDHHMMSS
[1..1] typeId (II)

An identifier used to indicate the message type and version.

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

  • the root attribute shall contain the value of the Type Identifiers OID = 2.16.840.1.113883.2.1.3.2.4.18.7
  • the extension attribute shall contain the fixed value of the message artifact id, "PORX_MT142004UK31".
[1..1] recordTarget

A link between the focal act and the patient who receives the medication treatment.

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

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

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

Details of the individual.

[1..1] primaryInformationRecipient

This participation provides a link to the (payor) organisation to whom the reimbursement claim for the dispense will be presented.

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

A code indicating that the receiving organisation is the primary recipient

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

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: "ON" - Overriding and non-propagating

The default value of "ON" indicates that the association overrides the existing context associated with the Act, but will not propagate to any descendant Acts reached by conducting ActRelationships.

[1..1] agent      [CMET: UKCT_MT120401UK02]

NPfIT CMET fulfilling the specific role of an organisation, in this instance the payor organisation (which may be the PPA) to whom the claim is presented. Full details of the organisation and role profile are available from SDS.

This information is mandatory.

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

AgentOrg
Organization
id Organisation SDS identifier
name Name of organisation
[0..1] receiver
Information about the individual collecting the prescription, if he/she is not the actual patient.
[1..1] typeCode (CS {CNE:RCV} ){ Fixed="RCV" }

A code to indicate the person who receives the prescription

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

Details of the individual.

[1..1] pertinentInformation1

An act relationship that associates the DispenseNotificationWithClaim focal act with SupplyHeader - the primary act of the PSIS clinical 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 "true".

[1..1] templateId (II)

An identifier of the Act Relationship that relates clinical statements directly to the focal act.

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

  • the root attribute shall contain the value of the Templates Identifiers OID = 2.16.840.1.113883.2.1.3.2.4.18.2
  • the extension attribute shall contain the fixed template ID "CSAB_RM-NPfITUK10.pertinentInformation"
[1..1] pertinentSupplyHeader (SupplyHeader)

The SupplyHeader is pertinent to the DispenseNotificationWithClaimInfo.

This information is mandatory.

[1..1] pertinentInformation2

An identifier of the Act Relationship that relates clinical statements directly to the focal act.

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

Indicates that this is pertinent information.

  • Fixed value: "PERT"
[1..1] templateId (II)

An identifier of the Act Relationship that categorises clinical data by the Care Record Element classification used by PSIS.

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

  • the root attribute shall contain the value of the Templates Identifiers OID = 2.16.840.1.113883.2.1.3.2.4.18.2
  • the extension attribute shall contain the fixed template ID "CSAB_RM-NPfITUK10.pertinentInformation1"
[1..1] pertinentCareRecordElementCategory (CareRecordElementCategory)

The Care Record Element Category pertinent to this Dispense Notification and is used to categorise the clinical statement acts according to CRE types.

This information is mandatory.

[0..1] replacementOf

An act relationship between the focal act and a previous claim that this message replaces.

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

Indicates that this Dispense notification is a replacement to a previously sent one.

  • Fixed value : "RPLC"
[1..1] priorMessageRef (MessageRef)

A reference to a previous Dispense Notification event which this one is intended to replace.

[0..1] coverage
An act relationship that provides information about the patient's prescription charge exemption status.
[1..1] typeCode (CS {CNE:COVBY} ){ Fixed="COVBY" }

Indicates that the DispenseNotificationWithClaim (source act) is covered by or under the authority of ChargeExempt (target act).

  • Fixed value : "COVBY" (covered by)
[1..1] coveringChargeExempt (ChargeExempt)

The ChargeExempt applies to the DispenseNotificationWithClaim. In this instance, this indicates that the patient for this Dispense Notification may be exempt from paying prescription charges.

This information is optional and may be ommitted.

[1..1] sequelTo
An act relationship indicating that Dispense Notification With Claim sequentially follows the Prescription Release Event.
[1..1] typeCode (CS {CNE:SEQL} ){ Fixed="SEQL" }

Indicates that DispenseClaimWithNotication (source act) follows PrescriptionReleaseEvent (target act).

  • Fixed value : "SEQL
[1..1] priorPrescriptionReleaseEventRef (PrescriptionReleaseEventRef)

A reference to the PrescriptionReleaseEvent must precede the DispenseNotificationWithClaim. The Dispense Notification cannot take place until a Prescription Release event has happened.

This information is mandatory.

Patient

Details about the patient.

Used by: DispenseNotification
[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.
Agent

Role representing a person, other than the patient, who collects the prescription.

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

Indicates that the role is that of an agent.

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

A nationally agreed identifier for the role being played.  This may be either a code from a national coding scheme (identified by an OID) or a DCE UUID.

[1..1] code (CV {CNE:PersonRelationshipType} )

Code indicating the relationship of the Agent to the patient.

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

  • The code attribute will contain a value from the list of codes in the  PersonRelationshipType vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the  PersonRelationshipType vocabulary.
  • the displayName  attribute will contain the textual (human readable) description associated with the code
[1..1] agentPerson (Person)

Details of the person playing the Agent role.

SupplyHeader

A container for the collection of clinical statements that constitute Dispense Notification With Claim information to be available on PSIS.

Used by: DispenseNotification
[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:EVN} ){ Fixed="EVN" }

A code to indicate this is an event.

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

The globally unique identifier for this Dispense Notification with Claim Information clinical event. 

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

  • the root attribute shall contain a DCE UUID that identifies this clinical event.
[1..1] code (CD {CNE:SubstanceAdministrationSnCT} )

A code from the SubstanceAdministrationSnCT UK subset that describes a prescription Dispense.

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

  • The code attribute will contain the fixed value "225426007", from the list of codes in the SusbtanceAdministrationSnCT vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the SusbtanceAdministrationSnCT vocabulary.
[1..1] effectiveTime (GTS)

Mandatory attribute required to maintain compliance with the CSMP.

The attribute shall contain the nullFlavor "NA" as follows:

<effectiveTime nullFlavor="NA"/>

[0..1] repeatNumber (IVL<INT>)

This interval is used to represent the number of instances of a repeat prescription or a repeat dispensing prescription only. 

The Interval of Integers datatype carries this information as follows.

For a repeat prescription:

  • the low.value attribute shall contain the repeat number of this prescription instance;
  • the high.value attribute shall contain the number of times the prescription is to be issued.

For a repeat dispensing prescription:

  • the high.value attribute only is used and shall contain the number of times the prescription is to be dispensed.
[1..1] author

A participation used to provide a link from an act to a role in this case used to convey that the role (participant) is the author for the act.

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

Indicates that the role is the author of the dispense event.

  • Fixed value: "AUT"
[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 clinical statements as the care professional unless specifically overriden for individual acts.

[1..1] time (TS)

The date and local time that the medication is issued by the dispenser.

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

  • YYYYMMDDHHMMSS
[1..1] signatureText (ED)

The contents of this message are not signed and therefore this element shall contain nullFlavor "NA":

<signatureText nullFlavor="NA"/>

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

NPfIT CMET to identify a person fulfilling the specific role for a person (dispenser) that dispensed this prescription.

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

Details about the person making the Dispense Reimbursement Claim.

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

A code to indicate legal authenticator

  • Fixed value: "LA"
[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 overrides 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 clinical statements as the claimant unless specifically overriden for individual acts.

[1..1] time (TS)

The date and local time that the reimbursement claim is made.

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

  • YYYYMMDDHHMMSS
[1..1] signatureText (ED)

The contents of this message are not signed and therefore this element shall contain nullFlavor "NA":

<signatureText nullFlavor="NA"/>

[1..1] agent      [CMET: UKCT_MT120201UK03]

NPfIT CMET to identify a person fulfilling the specific role for a person (legal authenticator) that making the Dispense Reimbursement Claim. This can be the same person as the dispenser but could be a manager.

This information is mandatory.

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

AgentPerson
id SDS role profile code
code SDS job role code (returned in the SAML assertion following successful end-user authentication)
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..*] pertinentInformation1
An act relationship that provides information about the actual supplied Line Item (medication).
[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] 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] 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 "false".

[1..1] templateId (II)

An identifier of the Act Relationship that supports the linkage of clinical statements using the "Direct Relationship" mechanism.

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

  • the root attribute shall contain the value of the Template Identifiers OID = 2.16.840.1.113883.2.1.3.2.4.18.2
  • the extension attribute shall contain the fixed template ID "CSAB_RM-NPfITUK10.sourceOf2"
[1..1] pertinentSuppliedLineItem (SuppliedLineItem)

Indicates that the SuppliedLineItem is pertinent to the SupplyHeader. Provides information on the actual medication items supplied.

This information is mandatory.

[0..1] pertinentInformation2

An act relationship that provides information on the progress of the dispense status of a prescription and reasons clarifying why a treatment could not be dispensed.

[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] pertinentNonDispensingReason (NonDispensingReason)

The NonDispensingReason is pertient to the SupplyHeader. Provides supporting information when the prescription is "partially dispensed".

This information is mandatory when the prescription is in status "partially dispensed", otherwise optional and should be omitted.

[1..1] pertinentInformation3
Details of the status of the Prescription as a function of the dispense progress of the individual medication items.
[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] pertinentPrescriptionStatus (PrescriptionStatus)

Indicates that PrescriptionStatus is pertinent to the SupplyHeader. Provides information on the dispense progress - PrescriptionStatus actually represents the dispense status of SupplyHeader in a partial dispense scenario.

This information is mandatory.

[1..1] pertinentInformation4

A link to the identify the original prescription.

[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", thus indicating that dispense of the medication Line Items cannot be considered independently of the actual quantity dispensed.

[1..1] pertinentPrescriptionID (PrescriptionID)

The short form id of the prescription clinical event that is pertinent to this supply.

[1..1] inFulfillmentOf
An act relationship to denote that this medication dispense is satisfying the requirements from the original prescription.
[1..1] typeCode (CS {CNE:FLFS} ){ Fixed="FLFS" }

Indicates that this source (SupplyHeader) is fulfilling a request for the target (OriginalPrescriptionRef).

  • Fixed value: "FLFS" (fulfills)
[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".

In this instance, this indicates that dispense of the medication line item has full meaning in its own right without reference to the original prescription that ordered the treatment.

[1..1] templateId (II)

An identifier of the Act Relationship that supports the linkage of clinical statements using the "Reference" mechanism.

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

  • the root attribute shall contain the value of the Template Identifiers OID = 2.16.840.1.113883.2.1.3.2.4.18.2
  • the extension attribute shall contain the fixed template ID "CSAB_RM-NPfITUK10.sourceOf1"
[1..1] priorOriginalPrescriptionRef (OriginalPrescriptionRef)

A reference to the original prescription with the required treatment.

This information is mandatory.

[0..1] predecessor

This act relationship states the medication notification in this message appends to (and does not replace) the information relating to a  previous partial dispense.

This information is optional and may be omitted for first dispense. It is applicable when a line item has been partially dispensed previously and this notification relates to further provision of the medication.

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

Indicates that this is medication dispense succeeds (appends to) any previous partial dispense.

  • Fixed value : "SUCC"
[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", thus indicating that this dispense can be reviewed independently of any previous dispenses.

[1..1] templateId (II)

An identifier of the Act Relationship that supports the linkage of clinical statements using the "Reference" mechanism.

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

  • the root attribute shall contain the value of the Template Identifiers OID = 2.16.840.1.113883.2.1.3.2.4.18.2
  • the extension attribute shall contain the fixed template ID "CSAB_RM-NPfITUK10.sourceOf1"
[1..1] priorSupplyHeaderRef (SupplyHeaderRef)

Indicates that any previous partial dispense (SupplyHeaderRef) is appended to by the current dispense (SupplyHeader).

CareRecordElementCategory

An act used to categorise clinical statements within the message into care record element categories. The CareRecordElementCategory act can reference multiple ActRef acts to 'group' multiple clinical statements under a single category.

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

Indicates that this act is a category act.

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

A code to indicate this is an event.

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

A code from the SNOMED CT subset used to categorise clinical statement messages.

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

  • The code attribute will contain the fixed value "185361000000102" corresponding to the "Medication" Care Record Element category;
  • The codeSystem attribute will contain the OID value referenced in the CRETypeSnCT vocabulary.
[1..*] component

An act relationship used to convey that the ActRef act forms a component of the acts within the CareRecordElementCategory.

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

Indicates that this act relationship is a component act relationship.

  • fixed value: "COMP"

The typeCode is carried as an attribute of component.

[1..1] actRef (ActRef)

A link to information about an act (clinical statement defined elsewhere within this message) that is a component of this care record element category.

MessageRef
An act used to identify the dispense event which this Dispense Notification with Claim is to replace.
Used by: DispenseNotification
[1..1] classCode (CS {CNE:INFO} ){ Fixed="INFO" }

Indicates that this act is for information 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 the id of the previous dispense event that this Dispense Notification with Claim is to replace.

ChargeExempt
An act used to provide information about Prescription Charge Exemption (or otherwise) for the patient of the prescription. Reference: NPFIT-ETP-PZ-0159-v1.2 Table 2.
Used by: DispenseNotification
[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} )

Coded representation of the 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 "EX" from the list of codes in the PrescriptionAnnotation vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the PrescriptionAnnotation vocabulary.
[1..1] negationInd (BL)

A boolean indicator to denote if the patient is exempt from prescription charges.

  • Value: true => patient must pay charges
[1..1] value (CV {CWE:PrescriptionChargeExemption} )

Coded information specifying the prescription charge exemption status.

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

Supporting textual (human readable) information as to the reason why this patient is exempt from paying prescription charges.

[0..1] authorization

An act relationship to qualify Prescription Charge Exemption for the patient through the visual inspection of documentary evidence provided by the patient to the Dispenser.

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

Indicates that the target act (EvidenceSeen) authorises the source act (ChargeExempt).

  • Fixed value : "AUTH"
[1..1] authorizingEvidenceSeen (EvidenceSeen)

Indicates that EvidenceSeen authorises ChargeExempt.

This information is optional and may be omitted.

PrescriptionReleaseEventRef
Details about the Patient Prescription Release Response or the Nominated Prescription Release Response that authorised the Dispense event.
Used by: DispenseNotification
[1..1] classCode (CS {CNE:INFO} ){ Fixed="INFO" }

A code indicating that the Patient Prescription Release Response or the Nominated Prescription Release Response is for information purposes only.

  • Fixed value: "INFO"
[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 the globally unique number (GUID) to identify either the Patient Prescription Release Response or the Nominated Prescription Release Response that authorised the Dispense event.

Person

Details of a person.

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

Indicates this is a person.

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

A code to indicate this is an individual instance of the entity.

  • Fixed value: "INSTANCE"
[1..1] name (PN)

The name of the person.

[0..1] telecom (TEL)

The telecommunication contact details of the person.

[0..1] addr (AD)

The address of the Person.

SuppliedLineItem
Details about the medication Line Item dispensed to satisfy the requirements for the treatment specified in the Prescription Line Item.
Used by: SupplyHeader
[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:PRMS} ){ Fixed="PRMS" }

Indicates that this is a promise for a service.

  • Fixed value: "PRMS" (intent to perform a service based on a committment)
[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.  

In this instance, this is the globally unique identifier for each Medication Line Item in the Dispense event.

[1..1] code (CD {CNE:SubstanceAdministrationSnCT} )
A code from the SubstanceAdministrationSnCT UK subset that describes the medication to be supplied.

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 SubstanceAdministrationSnCT vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the SubstanceAdministrationSnCT vocabulary.
[1..1] effectiveTime (GTS)

Indicates the timing instructions for the medication. (e.g. every 8 hours)

This attribute is reserved for future use and shall therefore contain the nullFlavor "NA" as follows:

<effectiveTime nullFlavor="NA"/>

[0..1] repeatNumber (IVL<INT>)

This interval is used to represent the number of repeat issues or dispenses of this medication item for a repeat prescription or a repeat dispensing prescription only. 

The Interval of Integers datatype carries this information as follows.

For a repeat prescription:

  • the low.value attribute shall contain the repeat number of this medication item;
  • the high.value attribute shall contain the number of times the medication item is to be issued.

For a repeat dispensing prescription:

  • the high.value attribute only is used and shall contain the number of times the medication item is to be dispensed.
[0..1] doseQuantity (IVL<PQ>)

This is the amount of medication that is to be administered to the patient at each single dose.

THIS ATTRIBUTE IS RESERVED FOR FUTURE USE AND SHOULD NOT BE USED IN THIS VERSION OF THE MESSAGE.

[0..1] rateQuantity (IVL<PQ>)

The rate at which a medication such as an infusion is administered (for example 100 mL/h).

THIS ATTRIBUTE IS RESERVED FOR FUTURE USE AND SHOULD NOT BE USED IN THIS VERSION OF THE MESSAGE.

[1..1] consumable

Provides information against the original prescription Line Item against which this medication is being dispensed. In this instance, the original prescription Line Item is not automatically cross-referenced to reduce overhead on PSIS, so the data may be derived from alternative sources which may include visual inspection of the prescription by the dispenser.

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

Indicates that this is a consumable.

  • Fixed value: "CSM"
[1..1] contextControlCode (CS {CNE:ContextControl} )

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 replaces the existing context associated with the Act, and propagates to any descendant Acts reached by conducting ActRelationships.

[1..1] requestedManufacturedProduct (RequestedManufacturedProduct)

Indicates that RequestedManufacturedProduct is consumed by the SuppliedLineItem.

This information is mandatory.

[0..*] component

An act relationship to provide information on the actual quantity of medication dispensed in this Dispense event.

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

Indicates that this is a component.

  • Fixed value : "COMP"
[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 component relationship.

In this context the seperatableInd defaults to "false".

[1..1] suppliedLineItemQuantity (SuppliedLineItemQuantity)

Indicates that SuppliedLineItemQuantity is pertinent to SuppliedLineItem.

This information is mandatory.

[1..1] component1

An act relationship that relates to the quantity of the medication treatment ordered in the original prescription line item. This information might not necessarily be derived from PSIS.

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

Indicates that this is a component.

  • Fixed value: "COMP"
[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".

In this instance, this indicates that dispense of the medication Line Items cannot be considered independently of the actual quantity dispensed.

[1..1] supplyRequest (SupplyRequest)

The quantity of medication treatment composing the original supply.

[0..1] pertinentInformation1
This act relationship enables tracking of partial dispenses through the monitoring of total medication dispensed to-date.
[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".

In this instance, this indicates that dispense of the medication Line Items must consider total medication dispensed so far, as a pre-requisite.

[1..1] pertinentRunningTotal (RunningTotal)

Indicates that RunningTotal is pertinent to SuppliedLineItem.

This information is mandatory.

[0..1] pertinentInformation2

An act relationship to provide a reason why a medication Line Item could not be dispensed.

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

In this instance, this indicates that dispense of the medication Line Items cannot be considered independently of any reasons why a dispense could not be performed.

[1..1] pertinentNonDispensingReason (NonDispensingReason)

Indicates that NonDispensingReason is pertinent to SuppliedLineItem.

This information is optional and may be omitted.

[1..1] pertinentInformation3

An act relationship that considers the status of the original prescription Line Item prior to the dispense of the medication.

[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", thus indicating that dispense of the medication Line Items must consider the status of the Prescription Line Item as a pre-requisite.

[1..1] pertinentItemStatus (ItemStatus)

Indicates that ItemStatus is pertinent to SuppliedLineItem.

This information is mandatory.

[0..*] inFulfillmentOf1

An act relationship linking this medication line item dispense event to a medication plan that it is intended to fulfill.

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

Indicates that this source is fulfilling a request for the target.

  • Fixed value: "FLFS" (fulfills)
[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] templateId (II)

An identifier of the Act Relationship that categorises clinical data by it"s role within the message instance.

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

  • the root attribute shall contain the value of the Template Identifiers OID = 2.16.840.1.113883.2.1.3.2.4.18.2
  • the extension attribute shall contain the template ID "CSAB_RM-NPfITUK10.sourceOf1".
[1..1] priorIntendedMedicationAdministrationRef (IntendedMedicationAdministrationRef)

Reference medication plan that this line item dispense event is intended to fulfill

[1..1] inFulfillmentOf
An act relationship to determine that this medication Line Item Dispense event satisifies the treatment ordered in the original prescription Line Item which is identified by the prescription Line Item id. Details on the original treatment ordered are determined through an act ref that points to the data on PSIS.
[1..1] typeCode (CS {CNE:FLFS} ){ Fixed="FLFS" }

Indicates that this source (SupplyHeader) is fulfilling a request for the target (OriginalPrescriptionRef).

  • Fixed value: "FLFS" (fulfills)
[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 contextConductionInd 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".

In this instance, this indicates that dispense of the medication Line Items has full meaning in its own right without reference to the original prescription LineItem that ordered the treatment.

[1..1] templateId (II)

An identifier of the Act Relationship that supports the linkage of clinical statements using the "Reference" mechanism.

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

  • the root attribute shall contain the value of the Template Identifiers OID = 2.16.840.1.113883.2.1.3.2.4.18.2
  • the extension attribute shall contain the fixed template ID "CSAB_RM-NPfITUK10.sourceOf1"
[1..1] priorOriginalItemRef (OriginalItemRef)

Indicates that OriginalItemRef is considered prior to the SuppliedLineItem during the medication dispense to satisfy the treatment ordered.

This information is mandatory.

[0..1] predecessor
An act relationship to associate the current Dispense event with previous Dispense events for this medication Line Item. This relationship is enforced via an act relationship that points to the previous dispense data.
[1..1] typeCode (CS {CNE:SUCC} ){ Fixed="SUCC" }

Indicates that this is medication dispense succeeds (appends to) any previous partial dispense for this medication Line Item.

  • Fixed value : "SUCC"
[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", thus indicating that dispense of the medication Line Item can be reviewed independently of any previous dispenses for this medication Line Item.

[1..1] templateId (II)

An identifier of the Act Relationship that supports the linkage of clinical statements using the "Reference" mechanism.

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

  • the root attribute shall contain the value of the Template Identifiers OID = 2.16.840.1.113883.2.1.3.2.4.18.2
  • the extension attribute shall contain the fixed template ID "CSAB_RM-NPfITUK10.sourceOf1"
[1..1] priorSuppliedLineItemRef (SuppliedLineItemRef)

Indicates that SuppliedLineItemRef is a consderation prior to the SuppliedLineItem.

PrescriptionStatus
Details of the  status of the overall prescription as a function of the respective Medication item statuses. Reference: NPFIT-ETP-PZ-0159-v1.2 Table 20.
Used by: SupplyHeader
[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 status.

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

  • The code attribute will contain the fixed value "PS" 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:PrescriptionStatus} )

Coded information classfying the status of the overall prescription as a function of the medication dispensed.

The Coded Plain datatype flavour is used to carry this information as follows:

  • The code attribute will contain a value from the list of codes in the PrescriptionStatus vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the PrescriptionStatus vocabulary
  • The displayName attribute will contain the textual (human readable) description associated with the code e.g. "Dispensed"
PrescriptionID

A reference to the original prescription using the Short Form Prescription Identifier.

Used by: SupplyHeader
[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)

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).
OriginalPrescriptionRef
A reference to the original prescription clinical event using the DCE UUID.
Used by: SupplyHeader
[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"
[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 the globally unique number to identify the individual prescription.

SupplyHeaderRef
Reference to the previous dispense event in the case of a partial dispense.
Used by: SupplyHeader
[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:EVN} ){ Fixed="EVN" }

A code to indicate 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 the globally unique number to identify a previous Dispense event.

ActRef

Refers to a component using a unique identifier.

Used by: CareRecordElementCategory
[1..1] classCode (CS {CNE:ActClass} )

The classCode shall take the value of the target act.

[1..1] moodCode (CS {CNE:ActMood} )

The moodCode shall take the value of the target act.

[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 one of the clinical acts in this message.

EvidenceSeen
Confirmation from the dispenser as to whether documentary evidence has been visually examined to qualify a patient's exemption from prescription charges.
Used by: ChargeExempt
[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 is representation whether support documentary evidence has been visually inspected in respect of a patient's exemption from prescription charges.

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

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

Indicates whether or not the patient has shown the dispenser evidence of their exemption from prescription charges.

  • value: "true" => evidence has not been seen

Not required if patient does not claim exemption.

RequestedManufacturedProduct
Details of the treatment ordered on the prescription Line Item. May not be queried from PSIS but sourced from elsewhere.
Used by: SuppliedLineItem
[1..1] classCode (CS {CNE:MANU} ){ Fixed="MANU" }

Indicates that this act is a manufactured product

  • Fixed value: "MANU"
[1..1] manufacturedRequestedMaterial (RequestedMaterial)

A link to an entity providing more information on the physical charateristics of the treatment ordered.

SuppliedLineItemQuantity
Details of the actual medication treatment dispensed in this Dispense event for this Line Item.
Used by: SuppliedLineItem
[1..1] classCode (CS {CNE:SPLY} ){ Fixed="SPLY" }

A code to indicate supply.

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

Indicates that this is an event

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

A code from the SupplyActSnCT UK subset that describes the supply of pharmaceutical products and medical devices.

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 SupplyActSnCT vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the SupplyActSnCT vocabulary.
[1..1] quantity (PQ)

A quantification of the actual amount of medication treatment dispensed for this SuppliedLineItem.

The National Programme mandates the use of the dm+d for expressing drug codes and associated units of measure. The Quantity in Alternative Units datatype flavour is therefore used to carry this information as follows:

  • The value attribute shall contain the integer or decimal (real) number value in the approved unit.
  • The unit attribute shall contain the UCUM unit "1".
  • The translation value attribute shall contain the integer or decimal (real) number value in the alternative unit.
  • The translation code attribute shall contain the dm+d Unit of Measure codification associated with the drug code
  • The translation codeSystem attribute shall contain the OID for SNOMED CT 2.16.840.1.113883.2.1.3.2.4.15 
  • The translation displayName attribute is mandatory and shall contain the text representation of the units as given in the codeSystem (e.g. "gram", "tablet", "unit dose", etc)

<!-- 30 grams of Betamethasone valerate 0.1% cream -->
<quantity value="30" unit="1">
     <translation value="30" code="258682000" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="gram"/>
</quantity>

<!-- 100 Paracetamol 500mg Tablets -->
<quantity value="100" unit="1">
     <translation value="100" code="3319411000001109" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="tablet"/>
</quantity>

For more information on representing drug quantites using dm+d drug codes, see the Implementation of dm+d and Compliance Guide (Ref: NPFIT-ETP-EDB-0068).  It should be noted that this guidance does not fully comply with the standard HL7 / UCUM representation of measured quantities in that the PQ unit attribute is assigned a value of "1" (for unity) and not the UCUM representation of the approved unit.

[1..1] product

A participation that establishes product specific data for the medication prescribed.

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

A code to a product (medicine) taken from stock

  • Fixed value: "PRD"
[1..1] contextControlCode (CS {CNE:ContextControl} )

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 overrides 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 product propogates through to the clinical statements as the medication unless specifically overriden for individual acts.

[1..1] suppliedManufacturedProduct (SuppliedManufacturedProduct)

A link to the entity that describes the physical characteristics of the suppliedManufacturedProduct.

[1..1] pertinentInformation4

An act relationship that identifies whether a prescription charge was paid for the medication Line Item.

[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] pertinentChargePayment (ChargePayment)

Indicates that ChargePayment is pertinent to SuppliedLineItemQuanitity.

This information is mandatory.

[1..*] pertinentInformation3

An act relationship for dispensing endorsements required in support of the reimbursement claim for a medication Line Item.

[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] pertinentDispensingEndorsement (DispensingEndorsement)

Indicates that DispensingEndorsement is pertinent to SuppliedLineItemQuantity.

This information is mandatory.

[0..1] pertinentInformation2

An act relationship designed to accomodate additional instructions to support the dispensed medication and supplement the standard prescribed/supply instructions.

[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] pertinentAdditionalInstructions (AdditionalInstructions)

Indicates that AdditionalInstructions are pertinent to SuppliedLineItemQuantity.

This information is optional and may be omitted.

[1..*] pertinentInformation1

Medication administration instructions as supplied by the dispenser, and printed on the supplied items. Normally, these should be the same as the prescriber instructions except when the supplied medication varies from the prescribed medication requiring more drug specification information.

[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] pertinentSupplyInstructions (SupplyInstructions)

Indicates that SupplyInstructions are pertinent to SuppliedLineItemQuantity.

This information is mandatory.

SupplyRequest
Details of the initial treatment prescribed on the prescription Line Item.
Used by: SuppliedLineItem
[1..1] classCode (CS {CNE:SPLY} ){ Fixed="SPLY" }

A code to indicate supply.

  • Fixed value: "SPLY"
[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] code (CD {CNE:SupplyActSnCT} )

A code from the SupplyActSnCT UK subset that describes the supply of pharmaceutical products and medical devices.

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 SupplyActSnCT vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the SupplyActSnCT vocabulary.
[1..1] quantity (PQ)

A quantification of the actual amount of medication treatment prescribed for this SuppliedLineItem.

The National Programme mandates the use of the dm+d for expressing drug codes and associated units of measure. The Quantity in Alternative Units datatype flavour is therefore used to carry this information as follows:

  • The value attribute shall contain the integer or decimal (real) number value in the approved unit.
  • The unit attribute shall contain the UCUM unit "1".
  • The translation value attribute shall contain the integer or decimal (real) number value in the alternative unit.
  • The translation code attribute shall contain the dm+d Unit of Measure codification associated with the drug code
  • The translation codeSystem attribute shall contain the OID for SNOMED CT 2.16.840.1.113883.2.1.3.2.4.15 
  • The translation displayName attribute is mandatory and shall contain the text representation of the units as given in the codeSystem (e.g. "gram", "tablet", "unit dose", etc)

<!-- 30 grams of Betamethasone valerate 0.1% cream -->
<quantity value="30" unit="1">
     <translation value="30" code="258682000" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="gram"/>
</quantity>

<!-- 100 Paracetamol 500mg Tablets -->
<quantity value="100" unit="1">
     <translation value="100" code="3319411000001109" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="tablet"/>
</quantity>

For more information on representing drug quantites using dm+d drug codes, see the Implementation of dm+d and Compliance Guide (Ref: NPFIT-ETP-EDB-0068).  It should be noted that this guidance does not fully comply with the standard HL7 / UCUM representation of measured quantities in that the PQ unit attribute is assigned a value of "1" (for unity) and not the UCUM representation of the approved unit.

RunningTotal
The amount of medication treatment that has been supplied to the patient to-date.
Used by: SuppliedLineItem
[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 dispensing status of the prescription Line Item.

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

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

A quantification of the total amount of medication treatment dispensed for this SuppliedLineItem, to the patient, so far.

Applicable to partial dispenses only, including the final dispense of a partial dispense process.

The National Programme mandates the use of the dm+d for expressing drug codes and associated units of measure. The Quantity in Alternative Units datatype flavour is therefore used to carry this information as follows:

  • The value attribute shall contain the integer or decimal (real) number value in the approved unit.
  • The unit attribute shall contain the UCUM unit "1".
  • The translation value attribute shall contain the integer or decimal (real) number value in the alternative unit.
  • The translation code attribute shall contain the dm+d Unit of Measure codification associated with the drug code
  • The translation codeSystem attribute shall contain the OID for SNOMED CT
  • The translation displayName attribute is mandatory and shall contain the text representation of the units as given in the codeSystem (e.g. "gram", "tablet", "unit dose", etc)

<!-- 30 grams of Betamethasone valerate 0.1% cream -->
<quantity value="30" unit="1">
     <translation value="30" code="258682000" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="gram"/>
</quantity>

<!-- 100 Paracetamol 500mg Tablets -->
<quantity value="100" unit="1">
     <translation value="100" code="3319411000001109" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="tablet"/>
</quantity>

For more information on representing drug quantites using dm+d drug codes, see the Implementation of dm+d and Compliance Guide (Ref: NPFIT-ETP-EDB-0068).  It should be noted that this guidance does not fully comply with the standard HL7 / UCUM representation of measured quantities in that the PQ unit attribute is assigned a value of "1" (for unity) and not the UCUM representation of the approved unit.

NonDispensingReason
Information underlying the reasons why a medication requirement on a prescription has not been dispensed. Reference: NPFIT-ETP-PZ-0159-v1.2 Table 18.
Used by: SuppliedLineItem, SupplyHeader
[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 reason for not dispensing.

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

  • The code attribute will contain the fixed value "NDR" 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:NotDispensedReason} )

Coded information specifying why a medication has not been dispensed.

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 NotDispensedReason vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the NotDispensedReason vocabulary.
ItemStatus
Describes the status of the prescription Line Item as a result of the dispense event. Reference: NPFIT-ETP-PZ-0159-v1.2 Table 15.
Used by: SuppliedLineItem
[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 is represents the dispensing status of the prescription Line Item.

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

  • The code attribute will contain the fixed value "IS" 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:ItemStatus} )

Coded representation of the prescription Line Item status.

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

The value part of the information contains a textual (human readable) description of the dispensing status of the prescription Line Item as a result of this Dispense event, e.g. item fully dispensed.

IntendedMedicationAdministrationRef

Reference identifying a medication plan whose details are held on PSIS.

Used by: SuppliedLineItem
[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:x_ActMoodIntentRequest} )

A code value taken from the HL7 x_ActMoodIntentRequest vocabulary:

  • INT
  • 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 UUID of a PoC clinical statement.

OriginalItemRef
A link to the medication Line Item on the original prescription.
Used by: SuppliedLineItem
[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"
[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 unique medication item ID from the original prescription.

SuppliedLineItemRef
When a prescription is being fulfilled through partial dispense acts, this act ref provides a link to the previous Dispense Notification message.
Used by: SuppliedLineItem
[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:PRMS} ){ Fixed="PRMS" }

Indicates that this is a promise for a service.

  • Fixed value: "PRMS" (intent to perform a service based on a committment)
[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  link to the previous Dispense Notification message and shall be the SupplyLineItem.ID.

RequestedMaterial
Details of the physical characteristics of the prescribed medication treatment.
Used by: RequestedManufacturedProduct
[1..1] classCode (CS {CNE:MMAT} ){ Fixed="MMAT" }

Indicates that this is a single identifiable manufactured material entity.

  • Fixed value "MMAT"

The classCode is carried as an attribute of the RequestedMaterial element.

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

Indicates the entity is a single identifiable kind of medication.

  • Fixed value: "KIND"
[1..1] code (CE {CNE:ManufacturedMaterialSnCT} )

A code from the SNOMED CT UK subset that describes a manufactured material (e.g. a pharmaceutical product or personal medical device).

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

  • the code attribute will contain the dm+d codification associated with the product or device
  • the codeSystem attribute will contain the OID for SNOMED CT
  • the displayName attribute will contain the textual (human readable) description associated with the code

NOTE: this attribute uses the CE data type due to limitations of the current HL7 toolset, which prevent it from being modelled using the CD dataype.

SuppliedManufacturedProduct
Details of the physical characteristics of the dispensed medication treatment.
Used by: SuppliedLineItemQuantity
[1..1] classCode (CS {CNE:MANU} ){ Fixed="MANU" }

Indicates that this is a manufactured material.

  • Fixed value "MANU"
[1..1] manufacturedSuppliedMaterial (SuppliedMaterial)

A link to the entity that describes the physical characteristics of the supplied medication.

ChargePayment
Details on whether a prescription charge was paid for the medication item. Reference: NPFIT-ETP-PZ-0159-v1.2 Table 14.
Used by: SuppliedLineItemQuantity
[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 is represents dispense charge payment.

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

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

Boolean values to indicate the status of the Charge Payment:

  • value: "true" => there has been a charge payment
  • value: "false" => there has not been a charge payment
DispensingEndorsement

Details about the endorsement(s) to support the claim for this medication item. Reference: NPFIT-ETP-PZ-0159-v1.2 Table 4.

Used by: SuppliedLineItemQuantity
[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 is represents a dispensing endorsement.

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

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

Textual (human readable) representation required in support of the reimbursement claim for the medication item.

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

Coded representation of the dispensing endorsement.

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 DispensingEndorsement vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the DispensingEndorsement vocabulary.
AdditionalInstructions
Supplementary instructions provided in addition to the prescriber/dispenser dosage instructions for the medication.
Used by: SuppliedLineItemQuantity
[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 are additional instructions.

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

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

Textual (human readable) form of representation providing the additional medication instructions.

SupplyInstructions
Medication administration instructions as supplied by the dispenser and printed on the supplied items. Normally, these should be the same as the prescriber instructions except when the supplied medication varies from the prescribed medication requiring more drug specification information.
Used by: SuppliedLineItemQuantity
[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 these are instructions supplied by the dispenser.

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

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

Textual (human readable) form of representation providing the medication instructions by the dispenser.

SuppliedMaterial
Details of the physical characteristics of the dispensed medication.
Used by: SuppliedManufacturedProduct
[1..1] classCode (CS {CNE:MMAT} ){ Fixed="MMAT" }

Indicates that this is a single identifiable manufactured material entity.

  • Fixed value "MMAT"

The classCode is carried as an attribute of the SuppliedManufacturedProduct element.

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

Indicates that this is an instance of material entity.

  • Fixed value "INSTANCE"

The determinerCode is carried as an attribute of the SuppliedMaterial element.

[1..1] code (CE {CNE:ManufacturedMaterialSnCT} )

A code from the SNOMED CT UK subset that describes a manufactured material (e.g. a pharmaceutical product or personal medical device).

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

  • the code attribute will contain the dm+d codification associated with the product or device
  • the codeSystem attribute will contain the OID for SNOMED CT
  • the displayName attribute will contain the textual (human readable) description associated with the code

NOTE: this attribute uses the CE data type due to limitations of the current HL7 toolset, which prevent it from being modelled using the CD dataype.