|
PORX_RM132004UK31 |
|
|
ParentPrescription |
This is the parent prescription.
Each item on a prescription has an administration part and a supply part. In each case some of the information is common to each item while other information is different. This act represents the common parts of the administration part of each item on a prescription.
Reference: W5-2.4.1.3 |
|
|
Used by: |
|
[1..1] classCode (CS {CNE:INFO} ){ Fixed="INFO" } |
A code indicating that the ParentPrescription 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 Parent Prescription.
The Identifier Global datatype flavour is used to carry this information as follows:
- the root attribute will contain a UUID
|
|
[1..1] code (CD {CNE:EventTypeSnCT} ) |
A fixed code from the EventTypeSnCT UK subset that describes this as a 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 EventTypeSnCT vocabulary;
- the codeSystem attribute will contain the OID value referenced in the EventTypeSnCT vocabulary,
- the displayName attribute will contain the textual (human readable) description associated with the code.
|
|
[1..1] effectiveTime (TS) |
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] typeId (II) |
An identifier used to indicate the message type and version.
The Identifier External datatype flavour is used to carry this information as follows:
- the root attribute shall contain the value of the Type Identifiers OID = 2.16.840.1.113883.2.1.3.2.4.18.7
- the extension attribute shall contain the fixed value of the message artifact id, "PORX_MT132004UK31".
|
|
[1..1] recordTarget |
A link between the ParentPrescription 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 Prescription
|
|
[1..1] patient [CMET: COCT_MT050012UK05] |
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:
|
ProviderPatient |
subjectOf |
PatientCareProvision |
code |
Fixed value "1" from the list of codes in the PatientCareProvisionType vocabulary |
responsibleParty |
HealthCareProvider |
id |
SDS User's Unique Identifier | | | | | | |
If the optional data element Person.deceasedTime is provided, it must be given with the following precision:
|
| |
|
[1..1] pertinentInformation1 |
A link between the ParentPrescription details of the message and the Prescription administration information. |
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="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) |
|
|
[1..1] pertinentPrescription (Prescription) |
|
| |
|
[1..1] pertinentInformation2 |
|
|
|
|
Prescription |
This act represents the distinct parts of the administration part for a single item on 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.
- Fixed value: "RQO" (Request or Order)
|
|
[2..2] id (LIST<II>) |
A list of prescription identifiers that are universally unique across all records. The identifiers, in order of their occurence, consist of:
- the globally unique number (DCE UUID) that identifies the Prescription clinical event.
The Identifier Global datatype flavour is used to carry this information as follows:
- the root attribute shall contain the value of the DCE UUID
- the Short Form Prescription Identifier.
The Identifier External datatype flavour is used to carry this information as follows:
- the root attribute shall contain the value of the Short Form Prescription Identifier OID = 2.16.840.1.113883.2.1.3.2.4.18.8
- the extension attribute shall contain the 18 character Short Form Prescription Identifier as described in the ETP Prescribing Systems Compliance Specification document (ref: NPFIT-ETP-EDB-0025.09).
|
|
[1..1] code (CD {CNE:SubstanceAdministrationSnCT} ) |
A code from the SubstanceAdministrationSnCT subset that describes Prescriptions. |
|
[1..1] effectiveTime (GTS) |
Mandatory attribute required to maintain compliance with the CSMP.
The attribute shall contain the nullFlavor "NA" as follows:
<effectiveTime nullFlavor="NA"/>
|
|
[0..1] repeatNumber (IVL<INT>) |
This interval is used to represent the number of authorised instances of a repeat dispensing prescription only.
The Interval of Integers datatype flavour is used to carry this information as follows:
- the low.value attribute shall contain the value "1";
- the high.value attribute shall contain the number of times the prescription is authorised to be 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. |
|
[1..1] agent [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.07).
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] agent [CMET: UKCT_MT120201UK04] |
NPfIT CMET to identify a person fulfilling the role of the authorising prescriber, i.e. the person who signs this prescription.
This information is mandatory.
The following CMET data elements are required and must be provided:
AgentPerson |
id |
SDS role profile code |
code |
SDS job role code (returned in the SAML assertion following successful end-user authentication) |
telecom |
Telephone number |
Person : details of the person playing the Agent role. |
id |
Prescriber's code issued by the PPA. |
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 |
HealthCareProvider |
Organization : details of the controlling organisation, i.e. the PCT. |
id |
Organisation SDS identifier |
code |
Type of organisation |
name |
Name of organisation | | | | |
| |
|
[0..1] legalAuthenticator |
A participation used to provide a link to the person (another prescriber) who countersigns the prescription, where legally necessary, before it becomes dispensable. This is a requirement in law and the instances of it are likely to increase. |
|
|
[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 legal authenticator (counter signatory).
Electronic signature requirements are specified in the ETP Message Signing Requirements document (Ref: NPFIT-ETP-EDB-0064.07).
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] agent [CMET: UKCT_MT120201UK04] |
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 |
A participation used to provide a link to the healthcare professional who has direct responsibility for the patient. |
|
|
[1..1] typeCode (CS {CNE:RESP} ){ Fixed="RESP" } |
Indicates that the Consultant 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_MT120201UK04] |
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 |
HealthCareProvider |
Organization : details of the controlling organisation, i.e. the PCT. |
id |
Organisation SDS identifier |
code |
Type of organisation |
name |
Name of organisation | | | | |
| |
|
[0..1] component1 |
|
|
|
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" } |
Indicates that this is a component.
|
|
[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] daysSupply (DaysSupply) |
The number of days supply pertinent to this prescription if it is for repeat dispensing.
This information is mandatory for repeat dispensing prescriptions and should be omitted otherwise. |
| |
|
[0..1] pertinentInformation7 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] contextConductionInd (BL) |
If "true", associations in the parent act are conducted across the ActRelationship to the child act.
In this context the contextConductionInd defaults to "true". |
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentReviewDate (ReviewDate) |
|
| |
|
[1..1] pertinentInformation5 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] contextConductionInd (BL) |
If "true", associations in the parent act are conducted across the ActRelationship to the child act.
In this context the contextConductionInd defaults to "true". |
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentPrescriptionTreatmentType (PrescriptionTreatmentType) |
|
| |
|
[0..1] pertinentInformation6 |
|
|
|
|
[1..1] pertinentInformation1 |
An act relationship to define the nature of the role played by the pharmacy in the act of dispensing. |
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] contextConductionInd (BL) |
If "true", associations in the parent act are conducted across the ActRelationship to the child act.
In this context the contextConductionInd defaults to "true". |
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentDispensingSitePreference (DispensingSitePreference) |
|
| |
|
[1..*] pertinentInformation2 |
An act relationship to associate the prescribed medication (line items) to the prescription. |
|
|
[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) |
|
| |
|
[1..1] pertinentInformation8 |
|
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] contextConductionInd (BL) |
If "true", associations in the parent act are conducted across the ActRelationship to the child act.
In this context the contextConductionInd defaults to "true". |
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentTokenIssued (TokenIssued) |
|
| |
|
[0..1] pertinentInformation3 |
An act relationship that provides information about the patient's prescription charge exemption status. |
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] contextConductionInd (BL) |
If "true", associations in the parent act are conducted across the ActRelationship to the child act.
In this context the contextConductionInd defaults to "false". |
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentTemporaryExemptionInfo (TemporaryExemptionInfo) |
|
| |
|
[1..1] pertinentInformation4 |
An act relationship used to qualify the type of prescriber and a reason for the prescription. Reference: NPFIT-ETP-PZ-0159-v1.2 Table 5. |
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] contextConductionInd (BL) |
If "true", associations in the parent act are conducted across the ActRelationship to the child act.
In this context the contextConductionInd defaults to "true". |
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentPrescriptionType (PrescriptionType) |
|
| |
|
[0..1] inFulfillmentOf |
An act relationship used to provide a reference point to the original prescription that authorised a repeat prescription. |
|
|
[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] negationInd (BL) |
When "true" allows the sender to specifically state that the relationship does not apply.
In this context the negationInd defaults to "false". |
|
[1..1] seperatableInd (BL) |
This attribute indicates whether or not the source Act is intended to be interpreted independently of the target Act.
If the source act is intended to be interpreted independently the value shall be "true" otherwise the value shall be "false".
The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.
In this context the seperatableInd defaults to "true". |
|
[1..1] templateId (II) |
The Identifier External datatype flavour is used to carry this information as follows:
- the root attribute shall contain the value of the Template Identifiers OID = 2.16.840.1.113883.2.1.3.2.4.18.2
- the extension attribute shall contain the fixed template ID "CSAB_RM-NPfITUK10.sourceOf1"
|
|
[1..1] priorOriginalPrescriptionRef (OriginalPrescriptionRef) |
A reference, used by PSIS, to the original prescription clinical event that a repeat prescription instance is intended to fulfill.
This information is mandatory for repeat prescriptions only and should be omitted otherwise. |
| |
|
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:CRETypeSnCT} ) |
A code from the SNOMED CT subset used to categorise clinical statement messages.
The Coded with Code System datatype flavour is used to carry this information as follows:
- The code attribute will contain the fixed value "185361000000102" corresponding to the "Medication" Care Record Element category;
- The codeSystem attribute will contain the OID value referenced in the CRETypeSnCT vocabulary.
|
|
[1..*] component |
|
|
|
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" } |
Indicates that this act relationship is a component act relationship.
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. |
| |
|
DaysSupply |
Prescription duration and supply intervals used to calculate the "Dispensing Window".
This information is mandatory for repeat dispensing prescriptions, optional otherwise. |
|
|
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] code (CD {CNE:SupplyActSnCT} ) |
A code from the SupplyActSnCT UK subset that describes the supply of pharmaceutical products and medical devices.
The Coded with Code System datatype flavour is used to carry this information as follows:
- the code attribute will contain a value from the list of codes in the SupplyActSnCT vocabulary;
- the codeSystem attribute will contain the OID value referenced in the SupplyActSnCT vocabulary.
|
|
[0..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.
|
|
[0..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 shall be assigned a default value of "28"; 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>
|
|
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] value (TS) |
Datetime 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:ActClass} ) |
The classCode shall take the value of the target act. |
|
[1..1] moodCode (CS {CNE:ActMood} ) |
The moodCode shall take the value of the target act. |
|
[1..1] id (II) |
The unique identifier of the target act being referred to. This shall be a DCE UUID carried in the root attribute of the id element. |
|
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 service.
- Fixed value: "RQO" (Request or Order)
|
|
[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 globally unique identifier for each medication item in the prescription. |
|
[1..1] code (CD {CNE:SubstanceAdministrationSnCT} ) |
A code from the SnomedCT-Administration UK subset that describes the medication treatment being ordered. |
|
[1..1] effectiveTime (GTS) |
Indicates the timing instructions for the medication. (e.g. every 8 hours).
This attribute is reserved for future use and shall therefore contain the nullFlavor "NA" as follows:
<effectiveTime nullFlavor="NA"/>
|
|
[0..1] repeatNumber (IVL<INT>) |
This interval is used to represent the number of authorised instances of a repeat dispensed item only.
The Interval of Integers datatype flavour is used to carry this information as follows:
- the low.value attribute shall contain the value "1";
- the high.value attribute shall contain the number of times the item is authorised to be dispensed.
|
|
[0..1] doseQuantity (IVL<PQ>) |
This is the amount of medication that is to be administered to the patient at each single dose.
THIS ATTRIBUTE IS RESERVED FOR FUTURE USE AND SHOULD NOT BE USED IN THIS VERSION OF THE MESSAGE. |
|
[0..1] rateQuantity (IVL<PQ>) |
The rate at which a medication such as an infusion is administered (for example 100 mL/h).
THIS ATTRIBUTE IS RESERVED FOR FUTURE USE AND SHOULD NOT BE USED IN THIS VERSION OF THE MESSAGE. |
|
[1..1] product |
A participation that establishes product specific data for the medication prescribed. |
|
|
[1..1] typeCode (CS {CNE:PRD} ){ Fixed="PRD" } |
A code to indicate that the product is produced or taken from stock
- Fixed value: "PRD" (produced from a service)
|
|
[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 product data.
This information is mandatory. |
| |
|
[1..1] component |
|
|
|
[1..1] typeCode (CS {CNE:COMP} ){ Fixed="COMP" } |
Indicates that this is a component.
|
|
[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] lineItemQuantity (LineItemQuantity) |
Indicates that LineItemQuantity is pertinent to the Line Item.
This information is mandatory. |
| |
|
[0..1] pertinentInformation1 |
An act relationship used to associate additional medication instructions to the line item. |
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] contextConductionInd (BL) |
If "true", associations in the parent act are conducted across the ActRelationship to the child act.
In this context the contextConductionInd defaults to "true". |
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentAdditionalInstructions (AdditionalInstructions) |
|
| |
|
[0..*] pertinentInformation3 |
An act relationship that signifies a prescriber endorsement required for some medication items prescribed in Primary Care. |
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] contextConductionInd (BL) |
If "true", associations in the parent act are conducted across the ActRelationship to the child act.
In this context the contextConductionInd defaults to "false". |
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentPrescriberEndorsement (PrescriberEndorsement) |
|
| |
|
[1..1] pertinentInformation2 |
An act relationship to allow the specification of dosage instructions in human readable form. |
|
|
[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT" } |
|
|
[1..1] contextConductionInd (BL) |
If "true", associations in the parent act are conducted across the ActRelationship to the child act. In this context the contextConductionInd defaults to "true". |
|
[1..1] seperatableInd (BL) |
|
|
[1..1] pertinentDosageInstructions (DosageInstructions) |
|
| |
|
[0..1] inFulfillmentOf2 |
|
|
|
[1..1] typeCode (CS {CNE:FLFS} ){ Fixed="FLFS" } |
Indicates that this Line Item source is fulfilling the request of the original prescription Line Item target.
- Fixed value: "FLFS" (fulfills)
|
|
[1..1] inversionInd (BL) |
An indicator specifying that the ActRelationship.typeCode should be interpreted as if the roles of the source and target Acts were reversed. The inversion indicator is used when the meaning of ActRelationship.typeCode must be reversed. |
|
[1..1] negationInd (BL) |
When "true" allows the sender to specifically state that the relationship does not apply.
In this context the negationInd defaults to "false". |
|
[1..1] seperatableInd (BL) |
This attribute indicates whether or not the source Act is intended to be interpreted independently of the target Act.
If the source act is intended to be interpreted independently the value shall be "true" otherwise the value shall be "false".
The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.
In this context the seperatableInd defaults to "true". |
|
[1..1] templateId (II) |
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. |
| |
|
[0..1] inFulfillmentOf1 |
|
|
|
[1..1] typeCode (CS {CNE:FLFS} ){ Fixed="FLFS" } |
Indicates that this source (SupplyHeader) is fulfilling a request for the target (OriginalPrescriptionRef).
- Fixed value: "FLFS" (fulfills)
|
|
[1..1] inversionInd (BL) |
An indicator specifying that the ActRelationship.typeCode should be interpreted as if the roles of the source and target Acts were reversed. The inversion indicator is used when the meaning of ActRelationship.typeCode must be reversed.
In this context the inversionInd defaults to "false". |
|
[1..1] negationInd (BL) |
When "true" allows the sender to specifically state that the relationship does not apply.
In this context the negationInd defaults to "false". |
|
[1..1] seperatableInd (BL) |
This attribute indicates whether or not the source Act is intended to be interpreted independently of the target Act.
If the source act is intended to be interpreted independently the value shall be "true" otherwise the value shall be "false".
The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.
In this context the seperatableInd defaults to "true". |
|
[1..1] templateId (II) |
An identifier of the Act Relationship that supports the linkage of clinical statements using the "Reference" mechanism.
The Identifier External datatype flavour is used to carry this information as follows:
- the root attribute shall contain the value of the Template Identifiers OID = 2.16.840.1.113883.2.1.3.2.4.18.2
- the extension attribute shall contain the fixed template ID "CSAB_RM-NPfITUK10.sourceOf1"
|
|
[1..1] priorIntendedMedicationAdministrationRef (IntendedMedicationAdministrationRef) |
Reference to prior medication plan that this line item is intended to fulfill. |
| |
|
TokenIssued |
Details of whether the patient was given a token. |
|
|
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 Token Issued status.
The Coded with Code System datatype flavour is used to carry this information as follows:
- The code attribute will contain the fixed value "TI" from the list of codes in the PrescriptionAnnotation vocabulary;
- The codeSystem attribute will contain the OID value referenced in the PrescriptionAnnotation vocabulary.
|
|
[1..1] value (BL) |
Default to a value of "true" |
|
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.
- the globally unique number (DCE UUID) that identifies the prescription clinical event.
|
|
ActRef |
Reference to a clinical statement within this message. |
|
|
Used by: CareRecordElementCategory |
|
[1..1] classCode (CS {CNE:ActClass} ) |
The classCode shall take the value of the target act. |
|
[1..1] moodCode (CS {CNE:ActMood} ) |
The moodCode shall take the value of the target act. |
|
[1..1] id (II) |
The unique identifier of the target act being referred to. This shall be a DCE UUID carried in the root attribute of the id element.
In this instance, this is a link to one of the clinical acts in this message. |
|
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. |
|
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:SupplyActSnCT} ) |
A code from the SupplyActSnCT UK subset that describes the supply of pharmaceutical products and medical devices.
The Coded with Code System datatype flavour is used to carry this information as follows:
- The code attribute will contain a value from the list of codes in the SupplyActSnCT vocabulary;
- The codeSystem attribute will contain the OID value referenced in the SupplyActSnCT vocabulary.
|
|
[1..1] quantity (PQ) |
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. |
|
AdditionalInstructions |
Additional Instructions provided with 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} ) |
Indicates that this is representation of the 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) |
Additional medication instructions provided in human readable form. |
|
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 medication 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.
The Coded with Code System datatype flavour is used to carry this information as follows:
- The code attribute will contain the fixed value "DI" 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) |
Human readable representation of the dosage instructions (for example: take one, three times a day, for five days). |
|
OriginalItemRef |
Provides a reference to the original prescription line item for instances of repeat prescriptions. |
|
|
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. |
|
IntendedMedicationAdministrationRef |
Reference identifying a medication plan whose details are held on PSIS. |
|
|
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:x_ActMoodIntentRequest} ) |
A code value taken from the HL7 x_ActMoodIntentRequest vocabulary:
|
|
[1..1] id (II) |
The unique identifier of the target act being referred to. This shall be a DCE UUID carried in the root attribute of the id element.
In this instance, this is a link to the UUID of a PoC clinical statement. |
|
RequestedMaterial |
Description of the physical characteristics of the medication material. |
|
|
Used by: ManufacturedProduct |
|
[1..1] classCode (CS {CNE:MMAT} ){ Fixed="MMAT" } |
Indicates that this is a manufactured material
|
|
[1..1] determinerCode (CS {CNE:KIND} ){ Fixed="KIND" } |
Indicates that this is a generic representation of the kind of material
- Fixed value: "KIND" (general description)
|
|
[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 with Original Text 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
- the originalText attribute will contain a human readable description of the medication treatment
NOTE: this attribute uses the CE data type due to limitations of the current HL7 toolset, which prevent it from being modelled using the CD dataype. |
|