|
PORX_RM122003UK30 |
|
|
ParentPrescription |
This is the Parent Prescription with some additional information required by the dispenser. |
|
|
Used by: |
|
[1..1] classCode (CS {CNE:INFO} ){ Fixed="INFO" } |
A code indicating that the PrescriptionResponse is for information purposes only.
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
A code to indicate this is an event.
|
|
[1..1] id (II) |
The globally unique identifier for this instance of a Prescription Response.
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:SnomedCT} ) |
A fixed code from the SnomedCT UK subset that describes this as a Prescription event.
The Coded Plain datatype flavour is used to carry this information as follows:
- the code attribute will contain the fixed value "163501000000109", from the list of codes in the SnomedCT vocabulary;
- the codeSystem attribute will contain the OID value referenced in the SnomedCT vocabulary,
- the displayName attribute will contain the textual (human readable) description associated with the code.
|
|
[1..1] effectiveTime (TS) |
This is the date and time stamp at which point the Prescription communication was initiated by the prescriber. This is not the message timestamp, which is provided in the wrapper.
The date-timestamp must be given with the following precision:
|
|
[1..1] recordTarget |
A link between the focal act and the patient for whom the prescription is intended. |
|
|
[1..1] typeCode (CS {CNE:RCT} ){ Fixed="RCT" } |
A code indicating that the patient's records will hold the information relating to this Prescriptiom
|
|
[1..1] patient [CMET: COCT_MT050012UK04] |
NPfIT CMET 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 |
addr |
Address |
Person |
name |
Name |
administrativeGenderCode |
Gender |
birthTime |
Birth date, which must be given with the following precision:
| |
GpRegisteredWith |
id |
GP SDS identfier | |
If the optional data element Person.deceasedTime is provided, it must be given with the following precision:
|
| |
|
[1..1] pertinentInformation1 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] templateId (II) |
|
|
[1..1] pertinentPrescription (Prescription) |
|
| |
|
[1..1] pertinentInformation2 |
|
|
|
|
Prescription |
This act represents the focal act of the entity known as a Prescription. |
|
|
Used by: ParentPrescription |
|
[1..1] classCode (CS {CNE:SBADM} ){ Fixed="SBADM" } |
A code to indicate introducing or applying a substance to a subject.
|
|
[1..1] moodCode (CS {CNE:RQO} ){ Fixed="RQO" } |
Indicates that this is a request or order for a service.
|
|
[2..2] id (LIST<II>) |
UUID's identifying this instance of a service request. These identifiers are universally unique across all records and consist of:
- the globally unique number (DCE UUID) that identifies this clinical event
- the globally unique number (DCE UUID) that identifies this clinical event with a check digit appended.
|
|
[1..1] code (CV {CNE:SnomedCT-Adminstration} ) |
A code from the SubstanceAdministrationSnCT subset that describes Prescriptions. |
|
[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.
- 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 or dispensed.
|
|
[0..1] performer |
|
|
|
[1..1] typeCode (CS {CNE:PRF} ){ Fixed="PRF" } |
|
|
[1..1] contextControlCode (CS {CNE:OP} ){ Fixed="OP" } |
A code that specifies how this Participation contributes to the context of the current Act, and whether it may be propagated to descendent Acts whose association allows such propagation.
The value of contextControlCode should be set appropriately according to the context of the participation being modelled.
- Default value: "OP" - Overriding and propagating
The default value of "OP" indicates that the association adds to the existing context associated with the Act, and will propagate to any descendant Acts reached by conducting ActRelationships.
In this instance, a code that this professional propagates through to the CancellationResponse as the individual who downloaded the prescription. |
|
[1..1] participant [CMET: UKCT_MT120501UK02] |
|
| |
|
[1..1] author |
|
|
|
[1..1] typeCode (CS {CNE:AUT} ){ Fixed="AUT" } |
Indicates that the role is the author of the request.
|
|
[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 prescriber has signed the prescription details.
If the Legal Authenticator has been identified then this time is to be substituted by legalAuthenticator.time.
The date-timestamp must be given with the following precision:
|
|
[1..1] signatureText (ED) |
The electronic signature of the contents to be signed as "legal and true" by the prescriber.
Electronic signature requirements are specified in the ETP Message Signing Requirements document (Ref: NPFIT-ETP-EDB-0064.06).
Where there is no digital signature - i.e. in cases where the relevant documentation is issued and signed in ink by the prescriber - this attribute shall contain nullFlavor "NA":
<signatureText nullFlavor="NA"/>
|
|
[1..1] participant [CMET: UKCT_MT120201UK03] |
NPfIT CMET to identify a person fulfilling the role of the authorising prescriber.
This information is mandatory.
The following CMET data elements are required and must be provided:
AgentPerson |
id |
SDS role profile code |
code |
SDS job role code (returned in the SAML assertion following successful end-user authentication) |
telecom |
Telephone number |
Person : details of the person playing the Agent role |
id |
SDS identifier |
name |
Name | |
Organization : details of the scoping GP practice |
id |
Organisation SDS identifier |
code |
Type of organisation |
name |
Name of organisation |
telecom |
Telephone number of organisation |
addr |
Address of organisation | | |
| |
|
[0..1] legalAuthenticator |
|
|
|
[1..1] typeCode (CS {CNE:LA} ){ Fixed="LA" } |
A code to indicate legal authenticator
|
|
[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 details of the perscription has been counter-signed by the legal authenticator.
The date-timestamp must be given with the following precision:
|
|
[1..1] signatureText (ED) |
The electronic signature of the contents to be signed as "legal and true" by the countersignatory.
Electronic signature requirements are specified in the ETP Message Signing Requirements document (Ref: NPFIT-ETP-EDB-0064.06).
Where there is no digital signature - i.e. in cases where the relevant documentation is issued and signed in ink by the prescriber - this attribute 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 (legal authenticator) that countersigns this prescription.
This information is optional and may be omitted.
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) |
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] responsibleParty |
|
|
|
[1..1] typeCode (CS {CNE:RESP} ){ Fixed="RESP" } |
Indicates that the healthcare professional has primary responsibility for the patient.
|
|
[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] participant [CMET: UKCT_MT120201UK03] |
NPfIT CMET to identify a person fulfilling the role of the prescriber who's details are recorded at the bottom of the FP10 / token.
This information is mandatory.
The following CMET data elements are required and must be provided:
AgentPerson |
id |
SDS role profile code |
code |
SDS job role code (returned in the SAML assertion following successful end-user authentication) |
telecom |
Telephone number |
Person : details of the person playing the Agent role |
id |
SDS identifier |
name |
Name | |
Organization : details of the scoping GP practice |
id |
Organisation SDS identifier |
code |
Type of organisation |
name |
Name of organisation |
telecom |
Telephone number of organisation |
addr |
Address of organisation | | |
| |
|
[0..1] pertinentInformation11 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentReviewDate (ReviewDate) |
|
| |
|
[1..1] pertinentInformation5 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentPrescriptionTreatmentType (PrescriptionTreatmentType) |
|
| |
|
[0..1] pertinentInformation6 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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] negationInd (BL) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] templateId (II) |
|
|
[1..1] pertinentCareEventRef (CareEventRef) |
|
| |
|
[0..1] pertinentInformation8 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentHighPermanentExemptionInfo (HighPermanentExemptionInfo) |
|
| |
|
[0..1] pertinentInformation9 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentLowPermanentExemptionInfo (LowPermanentExemptionInfo) |
|
| |
|
[1..1] pertinentInformation10 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentPrescriptionStatus (PrescriptionStatus) |
|
| |
|
[0..1] pertinentInformation7 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentDaysSupply (DaysSupply) |
|
| |
|
[1..1] pertinentInformation1 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentDispensingSitePreference (DispensingSitePreference) |
|
| |
|
[1..*] pertinentInformation2 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] templateId (II) |
|
|
[1..1] pertinentLineItem (LineItem) |
|
| |
|
[0..1] pertinentInformation3 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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] negationInd (BL) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentTemporaryExemptionInfo (TemporaryExemptionInfo) |
|
| |
|
[1..1] pertinentInformation4 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentPrescriptionType (PrescriptionType) |
|
| |
|
[0..1] inFulfillmentOf |
|
|
|
[1..1] typeCode (CS {CNE:FLFS} ){ Fixed="FLFS" } |
Indicates that this source (Prescription) is fulfilling a request for the target (Original PrescriptionRef).
- 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] 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] 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 that ordered the treatment. |
|
[1..1] templateId (II) |
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 link to information identifying the original prescription clinical event that a repeat prescription instance is required to fulfill.
This information is mandatory for repeat prescriptions only and should be omitted otherwise. |
| |
|
[0..1] predecessor |
|
|
|
[1..1] typeCode (CS {CNE:PREV} ){ Fixed="PREV" } |
Indicates that this is a link to a previous instance of the act.
|
|
[1..1] priorPreviousIssue (PreviousIssue) |
Carries information about a previous issue of a repeat prescription. |
| |
|
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: ParentPrescription |
|
[1..1] classCode (CS {CNE:CATEGORY} ){ Fixed="CATEGORY" } |
Indicates that this act is a category act.
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
A code to indicate this is an event.
|
|
[1..1] code (CV {CNE:CREType} ) |
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 |
|
|
|
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" } |
Indicates that this act relationship is a component act relationship.
|
|
[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. |
| |
|
ReviewDate |
For repeat dispensing prescriptions, these are the details about the date at which the prescriber would like to review the patient with regard to their treatment with this set of medications. |
|
|
Used by: Prescription |
|
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" } |
Indicates that this act is an observation
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
Indicates that this is an event
|
|
[1..1] code (CV {CNE:PrescriptionAnnotation} ) |
Indicates that this is representation of the review date
The Coded with Code System datatype flavour is used to carry this information as follows:
- The code attribute will contain the fixed value "RD" from the list of codes in the PrescriptionAnnotation vocabulary;
- The codeSystem attribute will contain the OID value referenced in the PrescriptionAnnotation vocabulary.
|
|
[1..1] effectiveTime (TS) |
Date/time stamp for the patient assessment and medication review.
The date-timestamp must be given with the following precision:
|
|
PrescriptionTreatmentType |
Details about the type of prescription. Reference: NPFIT-ETP-PZ-0159-v1.2 Table 6. |
|
|
Used by: Prescription |
|
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" } |
Indicates that this act is an observation
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
Indicates that this is an event
|
|
[1..1] code (CV {CNE:PrescriptionAnnotation} ) |
Indicates that this is representation of the prescription type
The Coded with Code System datatype flavour is used to carry this information as follows:
- The code attribute will contain the fixed value "PTT" 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:PrescriptionTreatmentType} ) |
Coded representation of the prescription treatment type.
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 PrescriptionTreatmentType vocabulary;
- The codeSystem attribute will contain the OID value referenced in the PrescriptionTreatmentType vocabulary.
|
|
CareEventRef |
Refers to the Provision of Care event |
|
|
Used by: Prescription |
|
[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. |
|
HighPermanentExemptionInfo |
Details of the date after which the patient will become except from prescription charges for reasons of age. |
|
|
Used by: Prescription |
|
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" } |
Indicates that this act is an observation
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
Indicates that this is an event
|
|
[1..1] code (CV {CNE:PrescriptionChargeExemption} ) |
A code indicating the reason for the charge exemption.
The Coded with Code System datatype flavour is used to carry this information as follows:
- The code attribute will contain the fixed value "0004" from the the PrescriptionChargeExemption vocabulary;
- The codeSystem attribute will contain the OID value referenced in the PrescriptionChargeExemption vocabulary
|
|
[1..1] value (TS) |
The date after which the patient will be exempt from having to pay prescription charges (for age reasons).
The date-timestamp must be given with the following precision:
|
|
LowPermanentExemptionInfo |
Details of the date before which the patient is except from prescription charges for reasons of age. |
|
|
Used by: Prescription |
|
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" } |
Indicates that this act is an observation
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
Indicates that this is an event
|
|
[1..1] code (CV {CNE:PrescriptionChargeExemption} ) |
A code indicating the reason for the charge exemption.
The Coded with Code System datatype flavour is used to carry this information as follows:
- The code attribute will contain the fixed value "0002" from the the PrescriptionChargeExemption vocabulary;
- The codeSystem attribute will contain the OID value referenced in the PrescriptionChargeExemption vocabulary
|
|
[1..1] value (TS) |
The date before which the patient is exempt from having to pay prescription charges (for age reasons).
The date-timestamp must be given with the following precision:
|
|
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: Prescription |
|
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" } |
Indicates that this act is an observation
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
Indicates that this is an event
|
|
[1..1] code (CV {CNE:PrescriptionAnnotation} ) |
Indicates that this is representation of the 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.
|
|
[0..1] text (ST) |
A human readable description of the status. |
|
[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"
|
|
DaysSupply |
The number of days' treatment that the medication items in this prescription are intended to be provided for. Applicable for repeat dispensing prescriptions only. |
|
|
Used by: Prescription |
|
[1..1] classCode (CS {CNE:SPLY} ){ Fixed="SPLY" } |
A code to indicate supply.
|
|
[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] effectiveTime (IVL<TS>) |
Date range specifying the earliest and latest dates for dispensing issues of this prescription.
The Date or Time Interval Complete datatype flavour is used to carry this information as follows:
- the low.value attribute shall contain the earliest date for dispensing with YYYYMMDD precision
- the high.value attribute shall contain the latest date for dispensing with YYYYMMDD precision.
|
|
[1..1] expectedUseTime (IVL<TS>) |
Date range specifying the number of days' treatment that the medication items in this prescription are intended to be provided for.
The Date or Time Duration Unanchored datatype flavour is used to carry this information with as follows:
- the width.value attribute shall contain the duration in days; and
- the width.unit attribute shall contain the code representing "day", as specified in the Unified Code for Units of Measure (UCUM)
Example
<!-- Expected use time of 28 days --> <expectedUseTime> <width value="28" unit="d"/> </expectedUseTime>
|
|
DispensingSitePreference |
The nature of the role played by the Nominated Pharmacy in the act of dispensing the medication. |
|
|
Used by: Prescription |
|
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" } |
Indicates that this act is an observation
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
Indicates that this is an event
|
|
[1..1] code (CV {CNE:PrescriptionAnnotation} ) |
Indicates that this represents a preferred pharmacy for dispensing the prescription.
The Coded with Code System datatype flavour is used to carry this information as follows:
- The code attribute will contain the fixed value "DSP" 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:DispensingSitePreference} ) |
Code representation of the dispensing site preference.
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 DispensingSitePreference vocabulary;
- The codeSystem attribute will contain the OID value referenced in the DispensingSitePreference vocabulary.
|
|
LineItem |
Medication line item in the prescription. |
|
|
Used by: Prescription |
|
[1..1] classCode (CS {CNE:SBADM} ){ Fixed="SBADM" } |
A code to indicate introducing or applying a substance to a subject.
|
|
[1..1] moodCode (CS {CNE:RQO} ){ Fixed="RQO" } |
Indicates that this is a request or order for a sevice.
|
|
[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 it is the globally unique identifier for this Line Item instance |
|
[1..1] code (CD {CNE:SnomedCT-Adminstration} ) |
A code from the SnomedCT-Administration UK subset that describes the medication treatment being ordered. |
|
[0..1] effectiveTime (GTS) |
The "dosage instructions" - details of how the person (patient) should administer medication, e.g. three times a day, for five days.
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 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.
- 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 or 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] product |
|
|
|
[1..1] typeCode (CS {CNE:PRD} ){ Fixed="PRD" } |
A code to indicate that this is a supplied product.
|
|
[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 propogates through to the clinical statements as the medication unless specifically overriden for individual acts. |
|
[1..1] manufacturedProduct (ManufacturedProduct) |
A link to the details of the prescribed medicinal product.
This information is mandatory. |
| |
|
[1..1] pertinentInformation5 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentItemStatus (ItemStatus) |
|
| |
|
[0..1] pertinentInformation1 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentAdditionalInstructions (AdditionalInstructions) |
|
| |
|
[1..1] pertinentInformation2 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentLineItemQuantity (LineItemQuantity) |
|
| |
|
[0..*] pertinentInformation3 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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] negationInd (BL) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentPrescriberEndorsement (PrescriberEndorsement) |
|
| |
|
[1..1] pertinentInformation4 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] inversionInd (BL) |
|
|
[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) |
|
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentDosageInstructions (DosageInstructions) |
|
| |
|
[0..1] inFulfillmentOf |
|
|
|
[1..1] typeCode (CS {CNE:FLFS} ){ Fixed="FLFS" } |
Indicates that this source (LineItem) is fulfilling a request for the target (Original Item).
- 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] 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] 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 that ordered the treatment. |
|
[1..1] templateId (II) |
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 the OriginalItemRef is pertinent to the LineItem.
This information is optional and may be omitted. |
| |
|
TemporaryExemptionInfo |
Details of the patient's prescription exemption charge status. Reference: NPFIT-ETP-PZ-0159-v1.2 Table 2. |
|
|
Used by: Prescription |
|
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" } |
Indicates that this act is an observation
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
Indicates that this is an event
|
|
[1..1] code (CV {CNE:PrescriptionAnnotation} ) |
Code representation for prescription charge exemption status.
The Coded with Code System datatype flavour is used to carry this information as follows:
- The code attribute will contain the fixed value "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] effectiveTime (IVL<TS>) |
The date range that a temporary (non-age related) exemption from prescription charges applies for.
The Date or Time Interval Complete datatype flavour is used to carry this information as follows:
- the low.value attribute shall contain the start of exemption with YYYYMMDD precision
- the high.value attribute shall contain the end of exemption with YYYYMMDD precision.
|
|
[1..1] value (CV {CWE:PrescriptionChargeExemption} ) |
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 a value from the list of codes in the PrescriptionChargeExemption vocabulary;
- The codeSystem attribute will contain the OID value referenced in the PrescriptionChargeExemption vocabulary.
|
|
PrescriptionType |
Details about the type of prescriber and a reason for the prescription. Reference: NPFIT-ETP-PZ-0159-v1.2 Table 5. |
|
|
Used by: Prescription |
|
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" } |
Indicates that this act is an observation
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
Indicates that this is an event
|
|
[1..1] code (CV {CNE:PrescriptionAnnotation} ) |
Indicates that this is representation of the prescription type
The Coded with Code System datatype flavour is used to carry this information as follows:
- The code attribute will contain the fixed value "PT" 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:PrescriptionType} ) |
Coded representation of the prescription type.
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 PrescriptionType vocabulary;
- The codeSystem attribute will contain the OID value referenced in the PrescriptionType vocabulary.
|
|
OriginalPrescriptionRef |
A reference to the original prescription clinical event for instances of repeat prescriptions. |
|
|
Used by: Prescription |
|
[1..1] classCode (CS {CNE:SBADM} ){ Fixed="SBADM" } |
A code to indicate introducing or applying a substance to a subject.
|
|
[1..1] moodCode (CS {CNE:RQO} ){ Fixed="RQO" } |
Indicates that this is a request or order for a service.
|
|
[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. |
|
PreviousIssue |
A link to the a previous issue of this prescription for instances of repeat prescriptions. |
|
|
Used by: Prescription |
|
[1..1] classCode (CS {CNE:SPLY} ){ Fixed="SPLY" } |
A code to indicate supply.
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
Indicates that this is an event
|
|
[1..1] effectiveTime (TS) |
Date and time stamp at which dispensing activities were completed for the previous issue of this repeat dispensing prescription.
The date-timestamp must be given with the following precision:
|
|
ActRef |
Refers to a component using a unique identifier. |
|
|
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. |
|
ManufacturedProduct |
Details about the physical characteristics of the treatment prescribed.. |
|
|
Used by: LineItem |
|
[1..1] classCode (CS {CNE:MANU} ){ Fixed="MANU" } |
Indicates that this is the manufacture details
- Fixed Value "MANU" (Manufactured)
|
|
[1..1] manufacturedRequestedMaterial (RequestedMaterial) |
A link to the physical characteristics of the material. |
|
ItemStatus |
Details of the status of the prescription line item. |
|
|
Used by: LineItem |
|
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" } |
Indicates that this act is an observation
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
Indicates that this is an event
|
|
[1..1] code (CV {CNE:PrescriptionAnnotation} ) |
Code representation for item status.
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.
|
|
[0..1] text (ST) |
A human readable form of the status information. |
|
[1..1] value (CV {CWE:ItemStatus} ) |
Coded representation of the prescription Line Item status.
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 ItemStatus vocabulary;
- The codeSystem attribute will contain the OID value referenced in the ItemStatus vocabulary
- The displayName attribute will contain the textual (human readable) description associated with the code e.g. "Dispensed"
|
|
AdditionalInstructions |
Supplementary instructions provided in addition to the prescriber/dispenser dosage instructions for the medication. |
|
|
Used by: LineItem |
|
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" } |
Indicates that this act is an observation
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
Indicates that this is an event
|
|
[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. |
|
LineItemQuantity |
Details about the total quantity of medication to be supplied for a prescription Line Item. |
|
|
Used by: LineItem |
|
[1..1] classCode (CS {CNE:SPLY} ){ Fixed="SPLY" } |
A code to indicate supply.
|
|
[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 total quantity of medication to be supplied. |
|
[1..1] quantity (PQ) |
Quantity of drugs supplied for the duration of the medication treatment.
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. |
|
PrescriberEndorsement |
Details about the prescriber endorsement as required for some medication items that are prescribed in Primary Care. |
|
|
Used by: LineItem |
|
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" } |
Indicates that this act is an observation
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
Indicates that this is an event
|
|
[1..1] code (CV {CNE:PrescriptionAnnotation} ) |
Indicates that this is representation of the prescriber endorsement.
The Coded with Code System datatype flavour is used to carry this information as follows:
- The code attribute will contain the fixed value "PE" 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) |
Justification for using off formulary medication items.
This information is optional and may be omitted. |
|
[1..1] value (CV {CWE:PrescriberEndorsement} ) |
Coded representation of the prescriber 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 PrescriberEndorsement vocabulary;
- The codeSystem attribute will contain the OID value referenced in the PrescriberEndorsement vocabulary.
|
|
DosageInstructions |
The dosage and administration instructions in human readable form. |
|
|
Used by: LineItem |
|
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS" } |
Indicates that this act is an observation
|
|
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN" } |
Indicates that this is an event
|
|
[1..1] code (CV {CNE:PrescriptionAnnotation} ) |
Indicates that this is representation of the dosage instructions.
|
|
[1..1] value (ST) |
Human readable representation of the dosage instructions (for example: 'Massage into wet hair & scalp vigorously twice daily for a week'). |
|
OriginalItemRef |
A link to the medication Line Item on the original prescription. |
|
|
Used by: LineItem |
|
[1..1] classCode (CS {CNE:SBADM} ){ Fixed="SBADM" } |
A code to indicate introducing or applying a substance to a subject.
|
|
[1..1] moodCode (CS {CNE:RQO} ){ Fixed="RQO" } |
Indicates that this is a request or order for a service.
|
|
[1..1] id (II) |
The unique identifier of the target act being referred to. This shall be a DCE UUID carried in the root attribute of the id element.
In this instance, this is a link to the original prescription line item. |
|
RequestedMaterial |
Details of the physical characteristics of the prescribed medication treatment. |
|
|
Used by: ManufacturedProduct |
|
[1..1] classCode (CS {CNE:MMAT} ){ Fixed="MMAT" } |
Indicates that this is a single identifiable manufactured material entity.
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.
|
|
[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 in the current HL7 toolset, which prevent it from being modelled using the CD dataype. |
|