PS Notification With Claim Information - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
PORX_RM142003UK06
PSNotificationWithClaim

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

Reference: W5-14.4.5.3

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

A code indicating that the PS Notification with Claim 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)

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] code (CD {CNE:SnomedCT} )

A fixed code (163531000000103) from the SnomedCT UK subset that describes this message as a Protocol Supply Medication event.

[1..1] effectiveTime (TS)

Date and time stamp for the PSNotification With Claim Information message.

[1..1] recordTarget

A link between the PSNotificationWithClaim 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      [CMET: COCT_MT050012UK04]

A link to identify a person fulfilling the specific role for a patient  receiving the medical treatment.

This information is mandatory.

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

Patient.id                                        (NHS Number)
Patient.addr                                    (Address)
Person.name                                   (Name)
Person.administrative GenderCode (Gender)
Person.birthTime                            (Birth date - YYYYMMDD)
GPRegisteredWith.id                      (GP SDS identfier)

[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] participant      [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:

Organization.id           (Organisation SDS identifier)
Organization.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] participant      [CMET: UKCT_MT120201UK03]

NPfIT CMET to identify a person fulfilling the specific role for a person (receiver) who collects the prescription on behalf of the patient.

This information is optional and can be omitted unless someone other than the patient collects the prescription.

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

Person.name              (Name)

[1..1] pertinentInformation1
An act relationship that associates the PSNotificationWithClaim 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 OID 2.16.840.1.113883.2.1.3.2.4.18.2
  • The extension shall contain the fixed template ID
    "CSAB_RM-NPfITUK10.pertinentInformation"
[1..1] pertinentSupplyHeader (SupplyHeader)

The SupplyHeader is pertinent to the PSNotificationWithClaimInfo.

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 OID 2.16.840.1.113883.2.1.3.2.4.18.2
  • The extension shall contain the fixed template ID
    "CSAB_RM-NPfITUK10.pertinentInformation1"
[1..1] pertinentCareRecordElementCategory (CareRecordElementCategory)

The CareRecordElementCategory is pertinent to the PSNotificationWithClaim and is used to categorise the clinical statement acts according to CRE types.

This information is mandatory.

[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 PSNotificationWithClaim. In this instance, this indicates that the patient for this PS Notification may be exempt from paying prescription charges.

This information is optional and may be omitted.

SupplyHeader

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

Used by: PSNotificationWithClaim
[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"
[2..2] id (LIST<II>)

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

  • globally unique number to identify the individual prescription (DCE UUID)
  • a check digit for UUID verification
[1..1] code (CD {CNE:SnomedCT-Administration} )

A code from the SnomedCT-Administration UK subset that describes a Protocol Supply dispense.

[1..1] effectiveTime (TS)

The time of the Protocol Supply event.

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

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

[1..1] signatureText (ED)

The electronic signature of the contents to be signed as "legal and true" by the dispenser.

The following information is to be included in the digital signature:

  • Dispenser Information
  • Dispensing Organisation Information
  • Patient Information
  • Protocol Information
[1..1] participant (UKCT_MT120201UK03)

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

This information is mandatory.

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

AgentPerson.id          (SDS role profile code)
AgentPerson.telecom (Telephone number)
Person.id                   (SDS identifier)
Person.name              (Name)
Organization.id           (Organisation SDS identifier)
Organization.name      (Name of organisation)
Organization.telecom  (Telephone number of organisation)
Organization.addr       (Address of organisation)

[0..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 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 claimant unless specifically overriden for individual acts.

[1..1] time (TS)

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

[1..1] signatureText (ED)

The electronic signature of the contents to be signed as "legal and true" by the claimant.

The following information is to be included in the digital signature:

  • Claimant Information
  • Dispensing Organisation Information
  • Prescription Charge Exemption Information
  • Protocol Supply Medication Item Claim Information
[1..1] participant (UKCT_MT120201UK03)

NPfIT CMET to identify a person fulfilling the specific role for a person (legal authenticator) that making the PS 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)
Person.id                   (SDS identifier)
Person.name              (Name)
Organization.id           (Organisation SDS identifier)
Organization.name      (Name of organisation)
Organization.telecom  (Telephone number of organisation)
Organization.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 OID 2.16.840.1.113883.2.1.3.2.4.18.2
  • The extension 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. There may be more than 1.

This information is mandatory.

[1..1] pertinentInformation2
Definition of the Protocol against which the supply is dispensed.
[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 "true".

In this instance, this indicates that dispense of the medication Line Items has full meaning in its own right without reference to the Protocol Definition, and can be considered independently.

[1..1] pertinentPSDefinition (PSDefinition)

Indicates that PSDefinition is peritnent to SupplyHeader.

This information is mandatory.

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

Coding system used to categorise the clinical statement messages:

In this instances, all clinical statements for this message will be categorised under CREType Medication.

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

ChargeExempt
An act used to provide information about Prescription Charge Exemption (or otherwise) for the patient of the Protocol Supply. Reference: NPFIT-ETP-PZ-0159-v1.2 Table 2.
Used by: PSNotificationWithClaim
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS " }

Indicates that this act is an observation

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

Indicates that this is an event

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

Code representation for prescription charge exemption status.

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

SuppliedLineItem
Details about the medication Line Items dispensed to satisfy the requirements for the treatment specified in the Protocol Supply Definition.
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:SnomedCT-Administration} )

A code from the SnomedCT-Administration UK subset that describes the medication to be supplied. This is post-cordinated with SnomedCT-RouteOfAdministraton and SnomedCT-AdministrationSite.

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 RouteOfAdministrationSnCT vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the RouteOfAdministrationSnCT vocabulary.
  • The code attribute will contain a value from the list of codes in the AdministrationSiteSnCT vocabulary;
  • The codeSystem attribute will contain the OID value referenced in the AdministrationSiteSnCT vocabulary.
[0..1] effectiveTime (GTS)

The "dosage instructions" - details of how the person (patient) should administer medication, e.g. take one, three times a day, for five days

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

The amount of medication treatment that is to be supplied to the patient. Units of measure are SNOMED ID (SCTID) from dm+d.

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

The frequency at which the medication treatment is administered over the administration time interval (for example 100 mL/h).

[1..1] consumable

Provides information against the Protocol Supply Definition Line Item for which this medication is being dispensed. Details about the PSD Line Item may be made available from local systems or otherwise, any will not necessarily be pulled from PSIS.

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

[1..1] requestedManufacturedProduct (RequestedManufacturedProduct)

Indicates that RequestedManufacturedProduct is consumed by the SuppliedLineItem.

This information is mandatory.

[1..1] pertinentInformation4
An act relationship that relates to the quantity of the medication treatment ordered in the PSD Line Item. This information might not necessarily be derived from PSIS.
[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 contextConductionInd 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] pertinentSupplyRequest (SupplyRequest)

Indicates that SupplyRequest in pertinent to SuppliedLineItem.

This information is mandatory.

[0..1] pertinentInformation1
An act relationship used to associate additional medication instructions to the Line Item. (Note: this shadow should be located under SuppliedLineItemQuantity - this is an issue due to a tooling fault).
[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 negationInd 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 "true".

[1..1] pertinentAdditionalInstructions (AdditionalInstructions)
[0..*] pertinentInformation2
An act relationship to allow the specification of dosage instructions in human readable form.
[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 negationInd 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] pertinentDosageInstructions (DosageInstructions)

Indicates that the DosageIntructions are pertinent to the SuppliedLineItem.

This information is optional and may be omitted.

[1..*] pertinentInformation3
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 context the negationInd 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".

In this instance, this indicates that dispense of the medication Line Items must consider the status of the Prescription Line Item as a pre-requisite.

[1..1] pertinentSuppliedLineItemQuantity (SuppliedLineItemQuantity)

Indicates that SuppliedLineItemQuantity is pertinent to SuppliedLineItem.

This information is mandatory.

PSDefinition
Information about the Protocol against which a dispense is undertaken.
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 the protocol supply definition.

  • Fixed value: "PSD"
[0..1] text (ST)

The textual representation of the local code for the protocol against which the Protocol Supply has been made.

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

Coded information specifying the protocol definition.

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

Reference to a clinical statement within this message.

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

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.

  • Fixed value: "ES"
[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 Protocol Supply Definition. 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 characteristics of the treatment ordered.

SupplyRequest
Details of the initial treatment prescribed on the Protocol Supply Definition.
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:SnomedCT-Supply} )

A code from the SnomedCT-Supply UK subset that describes the prescribed quantity of medication to be supplied. Refer to vocabulary SupplyActSnCT.

[1..1] quantity (PQ)

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

Units of measure follow SNOMED ID (SCTID) from dm+d, e.g. capsules.

AdditionalInstructions

Supplementary instructions provided in addition to the PSD/dispenser instructions for the medication.

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 are additional instructions.

  • Fixed value: "AI"
[1..1] value (ST)

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

DosageInstructions
Supplementary dosage and medication instructions in human readable form.
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 representation of the dosage instructions.

  • Fixed value: "DI"
[1..1] value (ST)

Human readable representation of the dosage instructions (for example: take one, three times a day, for five days).

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:SnomedCT-Supply} )

A code from the SnomedCT-Supply UK subset that describes the prescribed quantity of medication to be supplied. Refer to vocabulary SupplyActSnCT.

[1..1] quantity (PQ)

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

Units of measure follow SNOMED ID (SCTID) from dm+d, e.g. capsules.

[1..1] product
An act relationship to describe the actual medication dispensed in response to a Protocol Supply Definition Line Item treatment request.
[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 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 product propagates 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] 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] 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] 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] 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 PSD/supply instructions.
[1..*] pertinentInformation1
An act relationship to enable the provision of supply instructions for the dispensed medication as there may be instances when these may differ slightly with the Protocol Supply Definition instructions due to drug specifications. In most cases these set of instructions should be identical.
[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] pertinentSupplyInstructions (SupplyInstructions)

Indicates that SupplyInstructions are pertinent to SuppliedLineItemQuantity.

This information is mandatory.

RequestedMaterial
Details of the physical characteristics of the PSD defined 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 ManufacturedMaterialSnCT UK subset that describes a manufactured material (e.g. a pharmaceutical product or personal medical device).

  • This information  comprises of
    ID = SNOMED ID (SCTID) from dm+d
  • TEXT = human readable representation of the medication treatment
SuppliedManufacturedProduct
Details of the physical characteristics of the dispensed medication.
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 treatment. 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.

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

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

Medication administration instructions as supplied by the dispenser, and printed on the supplied items. Normally, these should be the same as the PSD instructions except when the supplied medication varies from the suggested 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.

  • Fixed value: "SI"
[0..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 ManufacturedMaterialSnCT UK subset that describes a manufactured material (e.g. a pharmaceutical product or personal medical device).

This information  comprises of

  • ID = SNOMED ID (SCTID) from dm+D
  • TEXT = human readable representation of the medication treatment